fiddler-client 3.0.0.dev15__tar.gz → 3.0.1__tar.gz

{fiddler-client-3.0.0.dev15/fiddler_client.egg-info → fiddler-client-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 3.0.0.dev15
+Version: 3.0.1
 Summary: Python client for Fiddler Platform
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -29,16 +29,16 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.6.3 and pip >= 19.0
+Requires Python >= Python-3.8.0 and pip >= 21.0
 
 Installation
 ------------
 
-    $ pip3 install fiddler-client
+    $ pip3 install "fiddler-client==3.0.*"
 
 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).
+Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-client-3x). 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
 -------------

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1}/PUBLIC.md

@@ -6,16 +6,16 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.6.3 and pip >= 19.0
+Requires Python >= Python-3.8.0 and pip >= 21.0
 
 Installation
 ------------
 
-    $ pip3 install fiddler-client
+    $ pip3 install "fiddler-client==3.0.*"
 
 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).
+Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-client-3x). 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
 -------------

fiddler-client-3.0.1/fiddler/VERSION

@@ -0,0 +1 @@
+3.0.1

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1}/fiddler/entities/alert_rule.py

@@ -34,6 +34,7 @@ class AlertRule(
         warning_threshold: float | None = None,
         columns: list[str] | None = None,
         baseline_id: UUID | str | None = None,
+        segment_id: UUID | str | None = None,
         compare_bin_delta: int | None = None,
     ) -> None:
         """Construct a alert rule instance."""
@@ -49,6 +50,7 @@ class AlertRule(
         self.critical_threshold = critical_threshold
         self.condition = condition
         self.bin_size = bin_size
+        self.segment_id = segment_id
 
         self.id: UUID | None = None
         self.project_id: UUID | None = None
@@ -84,7 +86,8 @@ class AlertRule(
             critical_threshold=resp_obj.critical_threshold,
             warning_threshold=resp_obj.warning_threshold,
             columns=resp_obj.columns,
-            baseline_id=resp_obj.baseline_id,
+            baseline_id=resp_obj.baseline.id if resp_obj.baseline else None,
+            segment_id=resp_obj.segment.id if resp_obj.segment else None,
             compare_bin_delta=resp_obj.compare_bin_delta,
         )
 
@@ -210,6 +213,7 @@ class AlertRule(
             'compare_to': self.compare_to,
             'condition': self.condition,
             'bin_size': self.bin_size,
+            'segment_id': self.segment_id,
             'critical_threshold': self.critical_threshold,
             'warning_threshold': self.warning_threshold,
             'feature_names': self.columns,

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1}/fiddler/schemas/alert_rule.py

@@ -7,6 +7,7 @@ from pydantic import Field
 from fiddler.constants.alert_rule import AlertCondition, BinSize, CompareTo, Priority
 from fiddler.schemas.base import BaseModel
 from fiddler.schemas.baseline import BaselineCompactResp
+from fiddler.schemas.custom_expression import SegmentCompactResp
 from fiddler.schemas.model import ModelCompactResp
 from fiddler.schemas.project import ProjectCompactResp
 
@@ -17,14 +18,14 @@ class AlertRuleResp(BaseModel):
     model: ModelCompactResp
     project: ProjectCompactResp
     baseline: Optional[BaselineCompactResp]
+    segment: Optional[SegmentCompactResp]
     priority: Union[str, Priority]
     compare_to: Union[str, CompareTo]
     metric_id: Union[str, UUID]
     critical_threshold: float
     condition: Union[str, AlertCondition]
     bin_size: Union[str, BinSize]
-    columns: Optional[List[str]]
-    baseline_id: Optional[UUID]
+    columns: Optional[List[str]] = Field(alias='feature_names')
     compare_bin_delta: Optional[int]
     warning_threshold: Optional[float]
 

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1}/fiddler/schemas/custom_expression.py

@@ -29,3 +29,10 @@ class CustomMetricResp(CustomExpressionResp):
 
 class SegmentResp(CustomExpressionResp):
     """Segment response object"""
+
+
+class SegmentCompactResp(BaseModel):
+    """Segment compact response object"""
+
+    id: UUID
+    name: str

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1}/fiddler/tests/apis/test_alert_rule.py

@@ -28,54 +28,61 @@ from fiddler.utils.logger import set_logging
 
 API_RESPONSE_200 = {
     'data': {
-        'feature_names': ['age'],
-        'id': 620,
-        'created_at': '2023-11-28T08:04:12.651937+00:00',
+        'id': 794,
         'organization_name': 'mainbuild',
-        'compare_period': None,
-        'time_bucket': 3600000,
-        'alert_type': 'data_integrity',
-        'metric_display_name': 'Missing Value Violation',
-        'enable_notification': True,
-        'last_updated': '2023-11-28T08:04:12.653346+00:00',
-        'alert_type_display_name': 'Data Integrity',
-        'critical_threshold': 0.0,
+        '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,
-        'baseline': {
-            'id': BASELINE_ID,
-            'name': BASELINE_NAME,
-        },
+        'feature_names': ['creditscore'],
+        'time_bucket': 3600000,
+        'category': None,
+        'bin_size': 'Hour',
+        'compare_to': 'raw_value',
         'condition': 'greater',
-        'uuid': ALERT_RULE_ID,
-        'segment': None,
-        'warning_threshold': None,
-        'name': 'Age Missing 1 Hr',
-        'model_name': MODEL_NAME,
-        'model': {
-            'id': MODEL_ID,
-            'name': MODEL_NAME,
-        },
+        'compare_period': None,
+        'warning_threshold': 1.0,
+        'critical_threshold': 2.3,
         'is_active': True,
         'created_by': 'admin@fiddler.ai',
-        'bin_size': 'Hour',
-        'category': None,
-        'project_name': PROJECT_NAME,
-        'project': {
-            'id': PROJECT_ID,
-            'name': PROJECT_NAME,
+        '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',
+            },
         },
-        'metric': 'null_violation_count',
-        'metric_id': 'null_violation_count',
-        'compare_to': 'raw_value',
-        'priority': 'HIGH',
+        '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': {
-            'emails': {'alert_config_uuid': ALERT_RULE_ID, 'email': 'admin@fiddler.ai'},
             'pagerduty': {
-                'severity': '',
                 'alert_config_uuid': ALERT_RULE_ID,
                 'service': '',
+                'severity': '',
             },
-            'webhooks': [{'uuid': 'e20bf4cc-d2cf-4540-baef-d96913b14f1b'}],
+            'emails': {'email': ''},
+            'webhooks': [],
         },
     },
     'api_version': '2.0',

{fiddler-client-3.0.0.dev15 → fiddler-client-3.0.1/fiddler_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 3.0.0.dev15
+Version: 3.0.1
 Summary: Python client for Fiddler Platform
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -29,16 +29,16 @@ publishing for use with our monitoring features.
 
 Requirements
 ------------
-Requires Python >= Python-3.6.3 and pip >= 19.0
+Requires Python >= Python-3.8.0 and pip >= 21.0
 
 Installation
 ------------
 
-    $ pip3 install fiddler-client
+    $ pip3 install "fiddler-client==3.0.*"
 
 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).
+Documentation for the API can be found [here](https://docs.fiddler.ai/reference/about-client-3x). 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
 -------------

fiddler-client-3.0.0.dev15/fiddler/VERSION

@@ -1 +0,0 @@
-3.0.0.dev15