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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 2.1.0.dev3
+Version: 2.1.0.dev4
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -31,6 +31,7 @@ Description: Fiddler Client
          - #### **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.4
           - #### **Modifications**

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

@@ -24,6 +24,7 @@ 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.4
   - #### **Modifications**

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

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

{fiddler-client-2.1.0.dev3 → fiddler-client-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-client-2.1.0.dev4/fiddler/schema/custom_metric.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 2.1.0.dev3
+Version: 2.1.0.dev4
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -31,6 +31,7 @@ Description: Fiddler Client
          - #### **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.4
           - #### **Modifications**

{fiddler-client-2.1.0.dev3 → fiddler-client-2.1.0.dev4}/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)

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

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

fiddler-client-2.1.0.dev3/fiddler/schema/custom_metric.py

@@ -1,10 +0,0 @@
-from fiddler.schema.base import BaseDataSchema
-
-
-class CustomMetric(BaseDataSchema):
-    id: str
-    name: str
-    project_name: str
-    organization_name: str
-    name: str
-    fql: str