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

arthur/client/rest/metrics/models.py

@@ -1,325 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  metrics.yaml
-#   timestamp: 2024-01-24T16:44:22+00:00
-
-from __future__ import annotations
-
-from datetime import datetime
-from enum import Enum
-from typing import Any, Dict, List, Optional, Union
-from uuid import UUID
-
-from arthur.client.rest.common.models import (
-    MetricQuery,
-    Page,
-    PageSize,
-    QueryFilter,
-    TotalCount,
-    TotalPages,
-)
-from pydantic import BaseModel, Extra, Field
-
-
-class CategoricalValueLimits(BaseModel):
-    """
-    Possible values within fixed set
-    """
-
-    categories: List
-    """
-    The list of allowed values. Not required if it can be inferred.
-    """
-
-
-class MetricGroupBy(BaseModel):
-    __root__: str = Field(..., example='Education')
-    """
-    Model attribute to group by. If provided, the results will be broken down by each value or bin in the attribute
-    """
-
-
-class Value(BaseModel):
-    class Config:
-        extra = Extra.allow
-
-    rollup: Optional[str] = Field(None, example='2022-08-03T00:00:00+00:00')
-    """
-    The time aggregation associated with this metric value
-    """
-
-
-class Rollup(str, Enum):
-    """
-    What period/dataset to aggregate over.
-    """
-
-    Minute = 'MINUTE'
-    Hour = 'HOUR'
-    Day = 'DAY'
-    Month = 'MONTH'
-    Year = 'YEAR'
-    BatchID = 'BATCH_ID'
-    Reference = 'REFERENCE'
-
-
-class Type(str, Enum):
-    """
-    Type associated with the metric to create. If this field is not supplied the metric type will automatically be filled in.
-    """
-
-    ModelOutputMetric = 'model_output_metric'
-    ModelPerformanceMetric = 'model_performance_metric'
-    ModelDataDriftMetric = 'model_data_drift_metric'
-    ModelDataBoundMetric = 'model_data_bound_metric'
-
-
-class BaseMetric(BaseModel):
-    """
-    A base metric object used by both MetricRequest and MetricResponse
-    """
-
-    name: str = Field(..., example='Accuracy Rate')
-    """
-    The name for your custom metric, this should not match any other metric name for the model and cannot match any Arthur default metric names.
-    """
-    endpoint: str = Field(
-        ...,
-        example='/api/v3/models/4d722041-7274-6875-7220-53616d75656c/inferences/query',
-    )
-    """
-    The relative endpoint to hit when executing this metric
-    """
-    query: MetricQuery
-    type: Optional[Type] = None
-    """
-    Type associated with the metric to create. If this field is not supplied the metric type will automatically be filled in.
-    """
-
-
-class LastUpdatedByType(str, Enum):
-    """
-    Type of user that created or last updated this metric. Null if the metric was auto-generated by Arthur.
-    """
-
-    ServiceAccount = 'service-account'
-    ArthurManaged = 'arthur-managed'
-    IDPManaged = 'idp-managed'
-
-
-class RangeValueLimits(BaseModel):
-    """
-    Possible values between a minimum and maximum value
-    """
-
-    min: float = Field(..., example=0.0)
-    """
-    The minimum value allowed. Not required if it can be inferred.
-    """
-    max: float = Field(..., example=1.0)
-    """
-    The maximum value allowed. Not required if it can be inferred.
-    """
-
-
-class MetricParameterValues(BaseModel):
-    class Config:
-        extra = Extra.allow
-
-    __root__: Optional[Dict[str, Union[List[Union[float, str]], float, str]]] = None
-
-
-class Bin(BaseModel):
-    """
-    the bin start and end, if group is continuous
-    """
-
-    continuous_start: Optional[float] = None
-    """
-    the start of the bin
-    """
-    continuous_end: Optional[float] = None
-    """
-    the end of the bin
-    """
-
-
-class GroupLegend(BaseModel):
-    """
-    Specification of group for a metric result.
-    """
-
-    name: Optional[str] = None
-    """
-    the name of the group, if group is categorical
-    """
-    bin: Optional[Bin] = None
-    """
-    the bin start and end, if group is continuous
-    """
-
-
-class ValueLimit(BaseModel):
-    range: Optional[RangeValueLimits] = None
-
-
-class ValueLimit1(BaseModel):
-    categorical: Optional[CategoricalValueLimits] = None
-
-
-class ParameterType(str, Enum):
-    """
-    The type of a supplied parameter
-    """
-
-    Attribute = 'ATTRIBUTE'
-    Integer = 'INTEGER'
-    Float = 'FLOAT'
-    String = 'STRING'
-    Timestamp = 'TIMESTAMP'
-
-
-class ExpandMetricEnumEnum(str, Enum):
-    Type = 'type'
-
-
-class ExpandMetricEnum(BaseModel):
-    __root__: List[ExpandMetricEnumEnum]
-
-
-class MetricTypeEnum(str, Enum):
-    ModelOutputMetric = 'model_output_metric'
-    ModelDataBoundMetric = 'model_input_data_metric'
-    ModelPerformanceMetric = 'model_performance_metric'
-    ModelDataDriftMetric = 'model_data_drift_metric'
-
-
-class MetricEvaluationRequest(BaseModel):
-    """
-    The arguments to use when evaluating a metric
-    """
-
-    rollup: Optional[Rollup] = None
-    group_by: Optional[MetricGroupBy] = None
-    parameters: Optional[MetricParameterValues] = None
-    filters: Optional[List[QueryFilter]] = None
-
-
-class MetricResult(BaseModel):
-    """
-    The result of a metric evaluation on a set of parameters, filters, and group
-    """
-
-    name: str = Field(..., example='accuracy_rate')
-    """
-    The name or alias of the function computed in the underlying query. A value with this key will be present in each item/map in the 'values' array in the response.
-    """
-    values: List[Value] = Field(
-        ...,
-        example=[
-            {'rollup': '2022-08-03T00:00:00+00:00', 'accuracy_rate': 0.82},
-            {'rollup': '2022-08-04T00:00:00+00:00', 'accuracy_rate': 0.76},
-            {'rollup': '2022-08-05T00:00:00+00:00', 'accuracy_rate': 0.8},
-        ],
-    )
-    """
-    the value of the metric, aggregating by the rollup
-    """
-    parameters: Optional[Dict[str, Union[float, str]]] = Field(
-        None, example={'classifier_threshold': 0.5}
-    )
-    """
-    the parameters used when evaluating the metric
-    """
-    group: Optional[Dict[str, GroupLegend]] = Field(
-        None, example={'Education': {'name': 'HS'}}
-    )
-    """
-    the grouping applied
-    """
-
-
-class MetricEvaluationResponse(BaseModel):
-    """
-    The result of a metric evaluation
-    """
-
-    name: str = Field(..., example='Accuracy Rate')
-    """
-    The name of the metric
-    """
-    filters: Optional[List[QueryFilter]] = None
-    """
-    The dataset filters used during metric evaluation
-    """
-    results: List[MetricResult]
-    """
-    The results of metric evaluation
-    """
-
-
-class MetricParameterRequest(BaseModel):
-    """
-    A Parameter specification for a Metric
-    """
-
-    name: str = Field(..., example='classifier_threshold')
-    parameter_type: ParameterType
-    value_limits: Union[ValueLimit, ValueLimit1]
-    """
-    Acceptable values for the parameter. Exactly one of `categorical` or `range` must be specified.
-    """
-    default: Any = Field(..., example=0.5)
-    """
-    Default value(s) for the parameter. If not provided, it will be inferred if possible.
-    """
-
-
-class MetricRequest(BaseMetric):
-    """
-    A Metric containing a template query and parameter definitions
-    """
-
-    parameters: Optional[List[MetricParameterRequest]] = None
-
-
-class MetricParameterResponse(MetricParameterRequest):
-    id: Optional[UUID] = None
-
-
-class MetricResponse(BaseMetric):
-    id: Optional[UUID] = None
-    valid_rollups: Optional[List[str]] = Field(
-        None, example=['MINUTE', 'HOUR', 'DAY', 'MONTH', 'REFERENCE']
-    )
-    """
-    The allowed "rollup" parameters for this metric
-    """
-    parameters: Optional[List[MetricParameterResponse]] = None
-    last_updated_by: Optional[str] = None
-    """
-    User ID of the user that created or last updated this metric. Null if the metric was auto-generated by Arthur.
-    """
-    last_updated_by_type: Optional[LastUpdatedByType] = None
-    """
-    Type of user that created or last updated this metric. Null if the metric was auto-generated by Arthur.
-    """
-    created_at: Optional[datetime] = None
-    """
-    UTC timestamp of when the metric was created
-    """
-    updated_at: Optional[datetime] = None
-    """
-    UTC timestamp of when the metric was last updated
-    """
-
-
-class PaginatedModelMetricsResponse(BaseModel):
-    """
-    Paginated list of metrics.
-    """
-
-    metrics: List[MetricResponse]
-    page: Page
-    page_size: PageSize
-    total_pages: Optional[TotalPages] = None
-    total_count: Optional[TotalCount] = None

arthur/client/rest/model_groups/__init__.py

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

arthur/client/rest/model_groups/client.py

@@ -1,153 +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.model_groups.models import (
-    ModelGroupResponse,
-    ModelGroupUpdateRequest,
-    PaginatedModelGroupResponse,
-    PaginatedModelGroupVersionsResponse,
-)
-from arthur.client.rest.models.models import ModelExpand, ModelObject
-
-
-PATH_PREFIX = "/api"
-
-
-class ArthurModelGroupsClient:
-    """
-    A Python client to interact with the Arthur Model Groups API
-    """
-
-    def __init__(self, http_client: HTTPClient):
-        """
-        Create a new ArthurModelGroupsClient 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_paginated_model_groups(
-        self,
-        include_archived: Optional[bool] = False,
-        expand: Optional[ModelExpand] = None,
-        page: Optional[int] = None,
-        page_size: Optional[int] = None,
-        sort: Optional[str] = None,
-    ) -> PaginatedModelGroupResponse:
-        """
-        Returns a paginated response of all the model groups within an organization
-
-        :param include_archived:
-        :param expand:
-        :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 include_archived is not None:
-            params["include_archived"] = include_archived
-        if expand is not None:
-            params["expand"] = expand.value
-        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/model_groups", params=params, validation_response_code=200
-        )
-        return PaginatedModelGroupResponse(**parsed_resp)
-
-    def get_model_group_by_id(self, model_group_id: str) -> ModelGroupResponse:
-        """
-        Retrieve a specific model group object
-
-        :param model_group_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/model_groups/{model_group_id}", validation_response_code=200
-        )
-        return ModelGroupResponse(**parsed_resp)
-
-    def archive_model_group(self, model_group_id: str) -> Response:
-        """
-        Archives all the models within the model group asynchronously
-
-        :param model_group_id:
-        """
-
-        raw_resp: Response = self.http_client.delete(  # type: ignore
-            f"/v3/model_groups/{model_group_id}",
-            validation_response_code=202,
-            return_raw_response=True,
-        )
-        return raw_resp
-
-    def update_model_group(
-        self, model_group_id: str, json_body: ModelGroupUpdateRequest
-    ) -> ModelGroupResponse:
-        """
-        Updates an existing model group object
-
-        :param model_group_id:
-        :param json_body:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.patch(  # type: ignore
-            f"/v3/model_groups/{model_group_id}",
-            json=json_body.dict(by_alias=True, exclude_none=True),
-            validation_response_code=200,
-        )
-        return ModelGroupResponse(**parsed_resp)
-
-    def get_model_versions_of_model_group_by_id(
-        self,
-        model_group_id: str,
-        expand: Optional[List[ModelExpand]] = None,
-        sequence_num: Optional[float] = None,
-    ) -> PaginatedModelGroupVersionsResponse:
-        """
-        Retrieve model versions of a specific model group object
-
-        :param model_group_id:
-        :param expand:
-        :param sequence_num:
-        """
-
-        params: Dict[str, Any] = {}
-        if expand is not None:
-            params["expand"] = expand
-        if sequence_num is not None:
-            params["sequence_num"] = sequence_num
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/model_groups/{model_group_id}/versions",
-            params=params,
-            validation_response_code=200,
-        )
-        return PaginatedModelGroupVersionsResponse(**parsed_resp)
-
-    def get_latest_model_version_of_model_group_by_id(
-        self, model_group_id: str
-    ) -> ModelObject:
-        """
-        Retrieve the latest model version of a specific model group object
-
-        :param model_group_id:
-        """
-
-        parsed_resp: Dict[str, Any] = self.http_client.get(  # type: ignore
-            f"/v3/model_groups/{model_group_id}/versions/latest",
-            validation_response_code=200,
-        )
-        return ModelObject(**parsed_resp)

arthur/client/rest/model_groups/models.py

@@ -1,80 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  model_groups.yaml
-#   timestamp: 2024-01-24T16:44:22+00:00
-
-from __future__ import annotations
-
-from datetime import datetime
-from typing import List, Optional
-
-from arthur.client.rest.common.models import Page, PageSize, TotalCount, TotalPages
-from arthur.client.rest.models.models import ModelResponse
-from pydantic import BaseModel, constr
-
-
-class ModelGroupResponse(BaseModel):
-    id: Optional[str] = None
-    """
-    The auto-generated unique UUID for the model group.
-    """
-    name: Optional[constr(max_length=255)] = None
-    """
-    Optional name of the model group.
-    """
-    description: Optional[constr(max_length=255)] = None
-    """
-    Optional description of the model group.
-    """
-    versions: Optional[List[ModelResponse]] = None
-    """
-    Model versions
-    """
-    archived: Optional[bool] = None
-    """
-    Indicates whether or not a model group has been archived, defaults to false.
-    """
-    archived_at: Optional[datetime] = None
-    """
-    UTC timestamp in ISO8601 format of when the model group was archived.
-    """
-    created_at: Optional[datetime] = None
-    """
-    UTC timestamp in ISO8601 format of when the model group was created.
-    """
-    updated_at: Optional[datetime] = None
-    """
-    UTC timestamp in ISO8601 format of when the model group was last updated.
-    """
-
-
-class ModelGroupUpdateRequest(BaseModel):
-    name: Optional[constr(max_length=255)] = None
-    """
-    Optional name of the model group.
-    """
-    description: Optional[constr(max_length=255)] = None
-    """
-    Optional description of the model group.
-    """
-
-
-class PaginatedModelGroupVersionsResponse(BaseModel):
-    data: List[ModelResponse]
-    """
-    Model versions.
-    """
-    page: Page
-    page_size: PageSize
-    total_pages: Optional[TotalPages] = None
-    total_count: Optional[TotalCount] = None
-
-
-class PaginatedModelGroupResponse(BaseModel):
-    data: List[ModelGroupResponse]
-    """
-    List of model group objects.
-    """
-    page: Page
-    page_size: PageSize
-    total_pages: Optional[TotalPages] = None
-    total_count: Optional[TotalCount] = None

arthur/client/rest/models/__init__.py

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