snowflake-ml-python 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

{snowflake_ml_python-1.4.0.dist-info → snowflake_ml_python-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snowflake-ml-python
-Version: 1.4.0
+Version: 1.5.0
 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,12 +236,13 @@ License-File: LICENSE.txt
 Requires-Dist: absl-py <2,>=0.15
 Requires-Dist: anyio <4,>=3.5.0
 Requires-Dist: cachetools <6,>=3.1.1
+Requires-Dist: catboost <1.3,>=1.2.0
 Requires-Dist: cloudpickle >=2.0.0
 Requires-Dist: fsspec[http] <2024,>=2022.11
 Requires-Dist: importlib-resources <7,>=6.1.1
 Requires-Dist: numpy <2,>=1.23
 Requires-Dist: packaging <24,>=20.9
-Requires-Dist: pandas <2,>=1.0.0
+Requires-Dist: pandas <3,>=1.0.0
 Requires-Dist: pyarrow
 Requires-Dist: pytimeparse <2,>=1.1.8
 Requires-Dist: pyyaml <7,>=6.0
@@ -255,7 +256,7 @@ Requires-Dist: sqlparse <1,>=0.4
 Requires-Dist: typing-extensions <5,>=4.1.0
 Requires-Dist: xgboost <2,>=1.7.3
 Provides-Extra: all
-Requires-Dist: lightgbm ==3.3.5 ; extra == 'all'
+Requires-Dist: lightgbm <4.2,>=3.3.5 ; extra == 'all'
 Requires-Dist: mlflow <2.4,>=2.1.0 ; extra == 'all'
 Requires-Dist: peft <1,>=0.5.0 ; extra == 'all'
 Requires-Dist: sentence-transformers <3,>=2.2.2 ; extra == 'all'
@@ -263,11 +264,11 @@ Requires-Dist: sentencepiece <0.2,>=0.1.95 ; extra == 'all'
 Requires-Dist: shap ==0.42.1 ; extra == 'all'
 Requires-Dist: tensorflow <3,>=2.10 ; extra == 'all'
 Requires-Dist: tokenizers <1,>=0.10 ; extra == 'all'
+Requires-Dist: torch <3,>=2.0.1 ; extra == 'all'
 Requires-Dist: torchdata <1,>=0.4 ; extra == 'all'
 Requires-Dist: transformers <5,>=4.32.1 ; extra == 'all'
-Requires-Dist: torch <2.1.0,>=2.0.1 ; (platform_system == "Windows") and extra == 'all'
 Provides-Extra: lightgbm
-Requires-Dist: lightgbm ==3.3.5 ; extra == 'lightgbm'
+Requires-Dist: lightgbm <4.2,>=3.3.5 ; extra == 'lightgbm'
 Provides-Extra: llm
 Requires-Dist: peft <1,>=0.5.0 ; extra == 'llm'
 Provides-Extra: mlflow
@@ -277,8 +278,8 @@ Requires-Dist: shap ==0.42.1 ; extra == 'shap'
 Provides-Extra: tensorflow
 Requires-Dist: tensorflow <3,>=2.10 ; extra == 'tensorflow'
 Provides-Extra: torch
+Requires-Dist: torch <3,>=2.0.1 ; extra == 'torch'
 Requires-Dist: torchdata <1,>=0.4 ; extra == 'torch'
-Requires-Dist: torch <2.1.0,>=2.0.1 ; (platform_system == "Windows") and extra == 'torch'
 Provides-Extra: transformers
 Requires-Dist: sentence-transformers <3,>=2.2.2 ; extra == 'transformers'
 Requires-Dist: sentencepiece <0.2,>=0.1.95 ; extra == 'transformers'
@@ -370,17 +371,89 @@ be compatibility issues. Server-side functionality that `snowflake-ml-python` de
 
 # Release History
 
-## 1.4.0
+## 1.5.0
+
+### Bug Fixes
+
+- Registry: Fix invalid parameter 'SHOW_MODEL_DETAILS_IN_SHOW_VERSIONS_IN_MODEL' error.
+
+### Behavior Changes
+
+- Model Development: The behavior of `fit_transform` for all estimators is changed.
+  Firstly, it will cover all the estimator that contains this function,
+  secondly, the output would be the union of pandas DataFrame and snowpark DataFrame.
+
+#### Model Registry (PrPr)
+
+`snowflake.ml.registry.artifact` and related `snowflake.ml.model_registry.ModelRegistry` APIs have been removed.
+
+- Removed `snowflake.ml.registry.artifact` module.
+- Removed `ModelRegistry.log_artifact()`, `ModelRegistry.list_artifacts()`, `ModelRegistry.get_artifact()`
+- Removed `artifacts` argument from `ModelRegistry.log_model()`
+
+#### Dataset (PrPr)
+
+`snowflake.ml.dataset.Dataset` has been redesigned to be backed by Snowflake Dataset entities.
+
+- New `Dataset`s can be created with `Dataset.create()` and existing `Dataset`s may be loaded
+  with `Dataset.load()`.
+- `Dataset`s now maintain an immutable `selected_version` state. The `Dataset.create_version()` and
+  `Dataset.load_version()` APIs return new `Dataset` objects with the requested `selected_version` state.
+- Added `dataset.create_from_dataframe()` and `dataset.load_dataset()` convenience APIs as a shortcut
+  to creating and loading `Dataset`s with a pre-selected version.
+- `Dataset.materialized_table` and `Dataset.snapshot_table` no longer exist with `Dataset.fully_qualified_name`
+  as the closest equivalent.
+- `Dataset.df` no longer exists. Instead, use `DatasetReader.read.to_snowpark_dataframe()`.
+- `Dataset.owner` has been moved to `Dataset.selected_version.owner`
+- `Dataset.desc` has been moved to `DatasetVersion.selected_version.comment`
+- `Dataset.timestamp_col`, `Dataset.label_cols`, `Dataset.feature_store_metadata`, and
+  `Dataset.schema_version` have been removed.
+
+#### Feature Store (PrPr)
+
+`FeatureStore.generate_dataset` argument list has been changed to match the new
+`snowflake.ml.dataset.Dataset` definition
+
+- `materialized_table` has been removed and replaced with `name` and `version`.
+- `name` moved to first positional argument
+- `save_mode` has been removed as `merge` behavior is no longer supported. The new behavior is always `errorifexists`.
+
+### New Features
+
+- Registry: Add `export` method to `ModelVersion` instance to export model files.
+- Registry: Add `load` method to `ModelVersion` instance to load the underlying object from the model.
+- Registry: Add `Model.rename` method to `Model` instance to rename or move a model.
+
+#### Dataset (PrPr)
+
+- Added Snowpark DataFrame integration using `Dataset.read.to_snowpark_dataframe()`
+- Added Pandas DataFrame integration using `Dataset.read.to_pandas()`
+- Added PyTorch and TensorFlow integrations using `Dataset.read.to_torch_datapipe()`
+    and `Dataset.read.to_tf_dataset()` respectively.
+- Added `fsspec` style file integration using `Dataset.read.files()` and `Dataset.read.filesystem()`
+
+## 1.4.1 (2024-04-18)
+
+### New Features
+
+- Registry: Add support for `catboost` model (`catboost.CatBoostClassifier`, `catboost.CatBoostRegressor`).
+- Registry: Add support for `lightgbm` model (`lightgbm.Booster`, `lightgbm.LightGBMClassifier`, `lightgbm.LightGBMRegressor`).
+
+### Bug Fixes
+
+- Registry: Fix a bug that leads to relax_version option is not working.
+
+## 1.4.0 (2024-04-08)
 
 ### Bug Fixes
 
 - Registry: Fix a bug when multiple models are being called from the same query, models other than the first one will
   have incorrect result. This fix only works for newly logged model.
 - Modeling: When registering a model, only method(s) that is mentioned in `save_model` would be added to model signature
-in SnowML models.
+  in SnowML models.
 - Modeling: Fix a bug that when n_jobs is not 1, model cannot execute methods such as
-predict, predict_log_proba, and other batch inference methods. The n_jobs would automatically
-set to 1 because vectorized udf currently doesn't support joblib parallel backend.
+  predict, predict_log_proba, and other batch inference methods. The n_jobs would automatically
+  set to 1 because vectorized udf currently doesn't support joblib parallel backend.
 - Modeling: Fix a bug that batch inference methods cannot infer the datatype when the first row of data contains NULL.
 - Modeling: Matches Distributed HPO output column names with the snowflake identifier.
 - Modeling: Relax package versions for all Distributed HPO methods if the installed version
@@ -440,8 +513,7 @@ set to 1 because vectorized udf currently doesn't support joblib parallel backen
 - Registry: Improve the error message when specifying currently unsupported `pip_requirements` argument.
 - Model Development: Fix precision_recall_fscore_support incorrect results when `average="samples"`.
 - Model Registry: Fix an issue that leads to description, metrics or tags are not correctly returned in newly created
-  Model Registry (PrPr) due to Snowflake BCR [2024_01](
-  https://docs.snowflake.com/en/release-notes/bcr-bundles/2024_01/bcr-1483)
+  Model Registry (PrPr) due to Snowflake BCR [2024_01](https://docs.snowflake.com/en/release-notes/bcr-bundles/2024_01/bcr-1483)
 
 ### Behavior Changes
 
@@ -493,9 +565,9 @@ set to 1 because vectorized udf currently doesn't support joblib parallel backen
 ### Additional Notes
 
 - Model Registry: The `snowflake.ml.registry.model_registry.ModelRegistry` has been deprecated starting from version
-1.2.0. It will stay in the Private Preview phase. For future implementations, kindly utilize
-`snowflake.ml.registry.Registry`, except when specifically required. The old model registry will be removed once all
-its primary functionalities are fully integrated into the new registry.
+  1.2.0. It will stay in the Private Preview phase. For future implementations, kindly utilize
+  `snowflake.ml.registry.Registry`, except when specifically required. The old model registry will be removed once all
+  its primary functionalities are fully integrated into the new registry.
 
 ## 1.1.2 (2023-12-18)
 
@@ -550,7 +622,7 @@ its primary functionalities are fully integrated into the new registry.
 - Model Registry: Fix regression issue that container logging is not shown during model deployment to SPCS.
 - Model Development: Enhance the column capacity of OrdinalEncoder.
 - Model Registry: Fix unbound `batch_size` error when deploying a model other than Hugging Face Pipeline
-   and LLM with GPU on SPCS.
+  and LLM with GPU on SPCS.
 
 ### Behavior Changes
 
@@ -592,7 +664,7 @@ its primary functionalities are fully integrated into the new registry.
 ### Behavior Changes
 
 - Model Development: precision_score, recall_score, f1_score, fbeta_score, precision_recall_fscore_support,
-mean_absolute_error, mean_squared_error, and mean_absolute_percentage_error metric calculations are now distributed.
+  mean_absolute_error, mean_squared_error, and mean_absolute_percentage_error metric calculations are now distributed.
 - Model Registry: `deploy` will now return `Deployment` for deployment information.
 
 ### New Features
@@ -606,7 +678,7 @@ mean_absolute_error, mean_squared_error, and mean_absolute_percentage_error metr
 - Model Development: Fix an issue that alias definitions cause `SnowparkSQLUnexpectedAliasException` in inference.
 - Model Registry: Fix an issue that signature inference could be incorrect when using Snowpark DataFrame as sample input.
 - Model Registry: Fix too strict data type validation when predicting. Now, for example, if you have a INT8
- type feature in the signature, if providing a INT64 dataframe but all values are within the range, it would not fail.
+  type feature in the signature, if providing a INT64 dataframe but all values are within the range, it would not fail.
 
 ## 1.0.9 (2023-09-28)
 
@@ -629,7 +701,7 @@ mean_absolute_error, mean_squared_error, and mean_absolute_percentage_error metr
 - Model Development: Fix an issue when the sklearn default value is `np.nan`.
 - Model Registry: Fix an issue that incorrect docker executable is used when building images.
 - Model Registry: Fix an issue that specifying `token` argument when using
-`snowflake.ml.model.models.huggingface_pipeline.HuggingFacePipelineModel` with `transformers < 4.32.0` is not effective.
+  `snowflake.ml.model.models.huggingface_pipeline.HuggingFacePipelineModel` with `transformers < 4.32.0` is not effective.
 - Model Registry: Fix an issue that incorrect system function call is used when deploying to SPCS.
 - Model Registry: Fix an issue when using a `transformers.pipeline` that does not have a `tokenizer`.
 - Model Registry: Fix incorrectly-inferred image repository name during model deployment to SPCS.
@@ -649,17 +721,17 @@ mean_absolute_error, mean_squared_error, and mean_absolute_percentage_error metr
 - Model Registry: add `create_if_not_exists` parameter in constructor.
 - Model Registry: Added get_or_create_model_registry API.
 - Model Registry: Added support for using GPU inference when deploying XGBoost (`xgboost.XGBModel` and `xgboost.Booster`
-), PyTorch (`torch.nn.Module` and `torch.jit.ScriptModule`) and TensorFlow (`tensorflow.Module` and
-`tensorflow.keras.Model`) models to Snowpark Container Services.
+  ), PyTorch (`torch.nn.Module` and `torch.jit.ScriptModule`) and TensorFlow (`tensorflow.Module` and
+  `tensorflow.keras.Model`) models to Snowpark Container Services.
 - Model Registry: When inferring model signature, `Sequence` of built-in types, `Sequence` of `numpy.ndarray`,
-`Sequence` of `torch.Tensor`, `Sequence` of `tensorflow.Tensor` and `Sequence` of `tensorflow.Tensor` can be used
- instead of only `List` of them.
+  `Sequence` of `torch.Tensor`, `Sequence` of `tensorflow.Tensor` and `Sequence` of `tensorflow.Tensor` can be used
+  instead of only `List` of them.
 - Model Registry: Added `get_training_dataset` API.
 - Model Development: Size of metrics result can exceed previous 8MB limit.
 - Model Registry: Added support save/load/deploy HuggingFace pipeline object (`transformers.Pipeline`) and our wrapper
-(`snowflake.ml.model.models.huggingface_pipeline.HuggingFacePipelineModel`) to it. Using the wrapper to specify
-configurations and the model for the pipeline will be loaded dynamically when deploying. Currently, following tasks
-are supported to log without manually specifying model signatures:
+  (`snowflake.ml.model.models.huggingface_pipeline.HuggingFacePipelineModel`) to it. Using the wrapper to specify
+  configurations and the model for the pipeline will be loaded dynamically when deploying. Currently, following tasks
+  are supported to log without manually specifying model signatures:
   - "conversational"
   - "fill-mask"
   - "question-answering"
@@ -683,18 +755,18 @@ are supported to log without manually specifying model signatures:
 - Model Registry: `log_model()` now return a `ModelReference` object instead of a model ID.
 - Model Registry: When deploying a model with 1 `target method` only, the `target_method` argument can be omitted.
 - Model Registry: When using the snowflake-ml-python with version newer than what is available in Snowflake Anaconda
-Channel, `embed_local_ml_library` option will be set as `True` automatically if not.
+  Channel, `embed_local_ml_library` option will be set as `True` automatically if not.
 - Model Registry: When deploying a model to Snowpark Container Services and using GPU, the default value of num_workers
-will be 1.
+  will be 1.
 - Model Registry: `keep_order` and `output_with_input_features` in the deploy options have been removed. Now the
-behavior is controlled by the type of the input when calling `model.predict()`. If the input is a `pandas.DataFrame`,
-the behavior will be the same as `keep_order=True` and `output_with_input_features=False` before. If the input is a
-`snowpark.DataFrame`, the behavior will be the same as `keep_order=False` and `output_with_input_features=True` before.
+  behavior is controlled by the type of the input when calling `model.predict()`. If the input is a `pandas.DataFrame`,
+  the behavior will be the same as `keep_order=True` and `output_with_input_features=False` before. If the input is a
+  `snowpark.DataFrame`, the behavior will be the same as `keep_order=False` and `output_with_input_features=True` before.
 - Model Registry: When logging and deploying PyTorch (`torch.nn.Module` and `torch.jit.ScriptModule`) and TensorFlow
-(`tensorflow.Module` and `tensorflow.keras.Model`) models, we no longer accept models whose input is a list of tensor
-and output is a list of tensors. Instead, now we accept models whose input is 1 or more tensors as positional arguments,
- and output is a tensor or a tuple of tensors. The input and output dataframe when predicting keep the same as before,
- that is every column is an array feature and contains a tensor.
+  (`tensorflow.Module` and `tensorflow.keras.Model`) models, we no longer accept models whose input is a list of tensor
+  and output is a list of tensors. Instead, now we accept models whose input is 1 or more tensors as positional arguments,
+  and output is a tensor or a tuple of tensors. The input and output dataframe when predicting keep the same as before,
+  that is every column is an array feature and contains a tensor.
 
 ## 1.0.5 (2023-08-17)
 
@@ -707,7 +779,7 @@ and output is a list of tensors. Instead, now we accept models whose input is 1
 
 - Model Registry: Restore the db/schema back to the session after `create_model_registry()`.
 - Model Registry: Fixed an issue that the UDF name created when deploying a model is not identical to what is provided
-and cannot be correctly dropped when deployment getting dropped.
+  and cannot be correctly dropped when deployment getting dropped.
 - connection_params.SnowflakeLoginOptions(): Added support for `private_key_path`.
 
 ## 1.0.4 (2023-07-28)
@@ -728,7 +800,7 @@ and cannot be correctly dropped when deployment getting dropped.
 ### Behavior Changes
 
 - Model Registry: When predicting a model whose output is a list of NumPy ndarray, the output would not be flattened,
-instead, every ndarray will act as a feature(column) in the output.
+  instead, every ndarray will act as a feature(column) in the output.
 
 ### New Features
 
@@ -737,18 +809,18 @@ instead, every ndarray will act as a feature(column) in the output.
 ### Bug Fixes
 
 - Model Registry: Fix an issue that when database or schema name provided to `create_model_registry` contains special
-characters, the model registry cannot be created.
+  characters, the model registry cannot be created.
 - Model Registry: Fix an issue that `get_model_description` returns with additional quotes.
 - Model Registry: Fix incorrect error message when attempting to remove a unset tag of a model.
 - Model Registry: Fix a typo in the default deployment table name.
 - Model Registry: Snowpark dataframe for sample input or input for `predict` method that contains a column with
-Snowflake `NUMBER(precision, scale)` data type where `scale = 0` will not lead to error, and will now correctly
-recognized as `INT64` data type in model signature.
+  Snowflake `NUMBER(precision, scale)` data type where `scale = 0` will not lead to error, and will now correctly
+  recognized as `INT64` data type in model signature.
 - Model Registry: Fix an issue that prevent model logged in the system whose default encoding is not UTF-8 compatible
-from deploying.
+  from deploying.
 - Model Registry: Added earlier and better error message when any file name in the model or the file name of model
-itself contains characters that are unable to be encoded using ASCII. It is currently not supported to deploy such a
-model.
+  itself contains characters that are unable to be encoded using ASCII. It is currently not supported to deploy such a
+  model.
 
 ## 1.0.2 (2023-06-22)
 
@@ -757,16 +829,16 @@ model.
 - Model Registry: Prohibit non-snowflake-native models from being logged.
 - Model Registry: `_use_local_snowml` parameter in options of `deploy()` has been removed.
 - Model Registry: A default `False` `embed_local_ml_library` parameter has been added to the options of `log_model()`.
-With this set to `False` (default), the version of the local snowflake-ml-python library will be recorded and used when
-deploying the model. With this set to `True`, local snowflake-ml-python library will be embedded into the logged model,
-and will be used when you load or deploy the model.
+  With this set to `False` (default), the version of the local snowflake-ml-python library will be recorded and used when
+  deploying the model. With this set to `True`, local snowflake-ml-python library will be embedded into the logged model,
+  and will be used when you load or deploy the model.
 
 ### New Features
 
 - Model Registry: A new optional argument named `code_paths` has been added to the arguments of `log_model()` for users
-to specify additional code paths to be imported when loading and deploying the model.
+  to specify additional code paths to be imported when loading and deploying the model.
 - Model Registry: A new optional argument named `options` has been added to the arguments of `log_model()` to specify
-any additional options when saving the model.
+  any additional options when saving the model.
 - Model Development: Added metrics:
   - d2_absolute_error_score
   - d2_pinball_score
@@ -785,14 +857,14 @@ any additional options when saving the model.
 
 - Model Development: Changed Metrics APIs to imitate sklearn metrics modules:
   - `accuracy_score()`, `confusion_matrix()`, `precision_recall_fscore_support()`, `precision_score()` methods move from
-  respective modules to `metrics.classification`.
+    respective modules to `metrics.classification`.
 - Model Registry: The default table/stage created by the Registry now uses "_SYSTEM_" as a prefix.
 - Model Registry: `get_model_history()` method as been enhanced to include the history of model deployment.
 
 ### New Features
 
 - Model Registry: A default `False` flag named `replace_udf` has been added to the options of `deploy()`. Setting this
-to `True` will allow overwrite existing UDF with the same name when deploying.
+  to `True` will allow overwrite existing UDF with the same name when deploying.
 - Model Development: Added metrics:
   - f1_score
   - fbeta_score
@@ -802,9 +874,9 @@ to `True` will allow overwrite existing UDF with the same name when deploying.
   - log_loss
   - precision_recall_curve
 - Model Registry: A new argument named `permanent` has been added to the argument of `deploy()`. Setting this to `True`
-allows the creation of a permanent deployment without needing to specify the UDF location.
+  allows the creation of a permanent deployment without needing to specify the UDF location.
 - Model Registry: A new method `list_deployments()` has been added to enumerate all permanent deployments originating
-from a specific model.
+  from a specific model.
 - Model Registry: A new method `get_deployment()` has been added to fetch a deployment by its deployment name.
 - Model Registry: A new method `delete_deployment()` has been added to remove an existing permanent deployment.
 
@@ -814,13 +886,13 @@ from a specific model.
 
 - Model Registry: `predict()` method moves from Registry to ModelReference.
 - Model Registry: `_snowml_wheel_path` parameter in options of `deploy()`, is replaced with `_use_local_snowml` with
-default value of `False`. Setting this to `True` will have the same effect of uploading local SnowML code when executing
-model in the warehouse.
+  default value of `False`. Setting this to `True` will have the same effect of uploading local SnowML code when executing
+  model in the warehouse.
 - Model Registry: Removed `id` field from `ModelReference` constructor.
 - Model Development: Preprocessing and Metrics move to the modeling package: `snowflake.ml.modeling.preprocessing` and
-`snowflake.ml.modeling.metrics`.
+  `snowflake.ml.modeling.metrics`.
 - Model Development: `get_sklearn_object()` method is renamed to `to_sklearn()`, `to_xgboost()`, and `to_lightgbm()` for
-respective native models.
+  respective native models.
 
 ### New Features
 
@@ -882,7 +954,7 @@ respective native models.
 ### New Features
 
 - Model Registry: Added support for delete_model. Use delete_artifact = False to not delete the underlying model data
-but just unregister.
+  but just unregister.
 
 ## 0.2.2 (2023-04-11)