arthur-client 1.4.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur/client/rest/common/models.py

@@ -1,317 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  common.yaml
-#   timestamp: 2024-01-29T20:41:21+00:00
-
-from __future__ import annotations
-
-from enum import Enum
-from typing import Dict, List, Optional, Union
-
-from pydantic import BaseModel, Extra, Field
-
-
-class Rollup(str, Enum):
-    """
-    An optional parameter that will aggregate the calculated data drift value by the supported dimension.
-    """
-
-    Minute = 'minute'
-    Hour = 'hour'
-    Day = 'day'
-    Month = 'month'
-    Year = 'year'
-    BatchID = 'batch_id'
-
-
-class Source(str, Enum):
-    """
-    Location of the data (inference or reference)
-    """
-
-    Inference = 'inference'
-    Reference = 'reference'
-
-
-class KeyValueObject(BaseModel):
-    class Config:
-        extra = Extra.allow
-
-    __root__: Optional[Dict[str, Union[float, str, bool]]] = None
-
-
-class Page(BaseModel):
-    __root__: int = Field(..., example=1)
-
-
-class PageSize(BaseModel):
-    __root__: int = Field(..., example=100)
-
-
-class ResultRow(BaseModel):
-    """
-    Represents 1 row of result data
-    """
-
-    pass
-
-    class Config:
-        extra = Extra.allow
-
-
-class Comparator(str, Enum):
-    """
-    gt = greater than, gte = greater than or equal, lt = less than, lte = less than or equal, eq = equal, like = used for text search
-    """
-
-    GreaterThan = 'gt'
-    GreaterThanOrEqual = 'gte'
-    LessThan = 'lt'
-    LessThanOrEqual = 'lte'
-    Equal = 'eq'
-    In = 'in'
-    Like = 'like'
-
-
-class QueryFilter(BaseModel):
-    alias: Optional[str] = None
-    """
-    This will map back to a defined function in the select field and allows you to filter on a calculated function. Required if property is not provided.
-    """
-    comparator: Comparator
-    """
-    gt = greater than, gte = greater than or equal, lt = less than, lte = less than or equal, eq = equal, like = used for text search
-    """
-    property: Optional[str] = None
-    """
-    The name of the property to filter on. This field is required if alias is not provided.
-    """
-    value: Union[int, float, str]
-    """
-    The value to compare the property against
-    """
-    value_type: Optional[str] = None
-
-
-class QueryFilters(BaseModel):
-    __root__: List[QueryFilter]
-
-
-class QueryGroupByItem(BaseModel):
-    alias: Optional[str] = None
-    """
-    This should map back to an alias defined in the select clause. Required if property is not provided.
-    """
-    property: Optional[str] = None
-    """
-    This will be the name of one of the model's attributes or an enriched attribute. Required if alias is not provided.
-    """
-
-
-class QueryOrderByItem(BaseModel):
-    alias: Optional[str] = None
-    """
-    This should map back to an alias defined in the select clause. Required if property is not provided.
-    """
-    direction: Optional[str] = None
-    """
-    Either 'asc' or 'desc'. Defaults to 'asc'.
-    """
-    property: Optional[str] = None
-    """
-    This will be the name of one of the model's attributes or an enriched attribute. Required if alias is not provided.
-    """
-
-
-class From(str, Enum):
-    """
-    Data to query. Inferences are the raw inferences sent to the platform. Enriched includes the raw inferences, plus enriched properties like explanations and anomaly scores. Reference is the reference data set uploaded to the platform. The default is 'inference'.
-    """
-
-    Inference = 'inference'
-    Enriched = 'enriched'
-    Reference = 'reference'
-
-
-class Sort(BaseModel):
-    __root__: str
-    """
-    Must be supplied in the format [column_name] to denote asc sort by this column OR -[column_name] to denote desc sort by this column
-    """
-
-
-class StatusCounts(BaseModel):
-    """
-    Counts of the results by status
-    """
-
-    failure: float
-    """
-    The number of failed inferences in the request
-    """
-    success: float
-    """
-    The number of successful inferences in the request
-    """
-    total: float
-    """
-    The total number of inferences in the request
-    """
-
-
-class TotalCount(BaseModel):
-    __root__: int = Field(..., example=2)
-    """
-    The total number of results the query returned
-    """
-
-
-class TotalPages(BaseModel):
-    __root__: int = Field(..., example=1)
-    """
-    The number of result pages that this query generated, the ceiling of the total number of results divided by the page size
-    """
-
-
-class From1(str, Enum):
-    """
-    Data to query. Inferences are the raw inferences sent to the platform. Enriched includes the raw inferences, plus enriched properties like explanations and anomaly scores. Reference is the reference data set uploaded to the platform. The default is 'inference'.
-    """
-
-    inference = 'inference'
-    enriched = 'enriched'
-    reference = 'reference'
-
-
-class AnyArray(BaseModel):
-    __root__: List[Union[int, float, str, KeyValueObject]]
-
-
-class DataDriftRequestBase(BaseModel):
-    filter: Optional[QueryFilters] = None
-    source: Optional[Source] = None
-    """
-    Location of the data (inference or reference)
-    """
-
-
-class QueryGroupBy(BaseModel):
-    __root__: List[QueryGroupByItem]
-
-
-class QueryOrderBy(BaseModel):
-    __root__: List[QueryOrderByItem]
-
-
-class DataDriftRequest(BaseModel):
-    base: DataDriftRequestBase
-    group_by: Optional[QueryGroupBy] = None
-    metric: str
-    """
-    A required parameter that will determine type of data drift value.
-    """
-    num_bins: Optional[int] = None
-    """
-    Continuous attributes only - Sets the number of bins in which to perform the data drift calculation.  Bin boundaries are created by assigning each data point of the continuous property to 1 of [numBins] quantiles. For example: If you have an attribute of 100 values from 1 to 100, and passed numBins = 10, then 10 bins would be created with boundaries at 10, 20, 30, ..., 100
-    """
-    properties: List[str]
-    """
-    This is a list of model attributes or an enriched attributes. At least one is required.
-    """
-    rollup: Optional[Rollup] = None
-    """
-    An optional parameter that will aggregate the calculated data drift value by the supported dimension.
-    """
-    target: DataDriftRequestBase
-    predicted_classes: Optional[List[str]] = None
-    ground_truth_classes: Optional[List[str]] = None
-    sample: Optional[float] = None
-    disable_auto_sample: Optional[bool] = None
-
-
-class NestedParameterReference(BaseModel):
-    """
-    Can be used in a function parameter to refer to a column by alias or nest another function as input. Only one of nested_function or alias_ref can be specified at a time.
-    """
-
-    alias_ref: Optional[str] = None
-    """
-    references another alias column by name
-    """
-    nested_function: Optional[QuerySelectItem] = None
-
-
-class QueryRequest(BaseModel):
-    filter: Optional[QueryFilters] = None
-    from_: Optional[From] = Field(None, alias='from')
-    """
-    Data to query. Inferences are the raw inferences sent to the platform. Enriched includes the raw inferences, plus enriched properties like explanations and anomaly scores. Reference is the reference data set uploaded to the platform. The default is 'inference'.
-    """
-    group_by: Optional[QueryGroupBy] = None
-    order_by: Optional[QueryOrderBy] = None
-    select: QuerySelect
-    subquery: Optional[QueryRequest] = None
-    limit: Optional[int] = None
-    offset: Optional[int] = None
-    sample: Optional[float] = None
-    disable_auto_sample: Optional[bool] = None
-
-
-class QuerySelect(BaseModel):
-    __root__: List[QuerySelectItem]
-
-
-class QuerySelectItem(BaseModel):
-    """
-    Describes the fields and functions the query should return
-    """
-
-    alias: Optional[str] = None
-    """
-    If an alias is provided, this will be returned as the name for the associated result. By default, functions will have the alias set to the function name unless one is provided.
-    """
-    function: Optional[str] = None
-    """
-    The name of the function to use. Either property or function can be specified but not both. For a list of functions see https://docs.arthur.ai/docs/querying-performance
-    """
-    parameters: Optional[SelectParameter] = None
-    property: Optional[str] = None
-    """
-    The name of the property to select. This can be the name of any attribute associated with the model, any of the enriched attributes ['anomaly_score', 'lime_feature_importance', 'shap_feature_importance'], or "*", which selects all of the model's non-enriched attributes. Either property or function can be specified but not both.
-    """
-
-
-class SelectParameter(BaseModel):
-    """
-    Some functions will require additional parameters, for example, you will want to specify the "threshold" for the count function for a classifier. See the Query Documentation for more details
-    """
-
-    class Config:
-        extra = Extra.allow
-
-    __root__: Optional[
-        Dict[
-            str,
-            Union[float, str, bool, AnyArray, KeyValueObject, NestedParameterReference],
-        ]
-    ] = None
-
-
-class MetricQuery(BaseModel):
-    """
-    This should be in the format described in our [Query Guide](/api-documentation/query_guide.html). Your query must have exactly one select and may not use the `group_by` or `subquery` fields. Don't include any batch or timestamp filters as these will be added dynamically. For details [see the full metrics docs](https://docs.arthur.ai/user-guide/walkthroughs/metrics_alerts.html#creating-custom-metrics).
-    """
-
-    select: Optional[QuerySelect] = None
-    from_: Optional[From1] = Field(None, alias='from')
-    """
-    Data to query. Inferences are the raw inferences sent to the platform. Enriched includes the raw inferences, plus enriched properties like explanations and anomaly scores. Reference is the reference data set uploaded to the platform. The default is 'inference'.
-    """
-    filter: Optional[QueryFilters] = None
-    group_by: Optional[QueryGroupBy] = None
-    order_by: Optional[QueryOrderBy] = None
-
-
-NestedParameterReference.update_forward_refs()
-QueryRequest.update_forward_refs()
-QuerySelect.update_forward_refs()
-QuerySelectItem.update_forward_refs()

arthur/client/rest/enrichments/__init__.py

@@ -1,2 +0,0 @@
-from . import models
-from . import client

arthur/client/rest/enrichments/client.py

@@ -1,352 +0,0 @@
-from typing import Optional, Any, Union, Dict, List, Tuple
-from http import HTTPStatus
-from requests.cookies import RequestsCookieJar
-from requests import Response
-
-# import http client
-from arthur.client.http.requests import HTTPClient
-
-from arthur.client.rest.enrichments.models import (
-    AnomalyDetectionEnrichmentConfiguration,
-    AnomalyDetectionEnrichmentResponse,
-    BiasConstraintEnum,
-    BiasMitigationEnrichmentConfiguration,
-    BiasMitigationEnrichmentResponse,
-    EnrichmentsRequest,
-    EnrichmentsResponse,
-    ExplainabilityEnrichmentMultipartRequestBody,
-    ExplainabilityEnrichmentRequest,
-    ExplainabilityEnrichmentResponse,
-    ExplainabilityResultOnDemand,
-    ExplainabilityResultWhatIf,
-    FindHotspotsResponse,
-    HotspotsEnrichmentConfiguration,
-    HotspotsEnrichmentResponse,
-    PaginatedBiasMitigationCurves,
-    WhatIfRequest,
-)
-
-
-PATH_PREFIX = "/api"
-
-
-class ArthurEnrichmentsClient:
-    """
-    A Python client to interact with the Arthur Enrichments API
-    """
-
-    def __init__(self, http_client: HTTPClient):
-        """
-        Create a new ArthurEnrichmentsClient from an HTTPClient
-
-        :param http_client: the :class:`~arthurai.client.http.requests.HTTPClient` to use for underlying requests
-        """
-        self.http_client = http_client
-        self.http_client.set_path_prefix(PATH_PREFIX)
-
-    def get_bias_mitigation_curves(
-        self,
-        model_id: str,
-        attribute_id: Optional[str] = None,
-        constraint: Optional[List[BiasConstraintEnum]] = None,
-        attribute_value: Optional[List[str]] = None,
-        continuous_value: Optional[List[str]] = None,
-        page: Optional[int] = None,
-        page_size: Optional[int] = None,
-    ) -> PaginatedBiasMitigationCurves:
-        """
-        Retrieve Bias Mitigation curves for a specified model and query parameters
-
-        :param model_id:
-        :param attribute_id:
-        :param constraint:
-        :param attribute_value:
-        :param continuous_value:
-        :param page:
-        :param page_size:
-        """
-
-        params: Dict[str, Any] = {}
-        if attribute_id is not None:
-            params["attribute_id"] = attribute_id
-        if constraint is not None:
-            params["constraint"] = constraint
-        if attribute_value is not None:
-            params["attribute_value"] = attribute_value
-        if continuous_value is not None:
-            params["continuous_value"] = continuous_value
-        if page is not None:
-            params["page"] = page
-        if page_size is not None:
-            params["page_size"] = page_size
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/bias_mitigation/curves",
-            params=params,
-            validation_response_code=200,
-        )
-        return PaginatedBiasMitigationCurves(**parsed_resp)
-
-    def get_enrichment_configuration(self, model_id: str) -> EnrichmentsResponse:
-        """
-        Gets the enrichment configurations for a model
-
-        :param model_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments", validation_response_code=200
-        )
-        return EnrichmentsResponse(**parsed_resp)
-
-    def update_enrichment_config(
-        self,
-        model_id: str,
-        json_body: EnrichmentsRequest,
-        multipart_data: ExplainabilityEnrichmentMultipartRequestBody,
-    ) -> Response:
-        """
-        Updates the enrichment configuration for a model
-
-        :param model_id:
-        :param json_body: Configures multiple enrichments. A multipart/form-data body with at least a `configuration` JSON body. If explainability is being enabled for the first time, artifacts must be supplied.
-        :param multipart_data: When setting up explainability, a config must always be provided. The explainability enrichment artifact files may be provided all together, but a config must be provided as well, regardless of whether the config has already been set.
-        """
-
-        raw_resp: Response = self.http_client.patch(  # type: ignore
-            f"/v3/models/{model_id}/enrichments",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            files=multipart_data.dict(by_alias=True, exclude_none=True),
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def get_anomaly_detection_config(
-        self, model_id: str
-    ) -> AnomalyDetectionEnrichmentResponse:
-        """
-
-
-        :param model_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/anomaly_detection",
-            validation_response_code=200,
-        )
-        return AnomalyDetectionEnrichmentResponse(**parsed_resp)
-
-    def update_anomaly_detection_config(
-        self, model_id: str, json_body: AnomalyDetectionEnrichmentConfiguration
-    ) -> Response:
-        """
-        Enable or disable anomaly_detection for a model
-
-        :param model_id:
-        :param json_body:
-        """
-
-        raw_resp: Response = self.http_client.patch(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/anomaly_detection",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def get_bias_mitigation_config(
-        self, model_id: str
-    ) -> BiasMitigationEnrichmentResponse:
-        """
-
-
-        :param model_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/bias_mitigation",
-            validation_response_code=200,
-        )
-        return BiasMitigationEnrichmentResponse(**parsed_resp)
-
-    def update_bias_mitigation_config(
-        self, model_id: str, json_body: BiasMitigationEnrichmentConfiguration
-    ) -> Response:
-        """
-        Enable or disable bias_mitigation for a model
-
-        :param model_id:
-        :param json_body:
-        """
-
-        raw_resp: Response = self.http_client.patch(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/bias_mitigation",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def get_hotspots_config(self, model_id: str) -> HotspotsEnrichmentResponse:
-        """
-        Get hotspot enrichment config for a model
-
-        :param model_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/hotspots", validation_response_code=200
-        )
-        return HotspotsEnrichmentResponse(**parsed_resp)
-
-    def update_hotspots_config(
-        self, model_id: str, json_body: HotspotsEnrichmentConfiguration
-    ) -> Response:
-        """
-        Enable or disable hotspots for a model
-
-        :param model_id:
-        :param json_body:
-        """
-
-        raw_resp: Response = self.http_client.patch(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/hotspots",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def find_hotspots(
-        self,
-        model_id: str,
-        metric: str,
-        threshold: float,
-        date: Optional[str] = None,
-        batch_id: Optional[str] = None,
-    ) -> FindHotspotsResponse:
-        """
-        Find hotspots for a model using the given metric and threshold
-
-        For batch models, supply batch_id, for streaming models, supply a date. Cannot supply both date and batch.
-
-        :param model_id:
-        :param metric:
-        :param threshold:
-        :param date:
-        :param batch_id:
-        """
-
-        params: Dict[str, Any] = {"metric": metric, "threshold": threshold}
-        if date is not None:
-            params["date"] = date
-        if batch_id is not None:
-            params["batch_id"] = batch_id
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/hotspots/find",
-            params=params,
-            validation_response_code=200,
-        )
-        return FindHotspotsResponse(**parsed_resp)
-
-    def get_explainability_config(
-        self, model_id: str
-    ) -> ExplainabilityEnrichmentResponse:
-        """
-
-
-        :param model_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/explainability",
-            validation_response_code=200,
-        )
-        return ExplainabilityEnrichmentResponse(**parsed_resp)
-
-    def update_explainability_config(
-        self,
-        model_id: str,
-        json_body: ExplainabilityEnrichmentRequest,
-        multipart_data: ExplainabilityEnrichmentMultipartRequestBody,
-    ) -> Response:
-        """
-        Configure explainability for a model
-
-        :param model_id:
-        :param json_body: Configures explainability. A multipart/form-data body with at least a `configuration` JSON body. If explainability is being enabled for the first time, artifacts must be supplied.
-        :param multipart_data: When setting up explainability, a config must always be provided. The explainability enrichment artifact files may be provided all together, but a config must be provided as well, regardless of whether the config has already been set.
-        """
-
-        raw_resp: Response = self.http_client.patch(  # type: ignore
-            f"/v3/models/{model_id}/enrichments/explainability",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            files=multipart_data.dict(by_alias=True, exclude_none=True),
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def explain_inference(
-        self,
-        model_id: str,
-        partner_inference_id: str,
-        algorithm: Optional[str] = "lime",
-        n_samples: Optional[int] = None,
-        page: Optional[int] = None,
-        page_size: Optional[int] = None,
-        sort: Optional[str] = None,
-    ) -> ExplainabilityResultOnDemand:
-        """
-        Fetches an on-demand inference explanation
-
-        Each time this endpoint is called a new explanation for the given inferences is generated.
-
-        :param model_id:
-        :param partner_inference_id:
-        :param algorithm:
-        :param n_samples:
-        :param page:
-        :param page_size:
-        :param sort: Must be supplied in the format [column_name] to denote asc sort by this column OR -[column_name] to denote desc sort by this column
-        """
-
-        params: Dict[str, Any] = {}
-        if algorithm is not None:
-            params["algorithm"] = algorithm
-        if n_samples is not None:
-            params["n_samples"] = n_samples
-        if page is not None:
-            params["page"] = page
-        if page_size is not None:
-            params["page_size"] = page_size
-        if sort is not None:
-            params["sort"] = sort
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/models/{model_id}/inferences/{partner_inference_id}/explanation",
-            params=params,
-            validation_response_code=200,
-        )
-        return ExplainabilityResultOnDemand(**parsed_resp)
-
-    def what_if(
-        self, model_id: str, json_body: WhatIfRequest
-    ) -> ExplainabilityResultWhatIf:
-        """
-        Retrieve the prediction and explanation for an inference
-
-        Only valid for models with input type equal to Tabular.
-
-        :param model_id:
-        :param json_body: Inference model pipeline input to get explanation for
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.post(  # type: ignore
-            f"/v3/models/{model_id}/what_if",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=200,
-        )
-        return ExplainabilityResultWhatIf(**parsed_resp)