fiddler-client 2.1.0.dev2__py3-none-any.whl → 2.1.0.dev4__py3-none-any.whl

fiddler/_version.py

@@ -1 +1 @@
-__version__ = '2.1.0.dev2'
+__version__ = '2.1.0.dev4'

fiddler/api/custom_metrics_mixin.py

@@ -1,5 +1,5 @@
 from http import HTTPStatus
-from typing import List
+from typing import List, Optional
 
 from pydantic import parse_obj_as
 
@@ -22,7 +22,12 @@ class CustomMetricsMixin:
 
     @handle_api_error_response
     def add_custom_metric(
-        self, name: str, project_id: str, model_id: str, fql: str
+        self,
+        name: str,
+        project_id: str,
+        model_id: str,
+        definition: str,
+        description: Optional[str] = None,
     ) -> CustomMetric:
         """
         Add a new `Custom Metric`.
@@ -30,7 +35,8 @@ class CustomMetricsMixin:
         :params name: name of custom metric
         :params project_id: name of project
         :params model_id: name of model
-        :params fql: The FQL expression describing the metric
+        :params definition: The FQL expression describing the metric
+        :params description: description of custom metric
 
         :returns: Created `CustomMetric` object.
         """
@@ -39,7 +45,8 @@ class CustomMetricsMixin:
             'project_name': project_id,
             'model_name': model_id,
             'name': name,
-            'fql': fql,
+            'definition': definition,
+            'description': description,
         }
         response = self.client.post(
             url='custom-metrics',
@@ -51,7 +58,7 @@ class CustomMetricsMixin:
         return CustomMetric.parse_obj(attrs)
 
     @handle_api_error_response
-    def delete_custom_metric(self, metric_id: str = None) -> None:
+    def delete_custom_metric(self, metric_id: str) -> None:
         """
         Delete a custom metric
 
@@ -95,3 +102,15 @@ class CustomMetricsMixin:
         )
         items = PaginatedResponseHandler(response).get_pagination_items()
         return parse_obj_as(List[CustomMetric], items)
+
+    @handle_api_error_response
+    def get_custom_metric(self, metric_id: str) -> CustomMetric:
+        """
+        Get a `CustomMetric` object.
+
+        :params metric_id: id of the custom metric
+
+        :returns: a `CustomMetric` object
+        """
+        response = self.client.get(url=f'custom-metrics/{metric_id}')
+        return CustomMetric.deserialize(APIResponseHandler(response))

fiddler/schema/custom_metric.py

@@ -1,4 +1,8 @@
+from typing import Optional
+
 from fiddler.schema.base import BaseDataSchema
+from fiddler.schema.user import UserCompact
+from datetime import datetime
 
 
 class CustomMetric(BaseDataSchema):
@@ -7,4 +11,8 @@ class CustomMetric(BaseDataSchema):
     project_name: str
     organization_name: str
     name: str
-    fql: str
+    definition: str
+    description: Optional[str]
+    created_at: Optional[datetime]
+    created_by: Optional[UserCompact]
+

{fiddler_client-2.1.0.dev2.dist-info → fiddler_client-2.1.0.dev4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 2.1.0.dev2
+Version: 2.1.0.dev4
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -14,7 +14,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: deprecated (==1.2.13)
 Requires-Dist: pandas (>=1.2.5)
 Requires-Dist: pip (>=21.0)
-Requires-Dist: pyarrow (>=12.0.1)
+Requires-Dist: pyarrow (>=13.0.0)
 Requires-Dist: pydantic (==1.9.0)
 Requires-Dist: pyyaml
 Requires-Dist: requests-toolbelt
@@ -48,8 +48,22 @@ Version History
  - #### **New Features**
   - Introduce Model Tasks `NOT_SET` and `LLM`
   - Relax Target / Output specification for model tasks `NOT_SET` and `LLM`
+  - Support custom metrics
 
-### 2.0.0
+### 2.0.4
+  - #### **Modifications**
+    - Update `pyarrow` requirement to `13.0.0`.
+
+### 2.0.3
+  - #### **Modifications**
+    - Relax pandas version for 2.0.
+    - get_slice() `query` parameter reverted to `sql_query`
+
+### 2.0.2
+  - #### **Modifications**
+    - Fix Parquet conversion issue in `upload_dataset` and `publish_event_batch`
+
+### 2.0.1
   - #### **Removed**
     - Following methods are removed
       - register_model
@@ -66,16 +80,24 @@ Version History
       - process_avro
       - process_csv
   - #### **New Features**
-    - Add `monitor_components` as an attribute of `CustomFeature`. Default to `False`
+    - Add `monitor_components` as an attribute for `CustomFeature` of type `FROM_COLUMNS`. Default as `False`
+    - Adds new statistic type `SUM` to supported alert metrics
+    - Support `CustomFeature` of type `FROM_VECTOR` `FROM_TEXT_EMBEDDING` and `FROM_IMAGE_EMBEDDING`
+  - #### **Modificatiosn**
     - Remove `column` as a parameter in `add_alert_rule` and `get_alert_rules` functions
-    - Adds new statistic type SUM to supported alert metrics
+    - Default `FileType` Parquet in `upload_dataset` and `publish_event_batch`
+    - get_slice() `sql_query` parameter changed to `query`
+
+### 1.8.6
+ - #### **Modifications**
+  - Relax pandas version for 2.0.
 
 ### 1.8.4
  - #### **New Features**
-  - New DeploymentType enum for MANUAL deployment
+  - New DeploymentType enum for `MANUAL` deployment
 
 ### 1.8.3
- - ### **Modifications**
+ - #### **Modifications**
   - New `columns` parameter in add_alert_rule and get_alert_rules to support multiple columns to be used for server version >= 23.3.0
   - get_triggered_alerts supports `alert_value` as a float as well as a dict
 

{fiddler_client-2.1.0.dev2.dist-info → fiddler_client-2.1.0.dev4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 fiddler/__init__.py,sha256=N0S2NzC1P0Dl7SE9IRRzJpSDvyyqT9Pmlk2SaW24NGc,2018
-fiddler/_version.py,sha256=wNJAWxZJ5nqnvr7CcRnjak-Pcnydu3AaK30sXJNnIZU,27
+fiddler/_version.py,sha256=RShHDU6VmHiby-18I-reafFfkORbcfCW2afHTL4C6MY,27
 fiddler/constants.py,sha256=kXJX771B9UoQKh-umPnPfDXGeCRdC8TmTAi40hSK0Cs,1886
 fiddler/core_objects.py,sha256=Qe8wxak6tfn9rpIb7jdN5tXYpUJs_sJHPMGf9cDg6MU,114079
 fiddler/exceptions.py,sha256=vjdZ0v51NAy_pPcj_MaD4o5y-lUToHeids-waTfZb8k,2557
@@ -7,7 +7,7 @@ fiddler/api/__init__.py,sha256=Na9WlUxg8FmKHBzzVJ-CzlYNm7-LClVH5f313SqJx4A,108
 fiddler/api/alert_mixin.py,sha256=lBc08-wcvF3bO_XdcVSXqmgR9i54UtKwUCn56brokCw,17873
 fiddler/api/api.py,sha256=pR5eE7Vq5OWGom8MZmZkkU2bmVOznJ45jiB4pwnXd6g,3506
 fiddler/api/baseline_mixin.py,sha256=2DKur2oIrn0TNTQPbpwSMyC1WOzhScHXWwX8QK8ubig,6810
-fiddler/api/custom_metrics_mixin.py,sha256=S5TIg4BW-CZecYbJDKyMS3EuPJj9edG3aype5TF-bHE,2861
+fiddler/api/custom_metrics_mixin.py,sha256=7fpZx_4jSzhELbU1TYyvgDqP8NUMg62NWqlgRwKjkDQ,3459
 fiddler/api/dataset_mixin.py,sha256=cN5GfOTX5uOKzmvxHj-uLuv049EI_BQqhJ6uw1VX-7o,15319
 fiddler/api/events_mixin.py,sha256=RiKwS-EDE0SJKS-rgYd13Bav1wStyM0r29FA0WHi48I,22009
 fiddler/api/explainability_mixin.py,sha256=W2GLDfSYaxe06VS9_ZGQmPfFzkwPcWtrt5JIyJ23ZxY,15405
@@ -32,7 +32,7 @@ fiddler/schema/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fiddler/schema/alert.py,sha256=aC96q5nDBVuR4nqPbWSgQ0nLRgGLtyCmnGerbLwfsFE,5230
 fiddler/schema/base.py,sha256=VvuBEGZ_AMVQhT6AlkV7kMlOQcwsMbLIjvX0_cyMcQQ,359
 fiddler/schema/baseline.py,sha256=h8SyR32L1AMo2DrcwgEOqWN-U538-XFngjAtQQfMklI,487
-fiddler/schema/custom_metric.py,sha256=u-RNI33YB6lWR8arQ1yO7Bw_5sw72sVkZkQvLscORUc,187
+fiddler/schema/custom_metric.py,sha256=bLoOVoF6nRMLLv5cekTTalGXHm1KOZRzNMpYp7c81gs,402
 fiddler/schema/dataset.py,sha256=JVeLXyqlEgiqYVX7fVkk0bLzXSRkKSTuoAsK3tnvR-s,3259
 fiddler/schema/events.py,sha256=QvCuXWH-quT-MVzMU8-CvQM2rRgNcvGAof4v_RiiqZk,879
 fiddler/schema/job.py,sha256=mDQ3ZevsFT2ZW1wri9BeQSiB7G4ZyoA_3tzuoBvl5ow,157
@@ -72,7 +72,7 @@ tests/fiddler/test_alert.py,sha256=vM8MRsTsV9zovFiUYN2pXwEcH453EN2HHIoGV_i7cx4,5
 tests/fiddler/test_baseline.py,sha256=V7VFg2hqAC98cdZCsoqcNcKouDlQdHMdpifqcwJyYOM,10077
 tests/fiddler/test_check_version_decorator.py,sha256=MGcrIX7nscVpIYy1thuLrSvsXBC6KDXfdsHCEST5Xnw,906
 tests/fiddler/test_custom_features.py,sha256=yjz-5Aq_Ey7FoDJiIzugLPcbh_5QdazE6trwpT38rEw,3028
-tests/fiddler/test_custom_metrics.py,sha256=aXS0jLkO3MT-DUw040-iJjfZkLthSNr3orpIiQOvpXw,5039
+tests/fiddler/test_custom_metrics.py,sha256=txNS-RTltdAublF0xWhkS_YOgdu-C6AxRKubFpYR8ds,8103
 tests/fiddler/test_dataset_api.py,sha256=XrSsyhJubBUKEjl6qHSDBE9_-VnHOCgiL0Mq12IZav0,6306
 tests/fiddler/test_events_api.py,sha256=l41OGatQzNCc95qvLXOpcQ0r7IPRw-N1Uw_bEkRZhf0,11770
 tests/fiddler/test_exceptions.py,sha256=3dUe85gqf8MVxEM_9D1wrNRU8jvmu1-ja36jaDKgOQk,2801
@@ -91,8 +91,8 @@ tests/fiddler/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 tests/fiddler/utils/test_general_checks.py,sha256=kxG8n4UdBWXBGchA0SvV7o4t28a7YAc8viorEBpzzcE,1451
 tests/fiddler/utils/test_pandas.py,sha256=ihNRe9mCteqeV70o-zWEf62fJHL3qE8nDIijYlUEHv4,8825
 tests/fiddler/utils/tests_utils.py,sha256=kPmMoOlaSIWw6Gk7QnAnn8QJvEyqtd2Rz32kS6RGEc8,1800
-fiddler_client-2.1.0.dev2.dist-info/LICENSE.txt,sha256=w8-LUAb_VLBWSsCNmih0pAqLIicJfGu8OJXpDjkIg_o,559
-fiddler_client-2.1.0.dev2.dist-info/METADATA,sha256=0p9S-QYPUpqiHYNtIw089F-SWJPVnlk8zEMwDN1bdz8,18143
-fiddler_client-2.1.0.dev2.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
-fiddler_client-2.1.0.dev2.dist-info/top_level.txt,sha256=GdJimrE4Q9O20-dA6QljDHm5KBrlz25oQTdbMHu41So,14
-fiddler_client-2.1.0.dev2.dist-info/RECORD,,
+fiddler_client-2.1.0.dev4.dist-info/LICENSE.txt,sha256=w8-LUAb_VLBWSsCNmih0pAqLIicJfGu8OJXpDjkIg_o,559
+fiddler_client-2.1.0.dev4.dist-info/METADATA,sha256=BSvVWbPFKm9zuQkffazhM26k4SjqfeX5jMfxuhKJ2zQ,18875
+fiddler_client-2.1.0.dev4.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
+fiddler_client-2.1.0.dev4.dist-info/top_level.txt,sha256=GdJimrE4Q9O20-dA6QljDHm5KBrlz25oQTdbMHu41So,14
+fiddler_client-2.1.0.dev4.dist-info/RECORD,,

tests/fiddler/test_custom_metrics.py

@@ -27,17 +27,32 @@ class TestCustomMetric(BaseTestCase):
                         "project_name": "bank_churn",
                         "name": "tp_0.8",
                         "model_name": "churn_classifier",
-                        "fql": "sum(age)",
+                        "definition": "sum(age)",
                         "id": "fbba0596-1d49-4159-a5ea-e1c2f57c9c32",
-                        "organization_name": "test_organization"
+                        "organization_name": "test_organization",
+                        "description": "test description",
+                        "extra_field_from_future": "should_not_break",
+                        "created_at": "2021-03-03T18:30:00.000Z",
+                        "created_by": {
+                            "id": "1",
+                            "full_name": "test user",
+                            "email": "testuser@fiddler.ai"
+                        }
                     },
                     {
                         "project_name": "bank_churn",
                         "name": "tp_0.6",
                         "model_name": "churn_classifier",
-                        "fql": "sum(credit_score)",
+                        "definition": "sum(credit_score)",
                         "id": "3a352397-a89a-495d-a095-440f1d21a58a",
-                        "organization_name": "test_organization"
+                        "organization_name": "test_organization",
+                        "description": "test description",
+                        "created_at": "2021-03-03T18:30:00.000Z",
+                        "created_by": {
+                            "id": "2",
+                            "full_name": "test user",
+                            "email": "testuser@fiddler.ai"
+                        }
                     }
                 ]
             },
@@ -65,18 +80,32 @@ class TestCustomMetric(BaseTestCase):
             CustomMetric(
                 id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
                 name='tp_0.8',
-                fql='sum(age)',
+                definition='sum(age)',
                 organization_name='test_organization',
                 project_name='bank_churn',
                 model_name='churn_classifier',
+                description='test description',
+                created_at='2021-03-03T18:30:00.000Z',
+                created_by={
+                    "id": "1",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
             ),
             CustomMetric(
                 id='3a352397-a89a-495d-a095-440f1d21a58a',
                 name='tp_0.6',
-                fql='sum(credit_score)',
+                definition='sum(credit_score)',
                 organization_name='test_organization',
                 project_name='bank_churn',
                 model_name='churn_classifier',
+                description='test description',
+                created_at='2021-03-03T18:30:00.000Z',
+                created_by={
+                    "id": "2",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
             ),
         ]
 
@@ -95,17 +124,19 @@ class TestCustomMetric(BaseTestCase):
 
         custom_metric = self.client.add_custom_metric(
             name='my custom',
-            fql='sum(age)',
+            definition='sum(age)',
             project_id='bank_churn',
             model_id='churn_classifier',
+            description='test description',
         )
         assert custom_metric == CustomMetric(
             id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
             name='my custom',
-            fql='sum(age)',
+            definition='sum(age)',
             organization_name='test_organization',
             project_name='bank_churn',
             model_name='churn_classifier',
+            description='test description',
         )
 
     def test_add_custom_metric_error(self):
@@ -131,7 +162,7 @@ class TestCustomMetric(BaseTestCase):
         with self.assertRaises(BadRequest) as context:
             self.client.add_custom_metric(
                 name='my custom',
-                fql='sum(unknown)',
+                definition='sum(unknown)',
                 project_id='bank_churn',
                 model_id='churn_classifier',
             )
@@ -140,6 +171,50 @@ class TestCustomMetric(BaseTestCase):
             "Column unknown not found in model churn_classifier"
         )
 
+    def test_get_custom_metric(self):
+        uuid = 'fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        response = {
+            "data": {
+                "project_name": "bank_churn",
+                "name": "tp_0.8",
+                "model_name": "churn_classifier",
+                "definition": "sum(age)",
+                "id": "fbba0596-1d49-4159-a5ea-e1c2f57c9c32",
+                "organization_name": "test_organization",
+                "description": "test description",
+                "extra_field_from_future": "should_not_break",
+                "created_at": "2021-03-03T18:30:00.000Z",
+                "created_by": {
+                    "id": "1",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
+            },
+            "api_version": "2.0",
+            "kind": "NORMAL"
+        }
+        url = self._get_url(uuid)
+
+        self.requests_mock.get(url, json=response)
+        cm = self.client.get_custom_metric(
+            metric_id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        )
+        assert cm == CustomMetric(
+            id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
+            name='tp_0.8',
+            definition='sum(age)',
+            organization_name='test_organization',
+            project_name='bank_churn',
+            model_name='churn_classifier',
+            description='test description',
+            created_at='2021-03-03T18:30:00.000Z',
+            created_by={
+                "id": "1",
+                "full_name": "test user",
+                "email": "testuser@fiddler.ai"
+            }
+        )
+
     def test_delete_custom_metric(self):
         uuid = 'fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
         url = self._get_url(uuid)