fiddler-client 3.1.0.dev1__tar.gz → 3.1.0.dev2__tar.gz

fiddler-client-3.1.0.dev2/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: fiddler-client
+Version: 3.1.0.dev2
+Summary: Python client for Fiddler Platform
+Home-page: https://fiddler.ai
+Author: Fiddler Labs
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: pip>=21.0
+Requires-Dist: requests<3
+Requires-Dist: requests-toolbelt
+Requires-Dist: pandas>=1.2.5
+Requires-Dist: pydantic<2,>=1.9.0
+Requires-Dist: deprecated==1.2.13
+Requires-Dist: tqdm
+Requires-Dist: simplejson>=3.17.0
+Requires-Dist: pyarrow>=7.0.0
+Requires-Dist: pyyaml
+
+Fiddler Client
+=============
+
+Python client for interacting with Fiddler. Provides a user-friendly interface to our REST API and enables event
+publishing for use with our monitoring features.
+
+Requirements
+------------
+Requires Python >= Python-3.6.3 and pip >= 19.0
+
+Installation
+------------
+
+    $ pip3 install fiddler-client
+
+API Example Usage
+-------------
+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
+-------------
+Version history is available on [Fiddler documentation page](https://docs.fiddler.ai/page/python-client-version-history).

fiddler-client-3.1.0.dev2/PUBLIC.md

@@ -0,0 +1,22 @@
+Fiddler Client
+=============
+
+Python client for interacting with Fiddler. Provides a user-friendly interface to our REST API and enables event
+publishing for use with our monitoring features.
+
+Requirements
+------------
+Requires Python >= Python-3.6.3 and pip >= 19.0
+
+Installation
+------------
+
+    $ pip3 install fiddler-client
+
+API Example Usage
+-------------
+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
+-------------
+Version history is available on [Fiddler documentation page](https://docs.fiddler.ai/page/python-client-version-history).

fiddler-client-3.1.0.dev2/fiddler/VERSION

@@ -0,0 +1 @@
+3.1.0.dev2

{fiddler-client-3.1.0.dev1 → fiddler-client-3.1.0.dev2}/fiddler/entities/model.py

@@ -548,6 +548,7 @@ class Model(
 class ModelCompact:
     id: UUID
     name: str
+    version: str | None = None
 
     def fetch(self) -> Model:
         """Fetch model instance"""
@@ -565,4 +566,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.1.0.dev1 → fiddler-client-3.1.0.dev2}/fiddler/schemas/custom_features.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional, Type, TypeVar
+from typing import Any, Dict, List, Optional, Type, TypeVar, Literal
 
 from pydantic import BaseModel, validator
 
@@ -10,18 +10,12 @@ CustomFeatureTypeVar = TypeVar('CustomFeatureTypeVar', bound='CustomFeature')
 
 class CustomFeature(BaseModel):
     name: str
-    type: CustomFeatureType
-    n_clusters: Optional[int] = DEFAULT_NUM_CLUSTERS
-    centroids: Optional[List] = None
-
-    @validator('n_clusters')
-    def validate_n_clusters(cls, value: int) -> int:  # noqa: N805
-        if value < 0:
-            raise ValueError('n_clusters must be greater than 0')
-        return value
+    type: Any
 
     class Config:
         allow_mutation = False
+        use_enum_values = True
+        discriminator = 'type'
 
     @classmethod
     def from_columns(
@@ -53,12 +47,13 @@ class CustomFeature(BaseModel):
         return_dict: Dict[str, Any] = {
             'name': self.name,
             'type': self.type.value,
-            'n_clusters': self.n_clusters,
         }
         if isinstance(self, Multivariate):
             return_dict['columns'] = self.columns
+            return_dict['n_clusters'] = self.n_clusters
         elif isinstance(self, VectorFeature):
             return_dict['column'] = self.column
+            return_dict['n_clusters'] = self.n_clusters
             if isinstance(self, (ImageEmbedding, TextEmbedding)):
                 return_dict['source_column'] = self.source_column
                 if isinstance(self, TextEmbedding):
@@ -74,7 +69,9 @@ class CustomFeature(BaseModel):
 
 
 class Multivariate(CustomFeature):
-    type: CustomFeatureType = CustomFeatureType.FROM_COLUMNS
+    type: Literal['FROM_COLUMNS'] = CustomFeatureType.FROM_COLUMNS.value
+    n_clusters: Optional[int] = DEFAULT_NUM_CLUSTERS
+    centroids: Optional[List] = None
     columns: List[str]
     monitor_components: bool = False
 
@@ -84,22 +81,31 @@ class Multivariate(CustomFeature):
             raise ValueError('Multivariate columns must be greater than 1')
         return value
 
+    @validator('n_clusters')
+    def validate_n_clusters(cls, value: int) -> int:  # noqa: N805
+        if value < 0:
+            raise ValueError('n_clusters must be greater than 0')
+        return value
+
 
 class VectorFeature(CustomFeature):
-    type: CustomFeatureType = CustomFeatureType.FROM_VECTOR
-    source_column: Optional[str] = None
+    type: Literal['FROM_VECTOR'] = CustomFeatureType.FROM_VECTOR.value
+    n_clusters: Optional[int] = DEFAULT_NUM_CLUSTERS
+    centroids: Optional[List] = None
     column: str
 
+    @validator('n_clusters')
+    def validate_n_clusters(cls, value: int) -> int:  # noqa: N805
+        if value < 0:
+            raise ValueError('n_clusters must be greater than 0')
+        return value
+
 
 class TextEmbedding(VectorFeature):
-    type: CustomFeatureType = CustomFeatureType.FROM_TEXT_EMBEDDING
+    type: Literal['FROM_TEXT_EMBEDDING'] = CustomFeatureType.FROM_TEXT_EMBEDDING.value  # type: ignore
+    source_column: str
     n_tags: Optional[int] = DEFAULT_NUM_TAGS
-
-    @validator('source_column')
-    def validate_source_column(cls, value: str) -> str:  # noqa: N805
-        if value is None:
-            raise ValueError('source_column must be specified')
-        return value
+    tf_idf: Optional[Dict[str, List]] = None
 
     @validator('n_tags')
     def validate_n_tags(cls, value: int) -> int:  # noqa: N805
@@ -109,13 +115,8 @@ class TextEmbedding(VectorFeature):
 
 
 class ImageEmbedding(VectorFeature):
-    type: CustomFeatureType = CustomFeatureType.FROM_IMAGE_EMBEDDING
-
-    @validator('source_column')
-    def validate_source_column(cls, value: str) -> str:  # noqa: N805
-        if value is None:
-            raise ValueError('source_column must be specified')
-        return value
+    type: Literal['FROM_IMAGE_EMBEDDING'] = CustomFeatureType.FROM_IMAGE_EMBEDDING.value  # type: ignore
+    source_column: str
 
 
 class Enrichment(CustomFeature):
@@ -134,7 +135,7 @@ class Enrichment(CustomFeature):
     """
 
     # Setting the feature type to ENRICHMENT
-    type: CustomFeatureType = CustomFeatureType.ENRICHMENT
+    type: Literal['ENRICHMENT'] = CustomFeatureType.ENRICHMENT.value
 
     # List of input column names used to generate the enrichment
     columns: List[str]

{fiddler-client-3.1.0.dev1 → fiddler-client-3.1.0.dev2}/fiddler/schemas/model.py

@@ -17,6 +17,7 @@ from fiddler.schemas.xai_params import XaiParams
 class ModelCompactResp(BaseModel):
     id: UUID
     name: str
+    version: Optional[str]
 
 
 class ModelResp(BaseModel):

fiddler-client-3.1.0.dev2/fiddler/schemas/model_spec.py

@@ -0,0 +1,32 @@
+from typing import List, Union
+
+from pydantic import BaseModel, Field
+
+from fiddler.schemas.custom_features import Multivariate, VectorFeature, TextEmbedding, ImageEmbedding, Enrichment
+
+
+class ModelSpec(BaseModel):
+    """Model spec defines how model columns are used along with model task"""
+
+    schema_version: int = 1
+    """Schema version"""
+
+    inputs: List[str] = Field(default_factory=list)
+    """Feature columns"""
+
+    outputs: List[str] = Field(default_factory=list)
+    """Prediction columns"""
+
+    targets: List[str] = Field(default_factory=list)
+    """Label columns"""
+
+    decisions: List[str] = Field(default_factory=list)
+    """Decisions columns"""
+
+    metadata: List[str] = Field(default_factory=list)
+    """Metadata columns"""
+
+    custom_features: List[Union[Multivariate, VectorFeature, TextEmbedding, ImageEmbedding, Enrichment]] = Field(
+        default_factory=list
+    )
+    """Custom feature definitions"""

{fiddler-client-3.1.0.dev1 → fiddler-client-3.1.0.dev2}/fiddler/tests/apis/test_mixin.py

@@ -20,6 +20,7 @@ from fiddler.tests.constants import (
     DATASET_NAME,
     MODEL_ID,
     MODEL_NAME,
+    MODEL_VERSION,
     PROJECT_ID,
     PROJECT_NAME,
     USER_EMAIL,
@@ -39,7 +40,9 @@ class DummyEntity(
     def __init__(self) -> None:
         self._resp = mock.MagicMock()
         self._resp.project = ProjectCompactResp(id=PROJECT_ID, name=PROJECT_NAME)
-        self._resp.model = ModelCompactResp(id=MODEL_ID, name=MODEL_NAME)
+        self._resp.model = ModelCompactResp(
+            id=MODEL_ID, name=MODEL_NAME, version=MODEL_VERSION
+        )
         self._resp.dataset = DatasetCompactResp(
             id=DATASET_ID, name=DATASET_NAME, type=EnvType.PRE_PRODUCTION
         )

fiddler-client-3.1.0.dev2/fiddler_client.egg-info/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: fiddler-client
+Version: 3.1.0.dev2
+Summary: Python client for Fiddler Platform
+Home-page: https://fiddler.ai
+Author: Fiddler Labs
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >3.8.0
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: pip>=21.0
+Requires-Dist: requests<3
+Requires-Dist: requests-toolbelt
+Requires-Dist: pandas>=1.2.5
+Requires-Dist: pydantic<2,>=1.9.0
+Requires-Dist: deprecated==1.2.13
+Requires-Dist: tqdm
+Requires-Dist: simplejson>=3.17.0
+Requires-Dist: pyarrow>=7.0.0
+Requires-Dist: pyyaml
+
+Fiddler Client
+=============
+
+Python client for interacting with Fiddler. Provides a user-friendly interface to our REST API and enables event
+publishing for use with our monitoring features.
+
+Requirements
+------------
+Requires Python >= Python-3.6.3 and pip >= 19.0
+
+Installation
+------------
+
+    $ pip3 install fiddler-client
+
+API Example Usage
+-------------
+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
+-------------
+Version history is available on [Fiddler documentation page](https://docs.fiddler.ai/page/python-client-version-history).