fiddler-client 1.7.0.dev3__tar.gz → 1.7.0.dev4__tar.gz

{fiddler-client-1.7.0.dev3 → fiddler-client-1.7.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 1.7.0.dev3
+Version: 1.7.0.dev4
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -43,7 +43,7 @@ Description: Fiddler Client
         
         ### 1.6.2
           - #### **Modifications**
-            - Made dataset_id a required field in add_model()
+            - Make dataset_id a required field in add_model()
             - Update max_inferred_cardinality to 100
           - #### **New Features**
             - New method for updating a model artifact `update_model_artifact`

{fiddler-client-1.7.0.dev3 → fiddler-client-1.7.0.dev4}/PUBLIC.md

@@ -36,7 +36,7 @@ Version History
 
 ### 1.6.2
   - #### **Modifications**
-    - Made dataset_id a required field in add_model()
+    - Make dataset_id a required field in add_model()
     - Update max_inferred_cardinality to 100
   - #### **New Features**
     - New method for updating a model artifact `update_model_artifact`

fiddler-client-1.7.0.dev4/fiddler/_version.py

@@ -0,0 +1 @@
+__version__ = '1.7.0.dev4'

{fiddler-client-1.7.0.dev3 → fiddler-client-1.7.0.dev4}/fiddler/core_objects.py

@@ -6,6 +6,7 @@ import functools
 import json
 import logging
 import textwrap
+import warnings
 from dataclasses import asdict, dataclass
 from pathlib import Path
 from typing import (
@@ -26,7 +27,6 @@ import pandas as pd
 import pandas.api.types
 import pyarrow as pa
 from deprecated import deprecated
-import warnings
 
 from ._version import __version__
 from .utils.exceptions import MalformedSchemaException
@@ -1292,7 +1292,7 @@ class ModelInfo:
         explanation method if unspecified (typically Fiddler Shapley).
         Must be one of the built-in explanation types (ie an `fdl.core_objects.ExplanationMethod`) or be specified as
         a custom explanation type via `custom_explanation_names` (and in `package.py`).
-    :param custom_explanation_names: 
+    :param custom_explanation_names:
     [Optional] List of (string) names that
         can be passed to the explanation_name argument of the optional
         user-defined explain_custom method of the model object defined in
@@ -1342,7 +1342,6 @@ class ModelInfo:
         tree_shap_enabled: Optional[bool] = False,
         custom_features: Optional[List[CustomFeature]] = None,
         is_binary_ranking_model: Optional[bool] = None,
-        
         **kwargs,
     ):
         self.display_name = display_name
@@ -1370,26 +1369,26 @@ class ModelInfo:
         # warning for parameters deprecated in version 1.7
         if mlflow_params is not None:
             self.warn_deprecated_parameter(
-                param_name='mlflow_params', 
-                from_version='1.7')
+                param_name='mlflow_params', from_version='1.7'
+            )
         if display_name is not None:
             self.warn_deprecated_parameter(
-                param_name='display_name', 
-                from_version='1.7')
+                param_name='display_name', from_version='1.7'
+            )
         if model_deployment_params is not None:
             self.warn_deprecated_parameter(
-                param_name='model_deployment_params', 
-                from_version='1.7')
-        
+                param_name='model_deployment_params', from_version='1.7'
+            )
+
         # artifact_status is set by Model Service
         # POST /v2/models sets  artifact_status to NO_MODEL
         # POST /v2/<model-id>/deploy-artifacts/... sets USER_UPLOADED
         # POST /v2/<model-id>/deploy-surrogate sets SURROGATE
         if artifact_status is not None:
             self.warn_deprecated_parameter(
-                param_name='artifact_status', 
-                from_version='1.7')
-            
+                param_name='artifact_status', from_version='1.7'
+            )
+
         if custom_explanation_names is None:
             custom_explanation_names = []
 
@@ -1519,11 +1518,11 @@ class ModelInfo:
                             f"Custom features '{feature.name}' is defined based on column '{feature.columns}' which was not found."
                         )
 
-    def warn_deprecated_parameter(self, param_name:str, from_version:str) -> None:
+    def warn_deprecated_parameter(self, param_name: str, from_version: str) -> None:
         warnings.warn(
-                f'WARNING: {param_name} is deprecated in {from_version}. It will be removed from 2.0.0 version.', DeprecationWarning
-            )
-
+            f'WARNING: {param_name} is deprecated in {from_version}. It will be removed from 2.0.0 version.',
+            DeprecationWarning,
+        )
 
     def to_dict(self):
         """Dumps to basic python objects (easy for JSON serialization)"""
@@ -1968,14 +1967,17 @@ class ModelInfo:
         """
         if categorical_target_class_details is not None:
             warnings.warn(
-                'WARNING: categorical_target_class_details is deprecated in 1.7 and will be removed from 2.0.0 version. As a replacement, use target_class_order while constructing ModelInfo.', DeprecationWarning
+                'WARNING: categorical_target_class_details is deprecated in 1.7 and will be removed from 2.0.0 version. As a replacement, use target_class_order while constructing ModelInfo.',
+                DeprecationWarning,
             )
 
         if custom_explanation_names is None:
             custom_explanation_names = []
 
         if not isinstance(dataset_info, DatasetInfo):
-            raise ValueError(f'The dataset_info parameter must be a valid DatasetInfo object')
+            raise ValueError(
+                f'The dataset_info parameter must be a valid DatasetInfo object'
+            )
 
         if display_name is None:
             if dataset_info.display_name is not None:
@@ -2322,6 +2324,17 @@ class ModelInfo:
                 assert decisions is not None, 'decisions unexpectedly None'
                 decisions.append(column.copy())
 
+        # dataset_id creation
+        if dataset_id is not None:
+            datasets = [dataset_id]
+        elif dataset_info.dataset_id is not None:
+            datasets = [dataset_info.dataset_id]
+        else:
+            raise ValueError(
+                'Please specify a dataset_id, it could not be inferred from the '
+                'dataset_info.'
+            )
+
         # perform checks for weighting parameters
         if weighting_params is not None:
             if (
@@ -2361,6 +2374,7 @@ class ModelInfo:
             metadata=metadata,
             decisions=decisions,
             targets=[target_column],
+            datasets=datasets,
             weighting_params=weighting_params,
             mlflow_params=None,
             model_deployment_params=model_deployment_params,

{fiddler-client-1.7.0.dev3 → fiddler-client-1.7.0.dev4}/fiddler/fiddler_api.py

@@ -1282,6 +1282,9 @@ class FiddlerApi:
         with yaml_file.open() as f:
             model_info = ModelInfo.from_dict(yaml.safe_load(f))
 
+        if not model_info.datasets:
+            raise ValueError('Please provide the dataset_id while creating model_info.')
+
         deployment_type = DeploymentType[deployment_type.upper()]
         valid_deployment_types = [DeploymentType.PREDICTOR, DeploymentType.EXECUTOR]
         if deployment_type not in valid_deployment_types:

{fiddler-client-1.7.0.dev3 → fiddler-client-1.7.0.dev4}/fiddler_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 1.7.0.dev3
+Version: 1.7.0.dev4
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -43,7 +43,7 @@ Description: Fiddler Client
         
         ### 1.6.2
           - #### **Modifications**
-            - Made dataset_id a required field in add_model()
+            - Make dataset_id a required field in add_model()
             - Update max_inferred_cardinality to 100
           - #### **New Features**
             - New method for updating a model artifact `update_model_artifact`

fiddler-client-1.7.0.dev3/fiddler/_version.py

@@ -1 +0,0 @@
-__version__ = '1.7.0.dev3'