snowflake-ml-python 1.7.5__tar.gz → 1.8.1__tar.gz

{snowflake_ml_python-1.7.5 → snowflake_ml_python-1.8.1}/CHANGELOG.md

@@ -1,9 +1,306 @@
 # Release History
 
-## 1.7.5
+## 1.8.1
+
+### Bug Fixes
+
+- Registry: Fix a bug that caused `unsupported model type` error while logging a sklearn model with `score_samples`
+  inference method.
+- Registry: Fix a bug that model inference service creation fails on an existing and suspended service.
+
+### Behavior Change
+
+### New Features
+
+- ML Job (PrPr): Update Container Runtime image version to `1.0.1`
+- ML Job (PrPr): Add `enable_metrics` argument to job submission APIs to enable publishing service metrics to Event Table.
+  See [Accessing Event Table service metrics](https://docs.snowflake.com/en/developer-guide/snowpark-container-services/monitoring-services#accessing-event-table-service-metrics)
+  for retrieving published metrics
+  and [Costs of telemetry data collection](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-tracing-billing)
+  for cost implications.
+- Registry: When creating a copy of a `ModelVersion` with `log_model`, raise an exception if unsupported arguments are provided.
+
+## 1.8.0
+
+### Bug Fixes
+
+- Modeling: Fix a bug in some metrics that allowed an unsupported version of numpy to be installed
+  automatically in the stored procedure, resulting in a numpy error on execution
+- Registry: Fix a bug that leads to incorrect `Model is does not have _is_inference_api` error message when assigning
+  a supported model as a property of a CustomModel.
+- Registry: Fix a bug that inference is not working when models with more than 500 input features
+  are deployed to SPCS.
+
+### Behavior Change
+
+- Registry: With FeatureGroupSpec support, auto inferred model signature for `transformers.Pipeline` models have been
+  updated, including:
+  - Signature for fill-mask task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="sequence", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="token", dtype=DataType.INT64),
+                    FeatureSpec(name="token_str", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for token-classification task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[FeatureSpec(name="inputs", dtype=DataType.STRING)],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="word", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="entity", dtype=DataType.STRING),
+                    FeatureSpec(name="index", dtype=DataType.INT64),
+                    FeatureSpec(name="start", dtype=DataType.INT64),
+                    FeatureSpec(name="end", dtype=DataType.INT64),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for question-answering task when top_k is larger than 1 has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="question", dtype=DataType.STRING),
+            FeatureSpec(name="context", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="question", dtype=DataType.STRING),
+            FeatureSpec(name="context", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="answers",
+                specs=[
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="start", dtype=DataType.INT64),
+                    FeatureSpec(name="end", dtype=DataType.INT64),
+                    FeatureSpec(name="answer", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for text-classification task when top_k is `None` has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+            FeatureSpec(name="text_pair", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="label", dtype=DataType.STRING),
+            FeatureSpec(name="score", dtype=DataType.DOUBLE),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="label", dtype=DataType.STRING),
+            FeatureSpec(name="score", dtype=DataType.DOUBLE),
+        ],
+    )
+    ```
+
+  - Signature for text-classification task when top_k is not `None` has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+            FeatureSpec(name="text_pair", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="labels",
+                specs=[
+                    FeatureSpec(name="label", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for text-generation task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[FeatureSpec(name="inputs", dtype=DataType.STRING)],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureGroupSpec(
+                name="inputs",
+                specs=[
+                    FeatureSpec(name="role", dtype=DataType.STRING),
+                    FeatureSpec(name="content", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="generated_text", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            )
+        ],
+    )
+    ```
+
+- Registry: PyTorch and TensorFlow models now expect a single tensor input/output by default when logging to Model
+  Registry. To use multiple tensors (previous behavior), set `options={"multiple_inputs": True}`.
+
+  Example with single tensor input:
+
+  ```python
+  import torch
+
+  class TorchModel(torch.nn.Module):
+      def __init__(self, n_input: int, n_hidden: int, n_out: int, dtype: torch.dtype = torch.float32) -> None:
+          super().__init__()
+          self.model = torch.nn.Sequential(
+              torch.nn.Linear(n_input, n_hidden, dtype=dtype),
+              torch.nn.ReLU(),
+              torch.nn.Linear(n_hidden, n_out, dtype=dtype),
+              torch.nn.Sigmoid(),
+          )
+
+      def forward(self, tensor: torch.Tensor) -> torch.Tensor:
+          return cast(torch.Tensor, self.model(tensor))
+
+  # Sample usage:
+  data_x = torch.rand(size=(batch_size, n_input))
+
+  # Log model with single tensor
+  reg.log_model(
+      model=model,
+      ...,
+      sample_input_data=data_x
+  )
+
+  # Run inference with single tensor
+  mv.run(data_x)
+  ```
+
+  For multiple tensor inputs/outputs, use:
+
+  ```python
+  reg.log_model(
+      model=model,
+      ...,
+      sample_input_data=[data_x_1, data_x_2],
+      options={"multiple_inputs": True}
+  )
+  ```
+
+- Registry: Default `enable_explainability` to False when the model can be deployed to Snowpark Container Services.
+
+### New Features
+
+- Registry: Added support to single `torch.Tensor`, `tensorflow.Tensor` and `tensorflow.Variable` as input or output
+  data.
+- Registry: Support [`xgboost.DMatrix`](https://xgboost.readthedocs.io/en/stable/python/python_api.html#xgboost.DMatrix)
+ datatype for XGBoost models.
+
+## 1.7.5 (03-06-2025)
 
 - Support Python 3.12.
-- Explainability: Support native and snowml sklearn pipeline
+- Explainability: Support native and snowflake.ml.modeling sklearn pipeline
 
 ### Bug Fixes
 
@@ -20,8 +317,6 @@
   `ValueError(f"{self.entrypoint} must be a subpath of {self.source}")`
 - ML Job (PrPr): Fixed a bug in Ray cluster startup config which caused certain Runtime APIs to fail
 
-### Behavior Change
-
 ### New Features
 
 - Registry: Added support for handling Hugging Face model configurations with auto-mapping functionality.

{snowflake_ml_python-1.7.5/snowflake_ml_python.egg-info → snowflake_ml_python-1.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: snowflake-ml-python
-Version: 1.7.5
+Version: 1.8.1
 Summary: The machine learning client library that is used for interacting with Snowflake to build machine learning solutions.
 Author-email: "Snowflake, Inc" <support@snowflake.com>
 License: 
@@ -236,7 +236,7 @@ License-File: LICENSE.txt
 Requires-Dist: absl-py<2,>=0.15
 Requires-Dist: anyio<5,>=3.5.0
 Requires-Dist: cachetools<6,>=3.1.1
-Requires-Dist: cloudpickle>=2.0.0
+Requires-Dist: cloudpickle<3,>=2.0.0
 Requires-Dist: cryptography
 Requires-Dist: fsspec[http]<2026,>=2024.6.1
 Requires-Dist: importlib_resources<7,>=6.1.1
@@ -251,7 +251,7 @@ Requires-Dist: retrying<2,>=1.3.3
 Requires-Dist: s3fs<2026,>=2024.6.1
 Requires-Dist: scikit-learn<1.6,>=1.4
 Requires-Dist: scipy<2,>=1.9
-Requires-Dist: snowflake-connector-python[pandas]<4,>=3.5.0
+Requires-Dist: snowflake-connector-python[pandas]<4,>=3.12.0
 Requires-Dist: snowflake-snowpark-python!=1.26.0,<2,>=1.17.0
 Requires-Dist: sqlparse<1,>=0.4
 Requires-Dist: typing-extensions<5,>=4.1.0
@@ -261,14 +261,14 @@ Requires-Dist: catboost<2,>=1.2.0; extra == "all"
 Requires-Dist: keras<4,>=2.0.0; extra == "all"
 Requires-Dist: lightgbm<5,>=4.1.0; extra == "all"
 Requires-Dist: mlflow<3,>=2.16.0; extra == "all"
-Requires-Dist: sentence-transformers<3,>=2.7.0; extra == "all"
+Requires-Dist: sentence-transformers<4,>=2.7.0; extra == "all"
 Requires-Dist: sentencepiece<0.2.0,>=0.1.95; extra == "all"
 Requires-Dist: shap<1,>=0.46.0; extra == "all"
 Requires-Dist: tensorflow<3,>=2.17.0; extra == "all"
 Requires-Dist: tokenizers<1,>=0.15.1; extra == "all"
 Requires-Dist: torch<3,>=2.0.1; extra == "all"
 Requires-Dist: torchdata<1,>=0.4; extra == "all"
-Requires-Dist: transformers<5,>=4.37.2; extra == "all"
+Requires-Dist: transformers<5,>=4.39.3; extra == "all"
 Provides-Extra: catboost
 Requires-Dist: catboost<2,>=1.2.0; extra == "catboost"
 Provides-Extra: keras
@@ -287,11 +287,12 @@ Provides-Extra: torch
 Requires-Dist: torch<3,>=2.0.1; extra == "torch"
 Requires-Dist: torchdata<1,>=0.4; extra == "torch"
 Provides-Extra: transformers
-Requires-Dist: sentence-transformers<3,>=2.7.0; extra == "transformers"
+Requires-Dist: sentence-transformers<4,>=2.7.0; extra == "transformers"
 Requires-Dist: sentencepiece<0.2.0,>=0.1.95; extra == "transformers"
 Requires-Dist: tokenizers<1,>=0.15.1; extra == "transformers"
 Requires-Dist: torch<3,>=2.0.1; extra == "transformers"
-Requires-Dist: transformers<5,>=4.37.2; extra == "transformers"
+Requires-Dist: transformers<5,>=4.39.3; extra == "transformers"
+Dynamic: license-file
 
 # Snowpark ML
 
@@ -401,10 +402,307 @@ NOTE: Version 1.7.0 is used as example here. Please choose the the latest versio
 
 # Release History
 
-## 1.7.5
+## 1.8.1
+
+### Bug Fixes
+
+- Registry: Fix a bug that caused `unsupported model type` error while logging a sklearn model with `score_samples`
+  inference method.
+- Registry: Fix a bug that model inference service creation fails on an existing and suspended service.
+
+### Behavior Change
+
+### New Features
+
+- ML Job (PrPr): Update Container Runtime image version to `1.0.1`
+- ML Job (PrPr): Add `enable_metrics` argument to job submission APIs to enable publishing service metrics to Event Table.
+  See [Accessing Event Table service metrics](https://docs.snowflake.com/en/developer-guide/snowpark-container-services/monitoring-services#accessing-event-table-service-metrics)
+  for retrieving published metrics
+  and [Costs of telemetry data collection](https://docs.snowflake.com/en/developer-guide/logging-tracing/logging-tracing-billing)
+  for cost implications.
+- Registry: When creating a copy of a `ModelVersion` with `log_model`, raise an exception if unsupported arguments are provided.
+
+## 1.8.0
+
+### Bug Fixes
+
+- Modeling: Fix a bug in some metrics that allowed an unsupported version of numpy to be installed
+  automatically in the stored procedure, resulting in a numpy error on execution
+- Registry: Fix a bug that leads to incorrect `Model is does not have _is_inference_api` error message when assigning
+  a supported model as a property of a CustomModel.
+- Registry: Fix a bug that inference is not working when models with more than 500 input features
+  are deployed to SPCS.
+
+### Behavior Change
+
+- Registry: With FeatureGroupSpec support, auto inferred model signature for `transformers.Pipeline` models have been
+  updated, including:
+  - Signature for fill-mask task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="sequence", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="token", dtype=DataType.INT64),
+                    FeatureSpec(name="token_str", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for token-classification task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="inputs", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[FeatureSpec(name="inputs", dtype=DataType.STRING)],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="word", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="entity", dtype=DataType.STRING),
+                    FeatureSpec(name="index", dtype=DataType.INT64),
+                    FeatureSpec(name="start", dtype=DataType.INT64),
+                    FeatureSpec(name="end", dtype=DataType.INT64),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for question-answering task when top_k is larger than 1 has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="question", dtype=DataType.STRING),
+            FeatureSpec(name="context", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="question", dtype=DataType.STRING),
+            FeatureSpec(name="context", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="answers",
+                specs=[
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                    FeatureSpec(name="start", dtype=DataType.INT64),
+                    FeatureSpec(name="end", dtype=DataType.INT64),
+                    FeatureSpec(name="answer", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for text-classification task when top_k is `None` has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+            FeatureSpec(name="text_pair", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="label", dtype=DataType.STRING),
+            FeatureSpec(name="score", dtype=DataType.DOUBLE),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="label", dtype=DataType.STRING),
+            FeatureSpec(name="score", dtype=DataType.DOUBLE),
+        ],
+    )
+    ```
+
+  - Signature for text-classification task when top_k is not `None` has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+            FeatureSpec(name="text_pair", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureSpec(name="text", dtype=DataType.STRING),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="labels",
+                specs=[
+                    FeatureSpec(name="label", dtype=DataType.STRING),
+                    FeatureSpec(name="score", dtype=DataType.DOUBLE),
+                ],
+                shape=(-1,),
+            ),
+        ],
+    )
+    ```
+
+  - Signature for text-generation task has been changed from
+
+    ```python
+    ModelSignature(
+        inputs=[FeatureSpec(name="inputs", dtype=DataType.STRING)],
+        outputs=[
+            FeatureSpec(name="outputs", dtype=DataType.STRING),
+        ],
+    )
+    ```
+
+    to
+
+    ```python
+    ModelSignature(
+        inputs=[
+            FeatureGroupSpec(
+                name="inputs",
+                specs=[
+                    FeatureSpec(name="role", dtype=DataType.STRING),
+                    FeatureSpec(name="content", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            ),
+        ],
+        outputs=[
+            FeatureGroupSpec(
+                name="outputs",
+                specs=[
+                    FeatureSpec(name="generated_text", dtype=DataType.STRING),
+                ],
+                shape=(-1,),
+            )
+        ],
+    )
+    ```
+
+- Registry: PyTorch and TensorFlow models now expect a single tensor input/output by default when logging to Model
+  Registry. To use multiple tensors (previous behavior), set `options={"multiple_inputs": True}`.
+
+  Example with single tensor input:
+
+  ```python
+  import torch
+
+  class TorchModel(torch.nn.Module):
+      def __init__(self, n_input: int, n_hidden: int, n_out: int, dtype: torch.dtype = torch.float32) -> None:
+          super().__init__()
+          self.model = torch.nn.Sequential(
+              torch.nn.Linear(n_input, n_hidden, dtype=dtype),
+              torch.nn.ReLU(),
+              torch.nn.Linear(n_hidden, n_out, dtype=dtype),
+              torch.nn.Sigmoid(),
+          )
+
+      def forward(self, tensor: torch.Tensor) -> torch.Tensor:
+          return cast(torch.Tensor, self.model(tensor))
+
+  # Sample usage:
+  data_x = torch.rand(size=(batch_size, n_input))
+
+  # Log model with single tensor
+  reg.log_model(
+      model=model,
+      ...,
+      sample_input_data=data_x
+  )
+
+  # Run inference with single tensor
+  mv.run(data_x)
+  ```
+
+  For multiple tensor inputs/outputs, use:
+
+  ```python
+  reg.log_model(
+      model=model,
+      ...,
+      sample_input_data=[data_x_1, data_x_2],
+      options={"multiple_inputs": True}
+  )
+  ```
+
+- Registry: Default `enable_explainability` to False when the model can be deployed to Snowpark Container Services.
+
+### New Features
+
+- Registry: Added support to single `torch.Tensor`, `tensorflow.Tensor` and `tensorflow.Variable` as input or output
+  data.
+- Registry: Support [`xgboost.DMatrix`](https://xgboost.readthedocs.io/en/stable/python/python_api.html#xgboost.DMatrix)
+ datatype for XGBoost models.
+
+## 1.7.5 (03-06-2025)
 
 - Support Python 3.12.
-- Explainability: Support native and snowml sklearn pipeline
+- Explainability: Support native and snowflake.ml.modeling sklearn pipeline
 
 ### Bug Fixes
 
@@ -421,8 +719,6 @@ NOTE: Version 1.7.0 is used as example here. Please choose the the latest versio
   `ValueError(f"{self.entrypoint} must be a subpath of {self.source}")`
 - ML Job (PrPr): Fixed a bug in Ray cluster startup config which caused certain Runtime APIs to fail
 
-### Behavior Change
-
 ### New Features
 
 - Registry: Added support for handling Hugging Face model configurations with auto-mapping functionality.