fiddler-client 3.0.5__tar.gz → 3.1.0__tar.gz

{fiddler_client-3.0.5/fiddler_client.egg-info → fiddler_client-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 3.0.5
+Version: 3.1.0
 Summary: Python client for Fiddler Platform
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -30,16 +30,16 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.8.0 and pip >= 21.0
+Requires Python >= Python-3.6.3 and pip >= 19.0
 
 Installation
 ------------
 
-    $ pip3 install "fiddler-client==3.0.*"
+    $ pip3 install fiddler-client
 
 API Example Usage
 -------------
-Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-client-3x). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
+Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-the-fiddler-client). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
 
 Version History
 -------------

{fiddler_client-3.0.5 → fiddler_client-3.1.0}/PUBLIC.md

@@ -6,16 +6,16 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.8.0 and pip >= 21.0
+Requires Python >= Python-3.6.3 and pip >= 19.0
 
 Installation
 ------------
 
-    $ pip3 install "fiddler-client==3.0.*"
+    $ pip3 install fiddler-client
 
 API Example Usage
 -------------
-Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-client-3x). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
+Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-the-fiddler-client). For examples of interacting with our APIs, please check out our [Quick Start Guide](https://docs.fiddler.ai/docs/quick-start) as well as the notebooks found on our [Examples Github](https://github.com/fiddler-labs/fiddler-examples).
 
 Version History
 -------------

fiddler_client-3.1.0/fiddler/VERSION

@@ -0,0 +1 @@
+3.1.0

{fiddler_client-3.0.5 → fiddler_client-3.1.0}/fiddler/entities/alert_rule.py

@@ -8,8 +8,8 @@ from uuid import UUID
 from fiddler.constants.alert_rule import AlertCondition, BinSize, CompareTo, Priority
 from fiddler.decorators import handle_api_error
 from fiddler.entities.base import BaseEntity
-from fiddler.entities.baseline import Baseline, BaselineCompactMixin
-from fiddler.entities.model import Model, ModelCompactMixin
+from fiddler.entities.baseline import BaselineCompactMixin
+from fiddler.entities.model import ModelCompactMixin
 from fiddler.entities.project import ProjectCompactMixin
 from fiddler.schemas.alert_rule import AlertRuleResp, NotificationConfig
 from fiddler.schemas.filter_query import OperatorType, QueryCondition, QueryRule
@@ -63,6 +63,12 @@ class AlertRule(
 
     @staticmethod
     def _get_url(id_: UUID | str | None = None) -> str:
+        """Get model resource/item url."""
+        url = '/v3/alert-rules'
+        return url if not id_ else f'{url}/{id_}'
+
+    @staticmethod
+    def _get_url_v2(id_: UUID | str | None = None) -> str:
         """Get model resource/item url."""
         url = '/v2/alert-configs'
         return url if not id_ else f'{url}/{id_}'
@@ -78,7 +84,7 @@ class AlertRule(
         instance = cls(
             name=resp_obj.name,
             model_id=resp_obj.model.id,
-            metric_id=resp_obj.metric_id,
+            metric_id=resp_obj.metric.id,
             priority=resp_obj.priority,
             compare_to=resp_obj.compare_to,
             condition=resp_obj.condition,
@@ -113,11 +119,11 @@ class AlertRule(
         # Reset properties
         self.model_id = resp_obj.model.id
         self.project_id = resp_obj.project.id
+        self.metric_id = resp_obj.metric.id
 
         # Add remaining fields
         fields = [
             'id',
-            'metric_id',
             'created_at',
             'updated_at',
         ]
@@ -179,7 +185,9 @@ class AlertRule(
         if columns:
             for column in columns:
                 rules.append(
-                    QueryRule(field='columns', operator=OperatorType.ANY, value=column)
+                    QueryRule(
+                        field='feature_names', operator=OperatorType.ANY, value=column
+                    )
                 )
 
         _filter = QueryCondition(rules=rules)
@@ -188,7 +196,6 @@ class AlertRule(
         if ordering:
             params['ordering'] = ','.join(ordering)
 
-        params['organization_name'] = cls.get_organization_name()
         for rule in cls._paginate(url=cls._get_url(), params=params):
             yield cls._from_dict(data=rule)
 
@@ -202,12 +209,9 @@ class AlertRule(
     @handle_api_error
     def create(self) -> AlertRule:
         """Create a new alert rule."""
-        model = Model.get(self.model_id)
         payload: dict[str, Any] = {
             'name': self.name,
-            'organization_name': self.organization_name,
-            'model_name': model.name,
-            'project_name': model.project.name,
+            'model_id': self.model_id,
             'metric_id': self.metric_id,
             'priority': self.priority,
             'compare_to': self.compare_to,
@@ -218,11 +222,9 @@ class AlertRule(
             'warning_threshold': self.warning_threshold,
             'feature_names': self.columns,
             'compare_bin_delta': self.compare_bin_delta,
-            'notifications': self._get_notifications_dict(),
         }
         if self.baseline_id:
-            baseline = Baseline.get(self.baseline_id)
-            payload['baseline_name'] = baseline.name
+            payload['baseline_id'] = self.baseline_id
 
         response = self._client().post(
             url=self._get_url(),
@@ -236,7 +238,7 @@ class AlertRule(
     def enable_notifications(self) -> None:
         """Enable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url(id_=self.id), data={'enable_notification': True}
+            url=self._get_url_v2(id_=self.id), data={'enable_notification': True}
         )
         logger.info(
             'Notifications have been enabled for alert rule with id: %s', self.id
@@ -246,7 +248,7 @@ class AlertRule(
     def disable_notifications(self) -> None:
         """Disable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url(id_=self.id), data={'enable_notification': False}
+            url=self._get_url_v2(id_=self.id), data={'enable_notification': False}
         )
         logger.info(
             'Notifications have been disabled for alert rule with id: %s', self.id
@@ -277,7 +279,7 @@ class AlertRule(
             webhooks=webhooks,
         )
         response = self._client().patch(
-            url=self._get_url(id_=self.id),
+            url=self._get_url_v2(id_=self.id),
             data={'notifications': notifications},
         )
 
@@ -293,7 +295,7 @@ class AlertRule(
         :return: NotificationConfig object
         """
 
-        response = self._client().get(url=self._get_url(id_=self.id))
+        response = self._client().get(url=self._get_url_v2(id_=self.id))
 
         return self._get_notifications_from_dict(
             response.json()['data']['notifications']

{fiddler_client-3.0.5 → fiddler_client-3.1.0}/fiddler/entities/model.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import builtins
 import typing
+from copy import deepcopy
 from dataclasses import dataclass
 from datetime import datetime
 from functools import cached_property
@@ -32,12 +33,15 @@ from fiddler.schemas.model_spec import ModelSpec
 from fiddler.schemas.model_task_params import ModelTaskParams
 from fiddler.schemas.xai_params import XaiParams
 from fiddler.utils.helpers import raise_not_found
+from fiddler.utils.logger import get_logger
 from fiddler.utils.model_generator import ModelGenerator
 
 if typing.TYPE_CHECKING:
     from fiddler.entities.baseline import Baseline
     from fiddler.entities.dataset import Dataset
 
+logger = get_logger(__name__)
+
 
 class Model(
     BaseEntity,
@@ -52,6 +56,7 @@ class Model(
         project_id: UUID | str,
         schema: ModelSchema,
         spec: ModelSpec,
+        version: str | None = None,
         input_type: str = ModelInputType.TABULAR,
         task: str = ModelTask.NOT_SET,
         task_params: ModelTaskParams | None = None,
@@ -63,6 +68,7 @@ class Model(
     ) -> None:
         """Construct a model instance"""
         self.name = name
+        self.version = version
         self.project_id = project_id
         self.schema = schema
         self.input_type = input_type
@@ -101,6 +107,7 @@ class Model(
         # Initialize
         instance = cls(
             name=resp_obj.name,
+            version=resp_obj.version,
             schema=resp_obj.schema_,
             spec=resp_obj.spec,
             project_id=resp_obj.project.id,
@@ -141,6 +148,7 @@ class Model(
         fields = [
             'id',
             'name',
+            'version',
             'spec',
             'input_type',
             'task',
@@ -188,12 +196,20 @@ class Model(
 
     @classmethod
     @handle_api_error
-    def from_name(cls, name: str, project_id: UUID | str) -> Model:
+    def from_name(
+        cls,
+        name: str,
+        project_id: UUID | str,
+        version: str | None = None,
+        latest: bool = False,
+    ) -> Model:
         """
         Get the model instance from model name within a project.
 
         :param name: Model name
         :param project_id: Project identifier
+        :param version: Version name
+        :param latest: Whether to fetch the latest version of the model or first version
         :return: Model instance
         """
         _filter = QueryCondition(
@@ -207,8 +223,15 @@ class Model(
             ]
         )
 
+        if version:
+            _filter.add_rule(
+                QueryRule(field='version', operator=OperatorType.EQUAL, value=version)
+            )
+
+        ordering = '-created_at' if latest else 'created_at'
         response = cls._client().get(
-            url=cls._get_url(), params={'filter': _filter.json()}
+            url=cls._get_url(),
+            params={'filter': _filter.json(), 'limit': 1, 'ordering': ordering},
         )
 
         if response.json()['data']['total'] == 0:
@@ -219,22 +242,27 @@ class Model(
     @handle_api_error
     def create(self) -> Model:
         """Create a new model."""
+        payload = {
+            'name': self.name,
+            'project_id': str(self.project_id),
+            'schema': self.schema.dict(),
+            'spec': self.spec.dict(),
+            'input_type': self.input_type,
+            'task': self.task,
+            'task_params': self.task_params.dict(),
+            'description': self.description,
+            'event_id_col': self.event_id_col,
+            'event_ts_col': self.event_ts_col,
+            'event_ts_format': self.event_ts_format,
+            'xai_params': self.xai_params.dict(),
+        }
+
+        if self.version:
+            payload['version'] = self.version
+
         response = self._client().post(
             url=self._get_url(),
-            data={
-                'name': self.name,
-                'project_id': str(self.project_id),
-                'schema': self.schema.dict(),
-                'spec': self.spec.dict(),
-                'input_type': self.input_type,
-                'task': self.task,
-                'task_params': self.task_params.dict(),
-                'description': self.description,
-                'event_id_col': self.event_id_col,
-                'event_ts_col': self.event_ts_col,
-                'event_ts_format': self.event_ts_format,
-                'xai_params': self.xai_params.dict(),
-            },
+            data=payload,
         )
         self._refresh_from_response(response=response)
         return self
@@ -243,6 +271,7 @@ class Model(
     def update(self) -> None:
         """Update an existing model."""
         body: dict[str, Any] = {
+            'version': self.version,
             'xai_params': self.xai_params.dict(),
             'description': self.description,
             'event_id_col': self.event_id_col,
@@ -256,13 +285,13 @@ class Model(
     @classmethod
     @handle_api_error
     def list(
-        cls,
-        project_id: UUID | str,
+        cls, project_id: UUID | str, name: str | None = None
     ) -> Iterator[ModelCompact]:
         """
         Get a list of all models with the given filters
 
         :param project_id: Project identifier
+        :param name: Model name, use this for listing all the versions of a model
         :return: ModelCompact iterator
         """
         _filter = QueryCondition(
@@ -273,10 +302,43 @@ class Model(
             ]
         )
 
+        if name:
+            _filter.add_rule(
+                QueryRule(field='name', operator=OperatorType.EQUAL, value=name)
+            )
+
         params = {'filter': _filter.json()}
 
         for model in cls._paginate(url=cls._get_url(), params=params):
-            yield ModelCompact(id=model['id'], name=model['name'])
+            yield ModelCompact(
+                id=model['id'], name=model['name'], version=model['version']
+            )
+
+    def duplicate(self, version: str | None = None) -> Model:
+        """
+        Duplicate the model instance with the given version name.
+
+        This call will not save the model on server. After making changes to the model
+        instance call .create() to add the model version to Fiddler Platform.
+
+        :param version: Version name for the new instance
+        :return: Model instance
+        """
+        return Model(
+            name=self.name,
+            project_id=self.project_id,
+            schema=deepcopy(self.schema),
+            spec=deepcopy(self.spec),
+            version=version if version else self.version,
+            input_type=self.input_type,
+            task=self.task,
+            task_params=deepcopy(self.task_params),
+            description=self.description,
+            event_id_col=self.event_id_col,
+            event_ts_col=self.event_ts_col,
+            event_ts_format=self.event_ts_format,
+            xai_params=deepcopy(self.xai_params),
+        )
 
     @property
     def datasets(self) -> Iterator[Dataset]:
@@ -316,6 +378,7 @@ class Model(
         name: str,
         project_id: UUID | str,
         spec: ModelSpec | None = None,
+        version: str | None = None,
         input_type: str = ModelInputType.TABULAR,
         task: str = ModelTask.NOT_SET,
         task_params: ModelTaskParams | None = None,
@@ -334,6 +397,7 @@ class Model(
         :param name: Model name
         :param project_id: Project identifier
         :param spec: ModelSpec instance
+        :param version: Model version name
         :param input_type: Model input task type
         :param task: Model task like Regression, Binary classification etc.
         :param task_params: Parameters based on the task type
@@ -354,6 +418,7 @@ class Model(
 
         return Model(
             name=name,
+            version=version,
             schema=resp_obj.schema_,
             spec=resp_obj.spec,
             project_id=project_id,
@@ -404,7 +469,7 @@ class Model(
         :return: list[UUID] for list of dicts or dataframe source and Job object for
             file path source.
         """
-
+        logger.info('Model[%s/%s] - Publishing events', self.name, self.version)
         return self._event_publisher.publish(
             source=source,
             environment=environment,
@@ -496,6 +561,7 @@ class Model(
 class ModelCompact:
     id: UUID
     name: str
+    version: str | None = None
 
     def fetch(self) -> Model:
         """Fetch model instance"""
@@ -513,4 +579,8 @@ class ModelCompactMixin:
                 'response.'
             )
 
-        return ModelCompact(id=response.model.id, name=response.model.name)
+        return ModelCompact(
+            id=response.model.id,
+            name=response.model.name,
+            version=response.model.version,
+        )

{fiddler_client-3.0.5 → fiddler_client-3.1.0}/fiddler/schemas/alert_rule.py

@@ -12,25 +12,33 @@ from fiddler.schemas.model import ModelCompactResp
 from fiddler.schemas.project import ProjectCompactResp
 
 
+class MetricResp(BaseModel):
+    id: Union[str, UUID]
+    display_name: str
+    type: str
+    type_display_name: str
+
+
 class AlertRuleResp(BaseModel):
-    id: UUID = Field(alias='uuid')
+    id: UUID
     name: str
-    model: ModelCompactResp
-    project: ProjectCompactResp
-    baseline: Optional[BaselineCompactResp]
-    segment: Optional[SegmentCompactResp]
     priority: Union[str, Priority]
     compare_to: Union[str, CompareTo]
-    metric_id: Union[str, UUID]
-    critical_threshold: float
     condition: Union[str, AlertCondition]
+    compare_bin_delta: Optional[int]
     bin_size: Union[str, BinSize]
     columns: Optional[List[str]] = Field(alias='feature_names')
-    compare_bin_delta: Optional[int]
+    critical_threshold: float
     warning_threshold: Optional[float]
 
     created_at: datetime
-    updated_at: datetime = Field(alias='last_updated')
+    updated_at: datetime
+
+    metric: MetricResp
+    model: ModelCompactResp
+    project: ProjectCompactResp
+    baseline: Optional[BaselineCompactResp]
+    segment: Optional[SegmentCompactResp]
 
 
 class NotificationConfig(BaseModel):

{fiddler_client-3.0.5 → fiddler_client-3.1.0}/fiddler/schemas/model.py

@@ -17,11 +17,13 @@ from fiddler.schemas.xai_params import XaiParams
 class ModelCompactResp(BaseModel):
     id: UUID
     name: str
+    version: Optional[str]
 
 
 class ModelResp(BaseModel):
     id: UUID
     name: str
+    version: str
     input_type: str
     task: str
     task_params: ModelTaskParams