fiddler-client 3.2.0.dev5__tar.gz → 3.3.0.dev1__tar.gz

{fiddler_client-3.2.0.dev5/fiddler_client.egg-info → fiddler_client-3.3.0.dev1}/PKG-INFO

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

fiddler_client-3.3.0.dev1/fiddler/VERSION

@@ -0,0 +1 @@
+3.3.0.dev1

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/entities/alert_rule.py

@@ -65,15 +65,14 @@ class AlertRule(
 
     @staticmethod
     def _get_url(id_: UUID | str | None = None) -> str:
-        """Get model resource/item url."""
+        """Get alert resource url."""
         url = '/v3/alert-rules'
         return url if not id_ else f'{url}/{id_}'
 
     @staticmethod
-    def _get_url_v2(id_: UUID | str | None = None) -> str:
-        """Get model resource/item url."""
-        url = '/v2/alert-configs'
-        return url if not id_ else f'{url}/{id_}'
+    def _get_notification_url(id_: UUID | str | None = None) -> str:
+        """Get alert notification resource url."""
+        return f'/v3/alert-rules/{id_}/notification'
 
     @classmethod
     def _from_dict(cls, data: dict) -> AlertRule:
@@ -243,7 +242,7 @@ class AlertRule(
     def enable_notifications(self) -> None:
         """Enable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url_v2(id_=self.id), data={'enable_notification': True}
+            url=self._get_url(id_=self.id), data={'enable_notification': True}
         )
         logger.info(
             'Notifications have been enabled for alert rule with id: %s', self.id
@@ -253,7 +252,7 @@ class AlertRule(
     def disable_notifications(self) -> None:
         """Disable notifications for an alert rule"""
         self._client().patch(
-            url=self._get_url_v2(id_=self.id), data={'enable_notification': False}
+            url=self._get_url(id_=self.id), data={'enable_notification': False}
         )
         logger.info(
             'Notifications have been disabled for alert rule with id: %s', self.id
@@ -277,20 +276,20 @@ class AlertRule(
 
         :return: NotificationConfig object
         """
-        notifications = self._get_notifications_dict(
-            emails=emails,
-            pagerduty_services=pagerduty_services,
-            pagerduty_severity=pagerduty_severity,
-            webhooks=webhooks,
-        )
+        payload: dict[str, Any] = {}
+        if emails is not None:
+            payload['emails'] = emails
+        if pagerduty_services is not None:
+            payload['pagerduty_services'] = pagerduty_services
+            payload['pagerduty_severity'] = pagerduty_severity
+        if webhooks is not None:
+            payload['webhooks'] = webhooks
         response = self._client().patch(
-            url=self._get_url_v2(id_=self.id),
-            data={'notifications': notifications},
+            url=self._get_notification_url(id_=self.id),
+            data=payload,
         )
 
-        return self._get_notifications_from_dict(
-            response.json()['data']['notifications']
-        )
+        return NotificationConfig(**response.json()['data'])
 
     @handle_api_error
     def get_notification_config(self) -> NotificationConfig:
@@ -300,51 +299,6 @@ class AlertRule(
         :return: NotificationConfig object
         """
 
-        response = self._client().get(url=self._get_url_v2(id_=self.id))
-
-        return self._get_notifications_from_dict(
-            response.json()['data']['notifications']
-        )
-
-    @staticmethod
-    def _get_notifications_from_dict(notif_dict: dict) -> NotificationConfig:
-        emails = notif_dict.get('emails', {}).get('email')
-        notifications: dict = {}
-        if emails:
-            notifications['emails'] = [email.strip() for email in emails.split(',')]
-
-        pd_services = notif_dict.get('pagerduty', {}).get('service')
-        if pd_services:
-            notifications['pagerduty_services'] = [
-                pd_service.strip() for pd_service in pd_services.split(',')
-            ]
-            notifications['pagerduty_severity'] = notif_dict.get('pagerduty', {}).get(
-                'severity'
-            )
+        response = self._client().get(url=self._get_notification_url(id_=self.id))
 
-        if notif_dict.get('webhooks'):
-            notifications['webhooks'] = [
-                webhook['uuid'] for webhook in notif_dict.get('webhooks', [])
-            ]
-
-        return NotificationConfig(**notifications)
-
-    @staticmethod
-    def _get_notifications_dict(
-        emails: builtins.list[str] | None = None,
-        pagerduty_services: builtins.list[str] | None = None,
-        pagerduty_severity: str | None = None,
-        webhooks: builtins.list[UUID] | None = None,
-    ) -> dict:
-        return {
-            'emails': {
-                'email': ','.join(emails) if emails else '',
-            },
-            'pagerduty': {
-                'service': ','.join(pagerduty_services) if pagerduty_services else '',
-                'severity': pagerduty_severity or '',
-            },
-            'webhooks': [{'uuid': webhook_uuid} for webhook_uuid in webhooks]
-            if webhooks
-            else [],
-        }
+        return NotificationConfig(**response.json()['data'])

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/entities/xai.py

@@ -573,3 +573,30 @@ class XaiMixin:
                 'This method is available only for model object generated from '
                 'API response.'
             )
+
+    @handle_api_error
+    def upload_feature_impact(
+        self, feature_impact_map: dict, update: bool = False
+    ) -> dict:
+        """
+        User feature impact method. Currently supported for Tabular models only.
+
+        :param feature_impact_map: Feature impacts dictionary with feature name as key
+                                    and impact as value
+        :param update: Whether the feature impact is being updated or uploaded
+
+        :return: Dictionary with feature_names, feature_impact_scores, system_generated etc
+        """
+        self._check_id_attributes()
+        payload: dict[str, Any] = {
+            'model_id': self.id,
+            'feature_impact_map': feature_impact_map,
+        }
+
+        url = '/v3/analytics/upload-feature-impact'
+
+        http_method = self._get_method(update=update)
+
+        response = http_method(url=url, data=payload)
+
+        return response.json()['data']

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/libs/semver.py

@@ -343,7 +343,7 @@ class VersionInfo:
         )
 
         if len(part) == 1:
-            part = part[0]  # type: ignore
+            part = part[0]
         elif not part:
             raise IndexError('Version part undefined')
         return part

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/tests/apis/test_alert_rule.py

@@ -22,6 +22,8 @@ from fiddler.tests.constants import (
     MODEL_NAME,
     PROJECT_ID,
     PROJECT_NAME,
+    TEST_EMAILS,
+    TEST_WEBHOOKS,
     URL,
 )
 from fiddler.utils.logger import set_logging
@@ -72,70 +74,17 @@ API_RESPONSE_200 = {
     'kind': 'NORMAL',
 }
 
-API_RESPONSE_200_V2 = {
+ALERT_NOTIFICATION_API_RESPONSE_200 = {
     'data': {
-        'id': 794,
-        'organization_name': 'mainbuild',
-        'project_name': PROJECT_NAME,
-        'model_id': 285,
-        'name': 'test_rule',
-        'metric': 'jsd',
-        'metric_id': 'jsd',
-        'metric_display_name': 'Jensen-Shannon Distance',
-        'alert_type': 'drift',
-        'alert_type_display_name': 'Data Drift',
-        'priority': 'MEDIUM',
-        'baseline_name': BASELINE_NAME,
-        'feature_names': ['creditscore'],
-        'time_bucket': 3600000,
-        'category': None,
-        'bin_size': 'Hour',
-        'compare_to': 'raw_value',
-        'condition': 'greater',
-        'compare_period': None,
-        'warning_threshold': 1.0,
-        'critical_threshold': 2.3,
-        'is_active': True,
-        'created_by': 'admin@fiddler.ai',
-        'created_at': '2024-04-23T10:34:14.321895+00:00',
-        'last_updated': '2024-04-23T10:34:14.323554+00:00',
-        'model_name': 'bank_churn',
-        'enable_notification': True,
-        'segment': {
-            'id': '1c9b551a-808b-4ef0-b67b-e788eaf1e6de',
-            'organization_name': 'mainbuild',
-            'project_name': 'nick_test_project_11',
-            'model_name': 'bank_churn',
-            'name': 'xyzab',
-            'definition': 'Age > 10',
-            'description': 'meh',
-            'created_at': '2024-04-23T10:31:52.181550+00:00',
-            'created_by': {
-                'id': 1,
-                'full_name': 'Fiddler Administrator',
-                'email': 'admin@fiddler.ai',
-            },
-        },
-        'project': {'id': PROJECT_ID, 'name': PROJECT_NAME},
-        'model': {'id': MODEL_ID, 'name': MODEL_NAME, 'version': 'v1'},
-        'baseline': {'id': BASELINE_ID, 'name': BASELINE_NAME},
-        'compare_bin_delta': None,
-        'uuid': ALERT_RULE_ID,
-        'notifications': {
-            'pagerduty': {
-                'alert_config_uuid': ALERT_RULE_ID,
-                'service': '',
-                'severity': '',
-            },
-            'emails': {'email': ''},
-            'webhooks': [],
-        },
+        'emails': TEST_EMAILS,
+        'webhooks': TEST_WEBHOOKS,
+        'pagerduty_services': [],
+        'pagerduty_severity': '',
     },
-    'api_version': '2.0',
+    'api_version': '3.0',
     'kind': 'NORMAL',
 }
 
-
 API_RESPONSE_404 = {
     'error': {
         'code': 404,
@@ -343,8 +292,8 @@ def test_enable_notifications(caplog) -> None:
     alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
 
     resp = responses.patch(
-        url=f'{URL}/v2/alert-configs/{ALERT_RULE_ID}',
-        json=API_RESPONSE_200_V2,
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}',
+        json=API_RESPONSE_200,
     )
     set_logging(logging.INFO)
 
@@ -368,8 +317,8 @@ def test_disable_notifications(caplog) -> None:
     API_RESPONSE_200['enable_notification'] = False
 
     resp = responses.patch(
-        url=f'{URL}/v2/alert-configs/{ALERT_RULE_ID}',
-        json=API_RESPONSE_200_V2,
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}',
+        json=API_RESPONSE_200,
     )
 
     set_logging(logging.INFO)
@@ -389,40 +338,20 @@ def test_set_notifications() -> None:
     )
 
     alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
-    API_RESPONSE_200_V2['data']['notifications'] = {
-        'webhooks': [
-            {'uuid': 'e20bf4cc-d2cf-4540-baef-d96913b14f1b'},
-            {'uuid': '6e796fda-0111-4a72-82cd-f0f219e903e1'},
-        ],
-        'emails': {
-            'alert_config_uuid': ALERT_RULE_ID,
-            'email': 'nikhil@fiddler.ai, admin@fiddler.ai',
-        },
-        'pagerduty': {
-            'service': '',
-            'alert_config_uuid': ALERT_RULE_ID,
-            'severity': '',
-        },
-    }
-    responses.patch(
-        url=f'{URL}/v2/alert-configs/{ALERT_RULE_ID}',
-        json=API_RESPONSE_200_V2,
+    resp = responses.patch(
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=ALERT_NOTIFICATION_API_RESPONSE_200,
     )
     notifications = alert_rule.set_notification_config(
-        emails=['nikhil@fiddler.ai', 'admin@fiddler.ai'],
-        webhooks=[
-            'e20bf4cc-d2cf-4540-baef-d96913b14f1b',
-            '6e796fda-0111-4a72-82cd-f0f219e903e1',
-        ],
+        emails=TEST_EMAILS,
+        webhooks=TEST_WEBHOOKS,
     )
+    assert json.loads(resp.calls[0].request.body) == {
+        'emails': TEST_EMAILS,
+        'webhooks': TEST_WEBHOOKS,
+    }
     assert notifications == NotificationConfig(
-        **{
-            'emails': ['nikhil@fiddler.ai', 'admin@fiddler.ai'],
-            'webhooks': [
-                'e20bf4cc-d2cf-4540-baef-d96913b14f1b',
-                '6e796fda-0111-4a72-82cd-f0f219e903e1',
-            ],
-        }
+        **ALERT_NOTIFICATION_API_RESPONSE_200['data']
     )
 
 
@@ -435,16 +364,10 @@ def test_get_notifications() -> None:
 
     alert_rule = AlertRule.get(id_=ALERT_RULE_ID)
     responses.get(
-        url=f'{URL}/v2/alert-configs/{ALERT_RULE_ID}',
-        json=API_RESPONSE_200_V2,
+        url=f'{URL}/v3/alert-rules/{ALERT_RULE_ID}/notification',
+        json=ALERT_NOTIFICATION_API_RESPONSE_200,
     )
     notifications = alert_rule.get_notification_config()
     assert notifications == NotificationConfig(
-        **{
-            'emails': ['nikhil@fiddler.ai', 'admin@fiddler.ai'],
-            'webhooks': [
-                'e20bf4cc-d2cf-4540-baef-d96913b14f1b',
-                '6e796fda-0111-4a72-82cd-f0f219e903e1',
-            ],
-        }
+        **ALERT_NOTIFICATION_API_RESPONSE_200['data']
     )

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/tests/apis/test_xai.py

@@ -544,6 +544,41 @@ PRECOMPUTE_FEATURE_IMPORTANCE_JOB_API_RESPONSE_200 = {
     },
 }
 
+USER_FEATURE_IMPACT_RESPONSE_200 = {
+    'data': {
+        'feature_names': [
+            'creditscore',
+            'geography',
+            'gender',
+            'age',
+            'tenure',
+            'balance',
+            'numofproducts',
+            'hascrcard',
+            'isactivemember',
+            'estimatedsalary',
+        ],
+        'feature_impact_scores': [
+            0.011580908964862443,
+            0.006309520155042726,
+            0.007567492652213872,
+            0.00477455398879517,
+            0.00026155170582271506,
+            0.0,
+            0.0032795830224845025,
+            0.000988697882581393,
+            0.0,
+            0.0022799670889706025,
+        ],
+        'system_generated': False,
+        'model_task': 'BINARY_CLASSIFICATION',
+        'model_input_type': 'TABULAR',
+        'created_at': '2024-06-26 09:34:13.120418+00:00',
+    },
+    'api_version': '3.0',
+    'kind': 'NORMAL',
+}
+
 PRECOMPUTE_PREDICTIONS_202_RESPONSE = {
     'data': {'job': {'id': JOB_ID, 'name': 'Pre-compute predictions'}},
     'api_version': '3.0',
@@ -568,6 +603,19 @@ PRECOMPUTE_PREDICTIONS_JOB_API_RESPONSE_200 = {
     },
 }
 
+FEATURE_IMPACT_MAP = {
+    'creditscore': 0.011580908964862443,
+    'geography': 0.006309520155042726,
+    'gender': 0.007567492652213872,
+    'age': 0.00477455398879517,
+    'tenure': 0.00026155170582271506,
+    'balance': 0.0,
+    'numofproducts': 0.0032795830224845025,
+    'hascrcard': 0.000988697882581393,
+    'isactivemember': 0.0,
+    'estimatedsalary': 0.0022799670889706025,
+}
+
 
 @responses.activate
 def test_explain() -> None:
@@ -937,3 +985,39 @@ def test_update_precompute_predictions() -> None:
 
     job_obj = model.precompute_predictions(dataset_id=DATASET_ID, update=True)
     assert isinstance(job_obj, Job)
+
+
+@responses.activate
+def test_upload_feature_impact() -> 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/upload-feature-impact',
+        json=USER_FEATURE_IMPACT_RESPONSE_200,
+    )
+    assert (
+        model.upload_feature_impact(feature_impact_map=FEATURE_IMPACT_MAP)
+        == USER_FEATURE_IMPACT_RESPONSE_200['data']
+    )
+
+
+@responses.activate
+def test_update_feature_impact() -> None:
+    responses.get(
+        url=f'{URL}/v3/models/{MODEL_ID}',
+        json=MODEL_API_RESPONSE_200,
+    )
+    model = Model.get(id_=MODEL_ID)
+
+    responses.put(
+        url=f'{URL}/v3/analytics/upload-feature-impact',
+        json=USER_FEATURE_IMPACT_RESPONSE_200,
+    )
+    assert (
+        model.upload_feature_impact(feature_impact_map=FEATURE_IMPACT_MAP, update=True)
+        == USER_FEATURE_IMPACT_RESPONSE_200['data']
+    )

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1}/fiddler/tests/constants.py

@@ -20,6 +20,11 @@ DATASET_ID = 'ba6ec4e4-7188-44c5-ba84-c2cb22b4bb00'
 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_WEBHOOKS = [
+    'e20bf4cc-d2cf-4540-baef-d96913b14f1b',
+    '6e796fda-0111-4a72-82cd-f0f219e903e1',
+]
 BASELINE_NAME = 'test_baseline'
 MODEL_DEPLOYMENT_ID = 'fc07562a-1a27-4f66-9154-732d3b14b98a'
 WEBHOOK_ID = 'a5b654eb-15c8-43c8-9d50-9ba6eea9a0ff'

{fiddler_client-3.2.0.dev5 → fiddler_client-3.3.0.dev1/fiddler_client.egg-info}/PKG-INFO

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

fiddler_client-3.2.0.dev5/fiddler/VERSION

@@ -1 +0,0 @@
-3.2.0.dev5