fiddler-client 3.0.0.dev9__tar.gz → 3.0.0.dev11__tar.gz

{fiddler-client-3.0.0.dev9/fiddler_client.egg-info → fiddler-client-3.0.0.dev11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 3.0.0.dev9
+Version: 3.0.0.dev11
 Summary: Python client for Fiddler Platform
 Home-page: https://fiddler.ai
 Author: Fiddler Labs

fiddler-client-3.0.0.dev11/fiddler/VERSION

@@ -0,0 +1 @@
+3.0.0-dev11

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from fiddler.connection import Connection, ConnectionMixin, init  # noqa
 from fiddler.constants.alert_rule import (  # noqa
     AlertCondition,
@@ -5,7 +7,7 @@ from fiddler.constants.alert_rule import (  # noqa
     CompareTo,
     Priority,
 )
-from fiddler.constants.baseline import BaselineType, WindowSize  # noqa
+from fiddler.constants.baseline import BaselineType, WindowBinSize  # noqa
 from fiddler.constants.dataset import EnvType  # noqa
 from fiddler.constants.job import JobStatus  # noqa
 from fiddler.constants.model import (  # noqa
@@ -19,14 +21,14 @@ from fiddler.constants.model_deployment import ArtifactType, DeploymentType  # n
 from fiddler.constants.xai import ExplainMethod  # noqa
 from fiddler.entities.alert_record import AlertRecord  # noqa
 from fiddler.entities.alert_rule import AlertRule  # noqa
-from fiddler.entities.baseline import Baseline  # noqa
+from fiddler.entities.baseline import Baseline, BaselineCompact  # noqa
 from fiddler.entities.custom_expression import CustomMetric, Segment  # noqa
-from fiddler.entities.dataset import Dataset  # noqa
+from fiddler.entities.dataset import Dataset, DatasetCompact  # noqa
 from fiddler.entities.file import File  # noqa
 from fiddler.entities.job import Job  # noqa
-from fiddler.entities.model import Model  # noqa
+from fiddler.entities.model import Model, ModelCompact  # noqa
 from fiddler.entities.model_deployment import ModelDeployment  # noqa
-from fiddler.entities.project import Project  # noqa
+from fiddler.entities.project import Project, ProjectCompact  # noqa
 from fiddler.entities.webhook import Webhook  # noqa
 from fiddler.exceptions import (  # noqa
     ApiError,
@@ -62,11 +64,22 @@ from fiddler.schemas.xai_params import XaiParams  # noqa
 from fiddler.utils.logger import set_logging  # noqa
 from fiddler.version import __version__  # noqa
 
+# Global connection object
+conn: Connection | None = None
+
+
+def set_conn(conn_: Connection) -> None:
+    """Set global conn variable"""
+    global conn
+    conn = conn_
+
+
 __all__ = [
     '__version__',
     'Connection',
     'ConnectionMixin',
     'init',
+    'conn',
     # Constants
     'AlertCondition',
     'ArtifactStatus',
@@ -82,7 +95,7 @@ __all__ = [
     'ModelInputType',
     'ModelTask',
     'Priority',
-    'WindowSize',
+    'WindowBinSize',
     # Schemas
     'CustomFeature',
     'DatasetDataSource',
@@ -103,13 +116,17 @@ __all__ = [
     'AlertRecord',
     'AlertRule',
     'Baseline',
+    'BaselineCompact',
     'Dataset',
+    'DatasetCompact',
     'CustomMetric',
     'File',
     'Job',
     'Model',
+    'ModelCompact',
     'ModelDeployment',
     'Project',
+    'ProjectCompact',
     'Segment',
     'Webhook',
     # Exceptions

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/connection.py

@@ -15,9 +15,6 @@ from fiddler.version import __version__
 
 logger = get_logger(__name__)
 
-# Global connection object
-connection: Connection | None = None
-
 
 class Connection:
     def __init__(  # pylint: disable=too-many-arguments
@@ -123,35 +120,37 @@ class Connection:
 
 class ConnectionMixin:
     @classmethod
-    def _connection(cls) -> Connection:
+    def _conn(cls) -> Connection:
         """Fiddler connection instance"""
-        assert connection is not None
-        return connection
+        from fiddler import conn
+
+        assert conn is not None
+        return conn
 
     @classmethod
     def _client(cls) -> RequestClient:
         """Request client instance"""
-        return cls._connection().client
+        return cls._conn().client
 
     @property
     def organization_name(self) -> str:
         """Organization name property"""
-        return self._connection().server_info.organization.name
+        return self._conn().server_info.organization.name
 
     @property
     def organization_id(self) -> UUID:
         """Organization id property"""
-        return self._connection().server_info.organization.id
+        return self._conn().server_info.organization.id
 
     @classmethod
     def get_organization_name(cls) -> str:
         """Organization name"""
-        return cls._connection().server_info.organization.name
+        return cls._conn().server_info.organization.name
 
     @classmethod
     def get_organization_id(cls) -> UUID:
         """Organization id"""
-        return cls._connection().server_info.organization.id
+        return cls._conn().server_info.organization.id
 
 
 def init(  # pylint: disable=too-many-arguments
@@ -173,8 +172,9 @@ def init(  # pylint: disable=too-many-arguments
     :param validate: Whether to validate the server/client version compatibility.
          Some functionalities might not work if this is turned off.
     """
-    global connection  # pylint: disable=global-statement
-    connection = Connection(
+    from fiddler import set_conn
+
+    conn = Connection(
         url=url,
         token=token,
         proxies=proxies,
@@ -182,3 +182,5 @@ def init(  # pylint: disable=too-many-arguments
         verify=verify,
         validate=validate,
     )
+
+    set_conn(conn_=conn)

fiddler-client-3.0.0.dev11/fiddler/constants/baseline.py

@@ -0,0 +1,15 @@
+import enum
+
+
+@enum.unique
+class BaselineType(str, enum.Enum):
+    STATIC = 'STATIC'
+    ROLLING = 'ROLLING'
+
+
+@enum.unique
+class WindowBinSize(str, enum.Enum):
+    HOUR = 'Hour'
+    DAY = 'Day'
+    WEEK = 'Week'
+    MONTH = 'Month'

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/alert_rule.py

@@ -24,7 +24,7 @@ class AlertRule(
     def __init__(  # pylint: disable=too-many-arguments
         self,
         name: str,
-        model_id: UUID,
+        model_id: UUID | str,
         metric_id: str | UUID,
         priority: Priority | str,
         compare_to: CompareTo | str,
@@ -33,7 +33,7 @@ class AlertRule(
         critical_threshold: float,
         warning_threshold: float | None = None,
         columns: list[str] | None = None,
-        baseline_id: UUID | None = None,
+        baseline_id: UUID | str | None = None,
         compare_bin_delta: int | None = None,
     ) -> None:
         """Construct a alert rule instance."""

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/baseline.py

@@ -5,6 +5,7 @@ from datetime import datetime
 from typing import Any, Iterator
 from uuid import UUID
 
+from fiddler.constants.baseline import WindowBinSize
 from fiddler.constants.dataset import EnvType
 from fiddler.decorators import handle_api_error
 from fiddler.entities.base import BaseEntity
@@ -22,14 +23,14 @@ class Baseline(
     def __init__(  # pylint: disable=too-many-arguments
         self,
         name: str,
-        model_id: UUID,
+        model_id: UUID | str,
         environment: EnvType,
         type_: str,
-        dataset_id: UUID | None = None,
+        dataset_id: UUID | str | None = None,
         start_time: int | None = None,
         end_time: int | None = None,
-        offset: int | None = None,
-        window_size: int | None = None,
+        offset_delta: int | None = None,
+        window_bin_size: WindowBinSize | str | None = None,
     ) -> None:
         """Construct a baseline instance."""
         self.name = name
@@ -39,8 +40,8 @@ class Baseline(
         self.dataset_id = dataset_id
         self.start_time = start_time
         self.end_time = end_time
-        self.offset = offset
-        self.window_size = window_size
+        self.offset_delta = offset_delta
+        self.window_bin_size = window_bin_size
 
         self.id: UUID | None = None
         self.row_count: int | None = None
@@ -73,8 +74,8 @@ class Baseline(
             type_=resp_obj.type,
             start_time=resp_obj.start_time,
             end_time=resp_obj.end_time,
-            offset=resp_obj.offset,
-            window_size=resp_obj.window_size,
+            offset_delta=resp_obj.offset_delta,
+            window_bin_size=resp_obj.window_bin_size,
         )
 
         # Add remaining fields
@@ -109,8 +110,8 @@ class Baseline(
             'type',
             'start_time',
             'end_time',
-            'offset',
-            'window_size',
+            'offset_delta',
+            'window_bin_size',
             'created_at',
             'updated_at',
             'row_count',
@@ -134,27 +135,23 @@ class Baseline(
 
     @classmethod
     @handle_api_error
-    def from_name(cls, name: str, model_name: str, project_name: str) -> Baseline:
+    def from_name(cls, name: str, model_id: UUID | str) -> Baseline:
         """
-        Get the baseline instance using baseline name, model name and project name.
+        Get the baseline instance of a model from baseline name
 
         :param name: Baseline name
-        :param model_name: Name of the model associated with the baseline
-        :param project_name: Name of the project associated with the baseline
+        :param model_id: Model identifier
 
-        :return: Baseline instance for the provided params
+        :return: Baseline instance
         """
 
         _filter = QueryCondition(
             rules=[
                 QueryRule(field='name', operator=OperatorType.EQUAL, value=name),
                 QueryRule(
-                    field='project_name',
+                    field='model_id',
                     operator=OperatorType.EQUAL,
-                    value=project_name,
-                ),
-                QueryRule(
-                    field='model_name', operator=OperatorType.EQUAL, value=model_name
+                    value=model_id,
                 ),
             ]
         )
@@ -203,7 +200,7 @@ class Baseline(
     @handle_api_error
     def create(self) -> Baseline:
         """Create a new baseline."""
-        payload = {
+        payload: dict[str, Any] = {
             'name': self.name,
             'model_id': self.model_id,
             'type': self.type,
@@ -214,10 +211,10 @@ class Baseline(
             payload['start_time'] = self.start_time
         if self.end_time:
             payload['end_time'] = self.end_time
-        if self.offset:
-            payload['offset'] = self.offset
-        if self.window_size:
-            payload['window_size'] = self.window_size
+        if self.offset_delta:
+            payload['offset_delta'] = self.offset_delta
+        if self.window_bin_size:
+            payload['window_bin_size'] = self.window_bin_size
 
         response = self._client().post(
             url=self._get_url(),

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/custom_expression.py

@@ -22,7 +22,7 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
     def __init__(
         self,
         name: str,
-        model_id: UUID,
+        model_id: UUID | str,
         definition: str,
         description: str | None = None,
     ) -> None:
@@ -112,15 +112,12 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
 
     @classmethod
     @handle_api_error
-    def from_name(
-        cls, name: str, model_name: str, project_name: str
-    ) -> CustomExpression:
+    def from_name(cls, name: str, model_id: UUID | str) -> CustomExpression:
         """
-        Get the custom metric instance using custom metric name, model name and project name.
+        Get the custom metric instance of a model from custom metric name
 
         :param name: Custom metric name
-        :param model_name: Name of the model associated with the custom metric
-        :param project_name: Name of the project associated with the custom metric
+        :param model_id: Model identifier
 
         :return: CustomMetric instance for the provided params
         """
@@ -129,12 +126,7 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
             rules=[
                 QueryRule(field='name', operator=OperatorType.EQUAL, value=name),
                 QueryRule(
-                    field='model_name', operator=OperatorType.EQUAL, value=model_name
-                ),
-                QueryRule(
-                    field='project_name',
-                    operator=OperatorType.EQUAL,
-                    value=project_name,
+                    field='model_id', operator=OperatorType.EQUAL, value=model_id
                 ),
             ]
         )
@@ -157,7 +149,7 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
     @handle_api_error
     def list(
         cls,
-        model_id: UUID,
+        model_id: UUID | str,
     ) -> Iterator[CustomExpression]:
         """Get a list of all custom metrics in the organization."""
 
@@ -195,7 +187,11 @@ class CustomExpression(BaseEntity, ModelCompactMixin, ProjectCompactMixin):
 
 class CustomMetric(CustomExpression):
     def __init__(
-        self, name: str, model_id: UUID, definition: str, description: str | None = None
+        self,
+        name: str,
+        model_id: UUID | str,
+        definition: str,
+        description: str | None = None,
     ) -> None:
         """Construct a custom metric instance."""
         super().__init__(name, model_id, definition, description)
@@ -214,7 +210,11 @@ class CustomMetric(CustomExpression):
 
 class Segment(CustomExpression):
     def __init__(
-        self, name: str, model_id: UUID, definition: str, description: str | None = None
+        self,
+        name: str,
+        model_id: UUID | str,
+        definition: str,
+        description: str | None = None,
     ) -> None:
         """Construct a segment instance."""
         super().__init__(name, model_id, definition, description)

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/dataset.py

@@ -72,13 +72,12 @@ class Dataset(BaseEntity, ProjectCompactMixin):
 
     @classmethod
     @handle_api_error
-    def from_name(cls, name: str, model_name: str, project_name: str) -> Dataset:
+    def from_name(cls, name: str, model_id: UUID | str) -> Dataset:
         """
         Get the dataset instance using dataset name.
 
         :param name: Dataset name
-        :param model_name: Name of the model associated with the dataset
-        :param project_name: name of the project associated with the dataset
+        :param model_id: Model identifier
 
         :return: Dataset instance for the provided params
         """
@@ -86,12 +85,9 @@ class Dataset(BaseEntity, ProjectCompactMixin):
             rules=[
                 QueryRule(field='name', operator=OperatorType.EQUAL, value=name),
                 QueryRule(
-                    field='project_name',
+                    field='model_id',
                     operator=OperatorType.EQUAL,
-                    value=project_name,
-                ),
-                QueryRule(
-                    field='model_name', operator=OperatorType.EQUAL, value=model_name
+                    value=model_id,
                 ),
             ]
         )

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/model.py

@@ -49,7 +49,7 @@ class Model(
     def __init__(  # pylint: disable=too-many-arguments
         self,
         name: str,
-        project_id: UUID,
+        project_id: UUID | str,
         schema: ModelSchema,
         spec: ModelSpec,
         input_type: str = ModelInputType.TABULAR,
@@ -188,15 +188,21 @@ class Model(
 
     @classmethod
     @handle_api_error
-    def from_name(cls, name: str, project_name: str) -> Model:
-        """Get the model instance using model name and project name."""
+    def from_name(cls, name: str, project_id: UUID | str) -> Model:
+        """
+        Get the model instance from model name within a project.
+
+        :param name: Model name
+        :param project_id: Project identifier
+        :return: Model instance
+        """
         _filter = QueryCondition(
             rules=[
                 QueryRule(field='name', operator=OperatorType.EQUAL, value=name),
                 QueryRule(
-                    field='project_name',
+                    field='project_id',
                     operator=OperatorType.EQUAL,
-                    value=project_name,
+                    value=project_id,
                 ),
             ]
         )
@@ -251,7 +257,7 @@ class Model(
     @handle_api_error
     def list(
         cls,
-        project_id: UUID,
+        project_id: UUID | str,
     ) -> Iterator[ModelCompact]:
         """
         Get a list of all models with the given filters
@@ -308,7 +314,7 @@ class Model(
         cls,
         source: pd.DataFrame | Path | str,
         name: str,
-        project_id: UUID,
+        project_id: UUID | str,
         spec: ModelSpec | None = None,
         input_type: str = ModelInputType.TABULAR,
         task: str = ModelTask.NOT_SET,
@@ -452,7 +458,7 @@ class Model(
 
     def add_surrogate(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
     ) -> Job:
         """
@@ -470,7 +476,7 @@ class Model(
     @handle_api_error
     def update_surrogate(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
     ) -> Job:
         """

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/model_artifact.py

@@ -93,7 +93,7 @@ class ModelArtifact(ConnectionMixin):
 
     def _artifact_deploy(
         self,
-        file_id: UUID,
+        file_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
         update: bool = False,
     ) -> Job:

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/model_deployment.py

@@ -18,7 +18,7 @@ class ModelDeployment(
 ):  # pylint: disable=too-many-instance-attributes
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        model_id: UUID,
+        model_id: UUID | str,
     ) -> None:
         """Construct a model deployment instance."""
         self.id: UUID | None = None  # pylint: disable=invalid-name
@@ -110,7 +110,7 @@ class ModelDeployment(
         self._refresh_from_response(response=response)
 
     @classmethod
-    def of(cls, model_id: UUID) -> ModelDeployment:
+    def of(cls, model_id: UUID | str) -> ModelDeployment:
         """
         Get model deployment instance of the given model
 

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/surrogate.py

@@ -25,7 +25,7 @@ class Surrogate(ConnectionMixin):
 
     def _deploy(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
         update: bool = False,
     ) -> Job:
@@ -71,7 +71,7 @@ class Surrogate(ConnectionMixin):
     @handle_api_error
     def add(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
     ) -> Job:
         """
@@ -89,7 +89,7 @@ class Surrogate(ConnectionMixin):
     @handle_api_error
     def update(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         deployment_params: DeploymentParams | None = None,
     ) -> Job:
         """

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/entities/xai.py

@@ -382,7 +382,7 @@ class XaiMixin:
     @handle_api_error
     def precompute_feature_impact(  # pylint: disable=too-many-arguments
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         num_samples: int | None = None,
         num_iterations: int | None = None,
         num_refs: int | None = None,
@@ -444,7 +444,7 @@ class XaiMixin:
     @handle_api_error
     def precompute_feature_importance(  # pylint: disable=too-many-arguments
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         num_samples: int | None = None,
         num_iterations: int | None = None,
         num_refs: int | None = None,
@@ -528,7 +528,7 @@ class XaiMixin:
     @handle_api_error
     def precompute_predictions(
         self,
-        dataset_id: UUID,
+        dataset_id: UUID | str,
         chunk_size: int | None = None,
         update: bool = False,
     ) -> Job:

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/schemas/baseline.py

@@ -24,8 +24,8 @@ class BaselineResp(BaseModel):
     type: str
     start_time: Optional[int]
     end_time: Optional[int]
-    offset: Optional[int]
-    window_size: Optional[int]
+    offset_delta: Optional[int]
+    window_bin_size: Optional[str]
     row_count: Optional[int]
 
     model: ModelCompactResp

{fiddler-client-3.0.0.dev9 → fiddler-client-3.0.0.dev11}/fiddler/tests/apis/test_baseline.py

@@ -29,8 +29,8 @@ API_RESPONSE_200 = {
         'type': 'STATIC',
         'start_time': None,
         'end_time': None,
-        'offset': None,
-        'window_size': None,
+        'offset_delta': None,
+        'window_bin_size': None,
         'row_count': 20000,
         'model': {
             'id': MODEL_ID,
@@ -80,8 +80,8 @@ LIST_API_RESPONSE = {
                 'type': 'STATIC',
                 'start_time': None,
                 'end_time': None,
-                'offset': None,
-                'window_size': None,
+                'offset_delta': None,
+                'window_bin_size': None,
                 'row_count': 20000,
                 'model': {
                     'id': MODEL_ID,
@@ -160,7 +160,7 @@ def test_get_baseline_not_found() -> None:
 @responses.activate
 def test_baseline_from_name() -> None:
     params = {
-        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "model_id", "operator": "equal", "value": "4531bfd9-2ca2-4a7b-bb5a-136c8da09ca2"}]}'
     }
 
     responses.get(
@@ -170,8 +170,7 @@ def test_baseline_from_name() -> None:
     )
     baseline = Baseline.from_name(
         name=BASELINE_NAME,
-        model_name=MODEL_NAME,
-        project_name=PROJECT_NAME,
+        model_id=MODEL_ID,
     )
     assert isinstance(baseline, Baseline)
 
@@ -184,7 +183,7 @@ def test_baseline_from_name_not_found() -> None:
     resp['data']['items'] = []
 
     params = {
-        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "model_id", "operator": "equal", "value": "4531bfd9-2ca2-4a7b-bb5a-136c8da09ca2"}]}'
     }
 
     responses.get(
@@ -195,8 +194,7 @@ def test_baseline_from_name_not_found() -> None:
     with pytest.raises(NotFound):
         Baseline.from_name(
             name=BASELINE_NAME,
-            model_name=MODEL_NAME,
-            project_name=PROJECT_NAME,
+            model_id=MODEL_ID,
         )