fiddler-client 3.3.1__tar.gz → 3.4.0__tar.gz

{fiddler_client-3.3.1/fiddler_client.egg-info → fiddler_client-3.4.0}/PKG-INFO

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

fiddler_client-3.4.0/fiddler/VERSION

@@ -0,0 +1 @@
+3.4.0

{fiddler_client-3.3.1 → fiddler_client-3.4.0}/fiddler/entities/alert_rule.py

@@ -286,7 +286,7 @@ class AlertRule(
                 pagerduty_services=pagerduty_services,
                 pagerduty_severity=pagerduty_severity,
                 webhooks=webhooks,
-            ).dict()
+            ).dict(exclude_none=True)
         except ValidationError as e:
             logger.exception('Invalid input: The format of input is not correct')
             raise e

{fiddler_client-3.3.1 → fiddler_client-3.4.0}/fiddler/entities/xai.py

@@ -89,44 +89,6 @@ class XaiMixin:
 
         return namedtuple('Explain', response.json()['data'])(**response.json()['data'])
 
-    @handle_api_error
-    def get_fairness(
-        self,
-        data_source: DatasetDataSource | SqlSliceQueryDataSource,
-        protected_features: list[str],
-        positive_outcome: str | int | float | bool,
-        score_threshold: float | None = None,
-    ) -> tuple:
-        """
-        Get fairness analysis on a dataset or a slice.
-
-        :param data_source: DataSource for the input dataset to compute
-            fairness on (DatasetDataSource or SqlSliceQueryDataSource)
-        :param protected_features: list of protected attribute names to compute
-            Fairness analysis on
-        :param positive_outcome: name of the positive outcome to compute
-            Fairness analysis on
-        :param score_threshold: Binary threshold value (between 0 and 1). Default to 0.5
-
-        :return: A named tuple with the fairness results.
-        """
-        self._check_id_attributes()
-
-        payload: dict[str, Any] = {
-            'model_id': self.id,
-            'data_source': data_source.dict(exclude_none=True),
-            'protected_features': protected_features,
-            'positive_outcome': positive_outcome,
-        }
-        if score_threshold:
-            payload['score_threshold'] = score_threshold
-
-        response = self._client().post(url='/v3/analytics/fairness', data=payload)
-
-        return namedtuple('Fairness', response.json()['data'])(
-            **response.json()['data']
-        )
-
     @handle_api_error
     def get_slice(
         self,

{fiddler_client-3.3.1 → fiddler_client-3.4.0}/fiddler/tests/apis/test_alert_rule.py

@@ -1,5 +1,7 @@
 import json
 import logging
+import uuid
+from copy import deepcopy
 from http import HTTPStatus
 from uuid import UUID
 
@@ -24,6 +26,8 @@ from fiddler.tests.constants import (
     PROJECT_ID,
     PROJECT_NAME,
     TEST_EMAILS,
+    TEST_PAGERDUTY_SERVICES,
+    TEST_PAGERDUTY_SEVERITY,
     TEST_WEBHOOKS,
     URL,
 )
@@ -77,8 +81,8 @@ API_RESPONSE_200 = {
 
 ALERT_NOTIFICATION_API_RESPONSE_200 = {
     'data': {
-        'emails': TEST_EMAILS,
-        'webhooks': TEST_WEBHOOKS,
+        'emails': [],
+        'webhooks': [],
         'pagerduty_services': [],
         'pagerduty_severity': '',
     },
@@ -332,30 +336,126 @@ def test_disable_notifications(caplog) -> None:
 
 
 @responses.activate
-def test_set_notifications() -> None:
+def test_set_notifications_email() -> None:
     responses.get(
         url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}',
         json=API_RESPONSE_200,
     )
 
     alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
+    notification_resp = deepcopy(ALERT_NOTIFICATION_API_RESPONSE_200)
+    notification_resp['data']['emails'] = TEST_EMAILS
     resp = responses.patch(
         url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
-        json=ALERT_NOTIFICATION_API_RESPONSE_200,
+        json=notification_resp,
     )
     notifications = alert_rule.set_notification_config(
         emails=TEST_EMAILS,
-        webhooks=TEST_WEBHOOKS,
     )
     assert json.loads(resp.calls[0].request.body) == {
         'emails': TEST_EMAILS,
+    }
+    assert notifications == notification_resp['data']
+
+    # Removing the emails from the notification config
+    notification_resp['data']['emails'] = []
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=notification_resp,
+    )
+    notifications = alert_rule.set_notification_config(
+        emails=[],
+    )
+    assert json.loads(resp.calls[0].request.body) == {
+        'emails': [],
+    }
+    assert notifications == notification_resp['data']
+
+
+@responses.activate
+def test_set_notifications_pagerduty() -> None:
+    responses.get(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}',
+        json=API_RESPONSE_200,
+    )
+
+    alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
+    notification_resp = deepcopy(ALERT_NOTIFICATION_API_RESPONSE_200)
+    notification_resp['data']['pagerduty_services'] = TEST_PAGERDUTY_SERVICES
+    notification_resp['data']['pagerduty_severity'] = TEST_PAGERDUTY_SEVERITY
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=notification_resp,
+    )
+    notifications = alert_rule.set_notification_config(
+        pagerduty_services=TEST_PAGERDUTY_SERVICES,
+        pagerduty_severity=TEST_PAGERDUTY_SEVERITY,
+    )
+
+    assert json.loads(resp.calls[0].request.body) == {
+        'pagerduty_services': TEST_PAGERDUTY_SERVICES,
+        'pagerduty_severity': TEST_PAGERDUTY_SEVERITY,
+    }
+    assert notifications == notification_resp['data']
+
+    # Removing the webhooks from the notification config
+    notification_resp['data']['pagerduty_services'] = []
+    notification_resp['data']['pagerduty_severity'] = ''
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=notification_resp,
+    )
+    notifications = alert_rule.set_notification_config(
+        pagerduty_services=[],
+        pagerduty_severity='',
+    )
+    assert json.loads(resp.calls[0].request.body) == {
+        'pagerduty_services': [],
+        'pagerduty_severity': '',
+    }
+    assert notifications == notification_resp['data']
+
+
+@responses.activate
+def test_set_notifications_webhooks() -> None:
+    responses.get(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}',
+        json=API_RESPONSE_200,
+    )
+
+    alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
+    notification_resp = deepcopy(ALERT_NOTIFICATION_API_RESPONSE_200)
+    notification_resp['data']['webhooks'] = TEST_WEBHOOKS
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=notification_resp,
+    )
+    notifications = alert_rule.set_notification_config(
+        webhooks=TEST_WEBHOOKS,
+    )
+
+    notification_resp['data']['webhooks'] = [
+        uuid.UUID(webhook_uuid)
+        for webhook_uuid in notification_resp['data']['webhooks']
+    ]
+    assert json.loads(resp.calls[0].request.body) == {
         'webhooks': TEST_WEBHOOKS,
-        'pagerduty_services': None,
-        'pagerduty_severity': None,
     }
-    assert notifications == NotificationConfig(
-        **ALERT_NOTIFICATION_API_RESPONSE_200['data']
+    assert notifications == notification_resp['data']
+
+    # Removing the webhooks from the notification config
+    notification_resp['data']['webhooks'] = []
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=notification_resp,
     )
+    notifications = alert_rule.set_notification_config(
+        webhooks=[],
+    )
+    assert json.loads(resp.calls[0].request.body) == {
+        'webhooks': [],
+    }
+    assert notifications == notification_resp['data']
 
 
 @responses.activate

{fiddler_client-3.3.1 → fiddler_client-3.4.0}/fiddler/tests/apis/test_xai.py

@@ -219,104 +219,6 @@ EXPLAIN_RESPONSE_200 = {
     'kind': 'NORMAL',
 }
 
-FAIRNESS_RESPONSE_200 = {
-    'data': {
-        'protected_attributes': ['Gender'],
-        'label_distribution': {
-            'columns': ['Gender', 'data_label', 'count'],
-            'labels': [
-                ['Female', 'Churned', 79],
-                ['Female', 'Not Churned', 377],
-                ['Male', 'Churned', 39],
-                ['Male', 'Not Churned', 505],
-            ],
-        },
-        'model_outcomes': {
-            'columns': ['Gender', 'model_outcome', 'count'],
-            'outcomes': [
-                ['Female', 'Churned', 51],
-                ['Female', 'Not Churned', 405],
-                ['Male', 'Churned', 28],
-                ['Male', 'Not Churned', 516],
-            ],
-        },
-        'technical_metrics': {
-            'columns': [
-                'Gender',
-                'true_positive_rate',
-                'false_positive_rate',
-                'true_negative_rate',
-                'false_negative_rate',
-                'false_omission_rate',
-                'false_discovery_rate',
-            ],
-            'values': [
-                [
-                    'Female',
-                    0.569620253164557,
-                    0.015915119363395226,
-                    0.9840848806366048,
-                    0.43037974683544306,
-                    0.08395061728395062,
-                    0.11764705882352941,
-                ],
-                [
-                    'Male',
-                    0.5897435897435898,
-                    0.009900990099009901,
-                    0.9900990099009901,
-                    0.41025641025641024,
-                    0.031007751937984496,
-                    0.17857142857142858,
-                ],
-            ],
-        },
-        'fairness_metrics': {
-            'demographic_parity': {
-                'index': ['dp'],
-                'columns': ['Female', 'Male'],
-                'data': [[0.1118421052631579, 0.051470588235294115]],
-                'ratio': 0.4602076124567474,
-            },
-            'equal_opportunity': {
-                'index': ['tpr'],
-                'columns': ['Female', 'Male'],
-                'data': [[0.569620253164557, 0.5897435897435898]],
-                'ratio': 0.9658778205833792,
-            },
-            'group_benefit_equality': {
-                'index': ['group_benefit'],
-                'columns': ['Female', 'Male'],
-                'data': [[0.6455696202531646, 0.717948717948718]],
-                'ratio': 0.8991862567811935,
-            },
-            'disparate_impact': {
-                'pairs': [
-                    {
-                        'reference': ['Female'],
-                        'groups': [['Male']],
-                        'values': [0.4602076124567474],
-                    },
-                    {
-                        'reference': ['Male'],
-                        'groups': [['Female']],
-                        'values': [0.4602076124567474],
-                    },
-                ],
-                'absolute_min': {
-                    'groups': [['Female'], ['Male']],
-                    'value': 0.4602076124567474,
-                },
-            },
-        },
-        'model_task': 'BINARY_CLASSIFICATION',
-        'total_samples': 1000,
-        'valid_samples': 1000,
-    },
-    'api_version': '3.0',
-    'kind': 'NORMAL',
-}
-
 FETCH_SLICE_RESPONSE_200 = {
     'data': {
         'metadata': {
@@ -653,30 +555,6 @@ def test_explain() -> None:
     )
 
 
-@responses.activate
-def test_fairness() -> None:
-    responses.get(
-        url=f'{URL}/v3/models/{MODEL_ID}',
-        json=MODEL_API_RESPONSE_200,
-    )
-    model = Model.get(id_=MODEL_ID)
-
-    responses.post(
-        url=f'{URL}/v3/analytics/fairness',
-        json=FAIRNESS_RESPONSE_200,
-    )
-    fairness = model.get_fairness(
-        data_source=DatasetDataSource(
-            env_type='PRODUCTION',
-        ),
-        protected_features=['Gender'],
-        positive_outcome='Churned',
-    )
-    assert fairness == namedtuple('Fairness', FAIRNESS_RESPONSE_200['data'])(
-        **FAIRNESS_RESPONSE_200['data']
-    )
-
-
 @responses.activate
 def test_get_slice() -> None:
     responses.get(

{fiddler_client-3.3.1 → fiddler_client-3.4.0}/fiddler/tests/constants.py

@@ -21,6 +21,8 @@ DATASET_NAME = 'dataset3'
 BASELINE_ID = 'af05646f-0cef-4638-84c9-0d195df2575d'
 ALERT_RULE_ID = 'ed8f18e6-c319-4374-8884-71126a6bab85'
 TEST_EMAILS = ['test@fiddler.ai', 'admin@fiddler.ai']
+TEST_PAGERDUTY_SERVICES = ['service1', 'service2']
+TEST_PAGERDUTY_SEVERITY = 'critical'
 TEST_WEBHOOKS = [
     'e20bf4cc-d2cf-4540-baef-d96913b14f1b',
     '6e796fda-0111-4a72-82cd-f0f219e903e1',

{fiddler_client-3.3.1 → fiddler_client-3.4.0/fiddler_client.egg-info}/PKG-INFO

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

fiddler_client-3.3.1/fiddler/VERSION

@@ -1 +0,0 @@
-3.3.1