fiddler-client 1.8.3.dev1__tar.gz → 2.0.0__tar.gz

{fiddler-client-1.8.3.dev1 → fiddler-client-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 1.8.3.dev1
+Version: 2.0.0
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -26,6 +26,27 @@ Description: Fiddler Client
         
         Version History
         -------------
+        
+        ### 2.0.0
+          - #### **Removed**
+            - Following methods are removed
+              - register_model
+              - upload_model_package
+              - update_model
+              - trigger_pre_computation
+              - _trigger_model_predictions
+              - generate_sample_events
+              - list_teams
+              - list_project_roles
+              - list_org_roles
+              - unshare_project
+              - share_project
+              - process_avro
+              - process_csv
+          - #### **New Features**
+            - Add `monitor_components` as an attribute of `CustomFeature`. Default to `False`
+            - Remove `column` as a parameter in `add_alert_rule` and `get_alert_rules` functions
+        
         ### 1.8.4
          - #### **New Features**
           - New DeploymentType enum for MANUAL deployment
@@ -38,20 +59,22 @@ Description: Fiddler Client
         ### 1.8.2
           - #### **Modifications**
             - Fixed a bug where `min` and `max` for columns of type `float` in `dataset_info` are cast into `int` after uploaded
+        
         ### 1.8.1
           - #### **Modifications**
-            - Fixed a bug wherein null string was going in request body if body wasn't specified
+            - Fixed a bug wherein null string was going in request body if body wasn't specified.
             - Fix `categorical_target_class_details` when passed as an array
             - Fix a bug where `fdl.ModelInputType.TEXT` were not being accepted properly
             - Fix `categorical_target_class_details` when passed as an empty list
         
+        
         ### 1.8.0
           - #### **Modifications**
-            - Add new alert type - `statistic` for setting alerts
+            - Add new alert type -  `statistic` for setting alerts
             - Add `target_class_order` as a required field of `ModelInfo` object when `model_task` is `MULTICLASS_CLASSIFICATION`,
               `RANKING` or `BINARY_CLASSIFICATION`. Only applies for `BINARY_CLASSIFICATION` when target column is of type `CATEGORY`
-            - CURRENT_DATA_TYPE_VERSION increased to v1
-            - removed type conversion of possible_values
+            - Add `columns` as a parameter in `add_alert_rule` and `get_alert_rules` functions
+            - Add deprecation warning for `column` as a parameter in `add_alert_rule` and `get_alert_rules` functions
         
         ### 1.7.4
           - #### **Modification**
@@ -97,7 +120,7 @@ Description: Fiddler Client
         
         ### 1.5.2
           - #### **Modifications**
-            - Adds fix for self signed certificate not working by adding verify param to FiddlerApi
+            - Add fix for self signed certificate not working by adding verify param to FiddlerApi
         
         ### 1.5.1
           - #### **Modifications**

{fiddler-client-1.8.3.dev1 → fiddler-client-2.0.0}/PUBLIC.md

@@ -19,6 +19,27 @@ Documentation for the API can be found [here](https://docs.fiddler.ai/reference/
 
 Version History
 -------------
+
+### 2.0.0
+  - #### **Removed**
+    - Following methods are removed
+      - register_model
+      - upload_model_package
+      - update_model
+      - trigger_pre_computation
+      - _trigger_model_predictions
+      - generate_sample_events
+      - list_teams
+      - list_project_roles
+      - list_org_roles
+      - unshare_project
+      - share_project
+      - process_avro
+      - process_csv
+  - #### **New Features**
+    - Add `monitor_components` as an attribute of `CustomFeature`. Default to `False`
+    - Remove `column` as a parameter in `add_alert_rule` and `get_alert_rules` functions
+
 ### 1.8.4
  - #### **New Features**
   - New DeploymentType enum for MANUAL deployment
@@ -31,20 +52,22 @@ Version History
 ### 1.8.2
   - #### **Modifications**
     - Fixed a bug where `min` and `max` for columns of type `float` in `dataset_info` are cast into `int` after uploaded
+
 ### 1.8.1
   - #### **Modifications**
-    - Fixed a bug wherein null string was going in request body if body wasn't specified
+    - Fixed a bug wherein null string was going in request body if body wasn't specified.
     - Fix `categorical_target_class_details` when passed as an array
     - Fix a bug where `fdl.ModelInputType.TEXT` were not being accepted properly
     - Fix `categorical_target_class_details` when passed as an empty list
 
+
 ### 1.8.0
   - #### **Modifications**
-    - Add new alert type - `statistic` for setting alerts
+    - Add new alert type -  `statistic` for setting alerts
     - Add `target_class_order` as a required field of `ModelInfo` object when `model_task` is `MULTICLASS_CLASSIFICATION`,
       `RANKING` or `BINARY_CLASSIFICATION`. Only applies for `BINARY_CLASSIFICATION` when target column is of type `CATEGORY`
-    - CURRENT_DATA_TYPE_VERSION increased to v1
-    - removed type conversion of possible_values
+    - Add `columns` as a parameter in `add_alert_rule` and `get_alert_rules` functions
+    - Add deprecation warning for `column` as a parameter in `add_alert_rule` and `get_alert_rules` functions
 
 ### 1.7.4
   - #### **Modification**
@@ -90,7 +113,7 @@ Version History
 
 ### 1.5.2
   - #### **Modifications**
-    - Adds fix for self signed certificate not working by adding verify param to FiddlerApi
+    - Add fix for self signed certificate not working by adding verify param to FiddlerApi
 
 ### 1.5.1
   - #### **Modifications**

fiddler-client-2.0.0/fiddler/__init__.py

@@ -0,0 +1,90 @@
+"""
+Fiddler Client Module
+=====================
+
+A Python client for Fiddler service.
+
+TODO: Add Licence.
+"""
+
+from fiddler import utils
+from fiddler._version import __version__
+from fiddler.api import FiddlerApi, FiddlerClient
+from fiddler.api.explainability_mixin import (
+    DatasetDataSource,
+    RowDataSource,
+    SqlSliceQueryDataSource,
+)
+from fiddler.constants import CSV_EXTENSION
+from fiddler.core_objects import (
+    ArtifactStatus,
+    BaselineType,
+    BatchPublishType,
+    Column,
+    DatasetInfo,
+    DataType,
+    ExplanationMethod,
+    FiddlerPublishSchema,
+    FiddlerTimestamp,
+    ModelInfo,
+    ModelInputType,
+    ModelTask,
+    WeightingParams,
+    WindowSize,
+)
+from fiddler.packtools import gem
+from fiddler.schema.alert import (
+    AlertCondition,
+    AlertType,
+    BinSize,
+    ComparePeriod,
+    CompareTo,
+    Metric,
+    Priority,
+)
+from fiddler.schema.model_deployment import DeploymentParams, DeploymentType
+from fiddler.schemas.custom_features import CustomFeature, ImageEmbedding, Multivariate, TextEmbedding, VectorFeature, CustomFeatureType
+from fiddler.utils import ColorLogger, logger
+from fiddler.utils.validator import (
+    PackageValidator,
+    ValidationChainSettings,
+    ValidationModule,
+)
+
+logger = logger.get_logger(__name__)
+
+SUPPORTED_API_VERSIONS = ['v2']
+
+
+__all__ = [
+    '__version__',
+    'BatchPublishType',
+    'Column',
+    'CustomFeature',
+    'CustomFeatureType',
+    'Multivariate',
+    'VectorFeature',
+    'TextEmbedding',
+    'ImageEmbedding',
+    'ColorLogger',
+    'DatasetInfo',
+    'DataType',
+    'DeploymentParams',
+    'DeploymentType',
+    'FiddlerClient',
+    'FiddlerApi',
+    'FiddlerTimestamp',
+    'FiddlerPublishSchema',
+    'gem',
+    'ModelInfo',
+    'ModelInputType',
+    'ModelTask',
+    'WeightingParams',
+    'ExplanationMethod',
+    'PackageValidator',
+    'ValidationChainSettings',
+    'ValidationModule',
+    'utils',
+    # Exposing constants
+    'CSV_EXTENSION',
+]

fiddler-client-2.0.0/fiddler/_version.py

@@ -0,0 +1 @@
+__version__ = '2.0.0'

fiddler-client-2.0.0/fiddler/api/__init__.py

@@ -0,0 +1,7 @@
+from fiddler.api.api import FiddlerApi, FiddlerClient
+
+__all__ = [
+    'FiddlerClient',
+    'FiddlerApi',
+
+]

{fiddler-client-1.8.3.dev1/fiddler/v2 → fiddler-client-2.0.0/fiddler}/api/alert_mixin.py

@@ -1,12 +1,13 @@
+from __future__ import annotations
+
 import json
 from datetime import datetime, timedelta
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List, Optional, Union
 
 from pydantic import parse_obj_as
 
 from fiddler.libs.http_client import RequestClient
-from fiddler.utils import logging
-from fiddler.v2.schema.alert import (
+from fiddler.schema.alert import (
     AlertCondition,
     AlertRule,
     AlertRulePayload,
@@ -18,20 +19,21 @@ from fiddler.v2.schema.alert import (
     Priority,
     TriggeredAlerts,
 )
-from fiddler.v2.utils.exceptions import handle_api_error_response
-from fiddler.v2.utils.helpers import match_semvar
-from fiddler.v2.utils.response_handler import (
+from fiddler.utils.decorators import handle_api_error_response
+from fiddler.utils.helpers import match_semver
+from fiddler.utils.logger import get_logger
+from fiddler.utils.response_handler import (
     APIResponseHandler,
     PaginatedResponseHandler,
 )
 
-logger = logging.getLogger(__name__)
+logger = get_logger(__name__)
 
 
 class AlertMixin:
     FILTER_ALERT_RULES_API_VERSION = '>=23.1.0'
     GROUP_OF_COLUMNS_API_VERSION = '>=23.3.0'
-    GROUP_OF_COLUMNS_LIST_API_VERSION = '>=23.4.0'
+    RULE_V3_API_VERSION = '>=23.4.0'
 
     client: RequestClient
     organization_name: str
@@ -40,35 +42,37 @@ class AlertMixin:
     def add_alert_rule(
         self,
         name: str,
-        project_id: str,
-        model_id: str,
-        alert_type: AlertType,
-        metric: Metric,
+        metric: Union[Metric, str],
         compare_to: CompareTo,
         priority: Priority,
         critical_threshold: float,
         condition: AlertCondition,
+        project_id: str = None,
+        model_id: str = None,
         bin_size: BinSize = BinSize.ONE_DAY,
+        alert_type: Optional[AlertType] = None,
         baseline_id: Optional[str] = None,
         compare_period: Optional[ComparePeriod] = None,
         column: Optional[str] = None,
         columns: Optional[List[str]] = None,
         warning_threshold: Optional[float] = None,
-        notifications_config: Optional[Dict[str, Dict[str, Any]]] = None,
+        notifications_config: Optional[Dict[str, Any]] = None,
     ) -> AlertRule:
-        """
+        f"""
         To add an alert rule
+
+        :param project_id: Unique project name for which the alert rule is created
+        :param model_id: Unique model name for which the alert rule is created
         :param project_id: Unique project name for which the alert rule is created
         :param model_id: Unique model name for which the alert rule is created
         :param name: Name of the Alert rule
-        :param alert_type: Selects one of the four metric types:
-                1) AlertType.PERFORMANCE
-                2) AlertType.DATA_DRIFT
-                3) AlertType.DATA_INTEGRITY
-                4) AlertType.SERVICE_METRICS
-
-
-        :param metric: "metric":
+        :param alert_type: [DEPRECATED] Used only for older server versions. For {self.RULE_V3_API_VERSION} you can simply use 'metric'.
+            Selects one of the four metric types:
+                    1) AlertType.PERFORMANCE
+                    2) AlertType.DATA_DRIFT
+                    3) AlertType.DATA_INTEGRITY
+                    4) AlertType.SERVICE_METRICS
+        :param metric: can be a string or MetricType enum.
                 For service_metrics:
                 1) MetricType.TRAFFIC
 
@@ -114,12 +118,10 @@ class AlertMixin:
         :param condition: Select from:
                 1) AlertCondition.LESSER
                 2) AlertCondition.GREATER
-        :param column: column name on which alert rule is to be created. It can take '__ANY__' to check for all columns
-            Supported by server version 23.2.0 or lower.
-        :param columns: List of column names on which alert rule is to be created. It can take ['__ANY__'] to check for all columns.
-            Supported by server version 23.3.0 onwards.
+        :param column: column name on which alert rule is to be created. Supported by server version 23.3.0 or lower.
+        :param columns: List of column names on which alert rule is to be created. It can take ['__ANY__'] to check for all columns
         :param notifications_config: notifications config object created using helper method build_notifications_config()
-        :param baseline_id: Name of the baselne, whose histogram is compared against the same derived from current data.
+        :param baseline_id: Name of the baseline, whose histogram is compared against the same derived from current data.
                             Used only when alert type is AlertType.DATA_DRIFT.
         :return: created alert rule object
         """
@@ -143,6 +145,7 @@ class AlertMixin:
             name=name,
             alert_type=alert_type,
             metric=metric,
+            metric_id=metric,
             compare_to=compare_to,
             compare_period=compare_period,
             priority=priority,
@@ -150,27 +153,44 @@ class AlertMixin:
             warning_threshold=warning_threshold,
             critical_threshold=critical_threshold,
             condition=condition,
-            time_bucket=bin_size,
+            time_bucket=bin_size.value[0],
+            bin_size=bin_size.value[1],
             notifications=notifications_config,
         )
-        if match_semvar(self.server_info.server_version, self.GROUP_OF_COLUMNS_API_VERSION):
+
+        if columns and not match_semver(
+            self.server_info.server_version, self.GROUP_OF_COLUMNS_API_VERSION
+        ):
+            raise ValueError(
+                f'columns parameter works with server version {self.GROUP_OF_COLUMNS_API_VERSION}'
+            )
+
+        if match_semver(
+            self.server_info.server_version, self.GROUP_OF_COLUMNS_API_VERSION
+        ):
             if columns:
-                if match_semvar(self.server_info.server_version, self.GROUP_OF_COLUMNS_LIST_API_VERSION):
-                    alert_rule_payload.feature_names=columns
+                if match_semver(
+                    self.server_info.server_version, self.RULE_V3_API_VERSION
+                ):
+                    alert_rule_payload.feature_names = columns
                 else:
                     # version 23.3 support columns is comma separated string
-                    alert_rule_payload.feature_names=",".join(columns)
+                    alert_rule_payload.feature_names = ",".join(columns)
             elif column:
-                if match_semvar(self.server_info.server_version, self.GROUP_OF_COLUMNS_LIST_API_VERSION):
-                    alert_rule_payload.feature_names=[column]
+                if match_semver(
+                    self.server_info.server_version, self.RULE_V3_API_VERSION
+                ):
+                    alert_rule_payload.feature_names = [column]
                 else:
-                    alert_rule_payload.feature_names=column
+                    alert_rule_payload.feature_names = column
         else:
             # we do not support columns in server version < 23.3
             if columns:
-                raise ValueError(f'columns is not supported in the server version {self.server_info.server_version}. Please use column instead.')
+                raise ValueError(
+                    f'columns is not supported in the server version {self.server_info.server_version}. Please use column instead.'
+                )
             if column:
-                alert_rule_payload.feature_name=column
+                alert_rule_payload.feature_name = column
 
         request_body = alert_rule_payload.dict()
         response = self.client.post(
@@ -203,24 +223,27 @@ class AlertMixin:
         project_id: Optional[str] = None,
         model_id: Optional[str] = None,
         alert_type: Optional[AlertType] = None,
-        metric: Optional[Metric] = None,
-        column: Optional[str] = None,
+        metrics: Optional[List[Metric]] = None,
         columns: Optional[List[str]] = None,
         baseline_id: Optional[str] = None,
         ordering: Optional[List[str]] = None,
         offset: int = 0,
         limit: int = 20,
     ) -> List[AlertRule]:
-        """
+        f"""
         Get a list of alert rules with respect to the filtering parameters
+
+        :param project_id: Unique project name for which the alert rule is created
+        :param model_id: Unique model name for which the alert rule is created
         :param project_id: unique project name
         :param model_id: unique model name
-        :param alert_type: Selects one of the four metric types:
+        :param alert_type: [DEPRECATED] Used only for older server versions. For {self.RULE_V3_API_VERSION} you can simply use 'metrics'.
+            Selects one of the four metric types:
                 1) AlertType.PERFORMANCE
                 2) AlertType.DATA_DRIFT
                 3) AlertType.DATA_INTEGRITY
                 4) AlertType.SERVICE_METRICS
-        :param metric: "metric":
+        :param metrics: can be a list of strings or MetricTypes that specify metrics you want to retrieve.:
                 For service_metrics:
                 1) MetricType.TRAFFIC
 
@@ -243,7 +266,6 @@ class AlertMixin:
                     1) MetricType.RANGE_VIOLATION
                     2) MetricType.MISSING_VALUE
                     3) MetricType.TYPE_VIOLATION
-        :param column: Filter based on the column
         :param columns: Filter based on a list of column names
         :param limit: Number of records to be retrieved per page, also referred as page_size
         :param offset: Pointer to the starting of the page index. offset of the first page is 0
@@ -252,19 +274,30 @@ class AlertMixin:
                         records from index 400 to 499.
         :return: paginated list of alert rules for the set filters
         """
+        if columns and not match_semver(
+            self.server_info.server_version, self.GROUP_OF_COLUMNS_API_VERSION
+        ):
+            raise ValueError(
+                f'columns parameter works with server version {self.GROUP_OF_COLUMNS_API_VERSION}'
+            )
+
         alert_params = {
             'organization_name': self.organization_name,
             'offset': offset,
             'limit': limit,
         }
 
-        if match_semvar(
+        if match_semver(
             self.server_info.server_version, self.FILTER_ALERT_RULES_API_VERSION
         ):
             filter_by_rules = []
             if project_id:
                 filter_by_rules.append(
-                    {'field': 'project_name', 'operator': 'equal', 'value': project_id}
+                    {
+                        'field': 'project_name',
+                        'operator': 'equal',
+                        'value': project_id,
+                    }
                 )
 
             if model_id:
@@ -272,30 +305,31 @@ class AlertMixin:
                     {'field': 'model_name', 'operator': 'equal', 'value': model_id}
                 )
 
-            if alert_type:
-                filter_by_rules.append(
-                    {'field': 'alert_type', 'operator': 'equal', 'value': alert_type}
-                )
+            if metrics:
+                if match_semver(
+                    self.server_info.server_version, self.RULE_V3_API_VERSION
+                ):
+                    filter_by_rules.append(
+                        {'field': 'metric_id', 'operator': 'contains', 'value': metrics}
+                    )
+                else:
+                    if alert_type:
+                        filter_by_rules.append(
+                            {
+                                'field': 'alert_type',
+                                'operator': 'equal',
+                                'value': alert_type,
+                            }
+                        )
+                    filter_by_rules.append(
+                        {'field': 'metric', 'operator': 'equal', 'value': metrics[0]}
+                    )
 
-            if metric:
+            if columns:
                 filter_by_rules.append(
-                    {'field': 'metric', 'operator': 'equal', 'value': metric}
+                    {'field': 'feature_names', 'operator': 'contains', 'value': columns}
                 )
 
-            if match_semvar(self.server_info.server_version, self.GROUP_OF_COLUMNS_API_VERSION):
-                if columns:
-                    filter_by_rules.append({'field': 'feature_names', 'operator': 'contains', 'value': columns})
-                elif column:
-                    filter_by_rules.append({'field': 'feature_names', 'operator': 'contains', 'value': [column]})
-            else:
-                # we do not support columns in server version < 23.3
-                if columns:
-                    raise ValueError(f'columns is not supported in the server version {self.server_info.server_version}. Please use column instead.')                
-                if column:
-                    filter_by_rules.append(
-                        {'field': 'feature_name', 'operator': 'equal', 'value': column}
-                    )
-                
             if baseline_id:
                 filter_by_rules.append(
                     {
@@ -317,8 +351,7 @@ class AlertMixin:
                     'project_name': project_id,
                     'model_name': model_id,
                     'alert_type': alert_type,
-                    'metric': metric,
-                    'feature_name': column,
+                    'metric': metrics[0] if metrics else None,
                     'baseline_name': baseline_id,
                     'ordering': ordering,
                 }
@@ -328,7 +361,7 @@ class AlertMixin:
             url='alert-configs',
             params=alert_params,
         )
-        _, items = PaginatedResponseHandler(response).get_pagination_details_and_items()
+        items = PaginatedResponseHandler(response).get_pagination_items()
 
         return parse_obj_as(List[AlertRule], items)
 
@@ -365,7 +398,7 @@ class AlertMixin:
                 'ordering': ordering,
             },
         )
-        _, items = PaginatedResponseHandler(response).get_pagination_details_and_items()
+        items = PaginatedResponseHandler(response).get_pagination_items()
         return parse_obj_as(List[TriggeredAlerts], items)
 
     def build_notifications_config(
@@ -373,14 +406,20 @@ class AlertMixin:
         emails: str = '',
         pagerduty_services: str = '',
         pagerduty_severity: str = '',
-    ) -> Dict[str, Dict[str, Any]]:
+        webhooks: list[str] = [],
+    ) -> Dict[str, Any]:
         """
         To get the notifications value to be set for alert rule
         :param emails: Comma separated emails list
         :param pagerduty_services: Comma separated pagerduty services list
         :param pagerduty severity: Severity for the alerts triggered by pagerduty
+        :param webhooks: List of webhook uuids, on which we need notification
         :return: dict with emails and pagerduty dict. If left unused, will store empty string for these values
         """
+        webhooks_dict: list[dict[str, str]] = [
+            {'uuid': webhook_uuid} for webhook_uuid in webhooks
+        ]
+
         return {
             'emails': {
                 'email': emails,
@@ -389,4 +428,5 @@ class AlertMixin:
                 'service': pagerduty_services,
                 'severity': pagerduty_severity,
             },
+            'webhooks': webhooks_dict,
         }