fiddler-client 2.3.0.dev2__py3-none-any.whl → 2.4.0.dev1__py3-none-any.whl

fiddler3/schemas/model.py

@@ -8,18 +8,18 @@ from fiddler3.schemas.base import BaseModel
 from fiddler3.schemas.model_schema import Column, ModelSchema
 from fiddler3.schemas.model_spec import ModelSpec
 from fiddler3.schemas.model_task_params import ModelTaskParams
-from fiddler3.schemas.organization import OrganizationCompact
-from fiddler3.schemas.project import ProjectCompact
-from fiddler3.schemas.user import UserCompact
+from fiddler3.schemas.organization import OrganizationCompactResp
+from fiddler3.schemas.project import ProjectCompactResp
+from fiddler3.schemas.user import UserCompactResp
 from fiddler3.schemas.xai_params import XaiParams
 
 
-class ModelCompact(BaseModel):
+class ModelCompactResp(BaseModel):
     id: UUID
     name: str
 
 
-class ModelResponse(BaseModel):
+class ModelResp(BaseModel):
     id: UUID
     name: str
     input_type: str
@@ -36,10 +36,10 @@ class ModelResponse(BaseModel):
     artifact_files: List[Dict]
     created_at: datetime
     updated_at: datetime
-    created_by: UserCompact
-    updated_by: UserCompact
-    organization: OrganizationCompact
-    project: ProjectCompact
+    created_by: UserCompactResp
+    updated_by: UserCompactResp
+    organization: OrganizationCompactResp
+    project: ProjectCompactResp
     input_cols: List[Column]
     output_cols: List[Column]
     target_cols: List[Column]

fiddler3/schemas/model_artifact.py

@@ -0,0 +1,6 @@
+from fiddler3.schemas.base import BaseModel
+
+
+class ModelArtifactDeployMultiPartUploadResp(BaseModel):
+    part_number: int
+    etag: str

fiddler3/schemas/model_deployment.py

@@ -0,0 +1,26 @@
+from datetime import datetime
+from uuid import UUID
+
+from fiddler3.schemas.base import BaseModel
+from fiddler3.schemas.model import ModelCompactResp
+from fiddler3.schemas.organization import OrganizationCompactResp
+from fiddler3.schemas.project import ProjectCompactResp
+from fiddler3.schemas.user import UserCompactResp
+
+
+class ModelDeploymentResponse(BaseModel):
+    id: UUID
+    model: ModelCompactResp
+    project: ProjectCompactResp
+    organization: OrganizationCompactResp
+    artifact_type: str
+    deployment_type: str
+    active: bool
+    image_uri: str
+    replicas: int
+    cpu: int
+    memory: int
+    created_at: datetime
+    updated_at: datetime
+    created_by: UserCompactResp
+    updated_by: UserCompactResp

fiddler3/schemas/organization.py

@@ -1,8 +1,16 @@
+from datetime import datetime
 from uuid import UUID
 
 from fiddler3.schemas.base import BaseModel
 
 
-class OrganizationCompact(BaseModel):
+class OrganizationCompactResp(BaseModel):
     id: UUID
     name: str
+
+
+class OrganizationResp(BaseModel):
+    id: UUID
+    name: str
+    created_at: datetime
+    updated_at: datetime

fiddler3/schemas/project.py

@@ -2,18 +2,18 @@ from datetime import datetime
 from uuid import UUID
 
 from fiddler3.schemas.base import BaseModel
-from fiddler3.schemas.organization import OrganizationCompact
+from fiddler3.schemas.organization import OrganizationCompactResp
 
 
-class ProjectCompact(BaseModel):
+class ProjectCompactResp(BaseModel):
     id: UUID
     name: str
 
 
-class ProjectResponse(BaseModel):
+class ProjectResp(BaseModel):
     id: UUID
     name: str
     created_at: datetime
     updated_at: datetime
 
-    organization: OrganizationCompact
+    organization: OrganizationCompactResp

fiddler3/schemas/server_info.py

@@ -2,7 +2,7 @@ from typing import Dict, Generator
 
 from fiddler3.libs.semver import VersionInfo
 from fiddler3.schemas.base import BaseModel
-from fiddler3.schemas.organization import OrganizationCompact
+from fiddler3.schemas.organization import OrganizationCompactResp
 
 
 class Version(VersionInfo):
@@ -15,4 +15,4 @@ class Version(VersionInfo):
 class ServerInfo(BaseModel):
     feature_flags: Dict
     server_version: Version
-    organization: OrganizationCompact
+    organization: OrganizationCompactResp

fiddler3/schemas/user.py

@@ -3,7 +3,7 @@ from uuid import UUID
 from pydantic import BaseModel
 
 
-class UserCompact(BaseModel):
+class UserCompactResp(BaseModel):
     id: UUID
     full_name: str
     email: str

fiddler3/schemas/xai.py

@@ -0,0 +1,32 @@
+from typing import Dict, Optional, Union
+from uuid import UUID
+
+from pydantic import Field
+
+from fiddler3.constants.dataset import EnvType
+from fiddler3.schemas.base import BaseModel
+
+
+class RowDataSource(BaseModel):
+    source_type = 'ROW'
+    row: Dict
+
+
+class EventIdDataSource(BaseModel):
+    source_type = 'EVENT_ID'
+    event_id: str
+    env_id: Optional[Union[str, UUID]] = Field(alias='dataset_id')
+    env_type: EnvType
+
+
+class DatasetDataSource(BaseModel):
+    source_type = 'ENVIRONMENT'
+    env_type: str
+    num_samples: Optional[int]
+    env_id: Optional[Union[str, UUID]] = Field(alias='dataset_id')
+
+
+class SqlSliceQueryDataSource(BaseModel):
+    source_type = 'SQL_SLICE_QUERY'
+    query: str
+    num_samples: Optional[int]

fiddler3/tests/apis/test_baseline.py

@@ -0,0 +1,292 @@
+from http import HTTPStatus
+from uuid import UUID
+
+import pytest
+import responses
+from responses import matchers
+
+from fiddler3.constants.baseline import BaselineType
+from fiddler3.entities.baseline import Baseline
+from fiddler3.exceptions import Conflict, NotFound
+from fiddler3.tests.constants import (
+    BASELINE_ID,
+    BASELINE_NAME,
+    DATASET_ID,
+    DATASET_NAME,
+    MODEL_ID,
+    MODEL_NAME,
+    ORG_ID,
+    ORG_NAME,
+    PROJECT_ID,
+    PROJECT_NAME,
+    URL,
+)
+
+API_RESPONSE_200 = {
+    'data': {
+        'id': BASELINE_ID,
+        'name': BASELINE_NAME,
+        'type': 'STATIC',
+        'start_time': None,
+        'end_time': None,
+        'offset': None,
+        'window_size': None,
+        'row_count': 20000,
+        'model': {
+            'id': MODEL_ID,
+            'name': MODEL_NAME,
+        },
+        'project': {'id': PROJECT_ID, 'name': PROJECT_NAME},
+        'organization': {
+            'id': ORG_ID,
+            'name': ORG_NAME,
+        },
+        'environment': {
+            'id': DATASET_ID,
+            'name': DATASET_NAME,
+            'type': 'PRE_PRODUCTION',
+        },
+        'created_at': '2023-10-05T18:46:40.526590+00:00',
+        'updated_at': '2023-10-05T18:46:40.526590+00:00',
+    },
+    'api_version': '3.0',
+    'kind': 'NORMAL',
+}
+API_RESPONSE_FROM_NAME = {
+    'data': {
+        'page_size': 100,
+        'total': 1,
+        'item_count': 1,
+        'page_count': 1,
+        'page_index': 1,
+        'offset': 0,
+        'items': [API_RESPONSE_200['data']],
+    }
+}
+
+LIST_API_RESPONSE = {
+    'data': {
+        'page_size': 100,
+        'total': 2,
+        'item_count': 2,
+        'page_count': 1,
+        'page_index': 1,
+        'offset': 0,
+        'items': [
+            API_RESPONSE_200['data'],
+            {
+                'id': 'af05646f-0cef-4638-84c9-0d195df2575f',
+                'name': 'test_baseline_2',
+                'type': 'STATIC',
+                'start_time': None,
+                'end_time': None,
+                'offset': None,
+                'window_size': None,
+                'row_count': 20000,
+                'model': {
+                    'id': MODEL_ID,
+                    'name': MODEL_NAME,
+                },
+                'project': {'id': PROJECT_ID, 'name': PROJECT_NAME},
+                'organization': {
+                    'id': ORG_ID,
+                    'name': ORG_NAME,
+                },
+                'environment': {
+                    'id': DATASET_ID,
+                    'name': DATASET_NAME,
+                    'type': 'PRE_PRODUCTION',
+                },
+                'created_at': '2023-10-05T18:46:40.526590+00:00',
+                'updated_at': '2023-10-05T18:46:40.526590+00:00',
+            },
+        ],
+    }
+}
+
+API_RESPONSE_404 = {
+    'error': {
+        'code': 404,
+        'message': 'Baseline not found for the given identifier',
+        'errors': [
+            {
+                'reason': 'ObjectNotFound',
+                'message': 'Baseline not found for the given identifier',
+                'help': '',
+            }
+        ],
+    }
+}
+
+API_RESPONSE_409 = {
+    'error': {
+        'code': 409,
+        'message': 'Baseline already exists',
+        'errors': [
+            {
+                'reason': 'Conflict',
+                'message': 'Baseline already exists',
+                'help': '',
+            }
+        ],
+    }
+}
+
+
+@responses.activate
+def test_get_baseline_success() -> None:
+    responses.get(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+        json=API_RESPONSE_200,
+    )
+
+    baseline = Baseline.get(id_=BASELINE_ID)
+
+    assert isinstance(baseline, Baseline)
+
+
+@responses.activate
+def test_get_baseline_not_found() -> None:
+    responses.get(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+        json=API_RESPONSE_404,
+        status=HTTPStatus.NOT_FOUND,
+    )
+
+    with pytest.raises(NotFound):
+        Baseline.get(id_=BASELINE_ID)
+
+
+@responses.activate
+def test_baseline_from_name() -> None:
+    params = {
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+    }
+
+    responses.get(
+        url=f'{URL}/v3/baselines',
+        json=API_RESPONSE_FROM_NAME,
+        match=[matchers.query_param_matcher(params)],
+    )
+    baseline = Baseline.from_name(
+        name=BASELINE_NAME,
+        model_name=MODEL_NAME,
+        project_name=PROJECT_NAME,
+    )
+    assert isinstance(baseline, Baseline)
+
+
+@responses.activate
+def test_baseline_from_name_not_found() -> None:
+    resp = API_RESPONSE_FROM_NAME.copy()
+    resp['data']['total'] = 0
+    resp['data']['item_count'] = 0
+    resp['data']['items'] = []
+
+    params = {
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "test_baseline"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+    }
+
+    responses.get(
+        url=f'{URL}/v3/baselines',
+        json=resp,
+        match=[matchers.query_param_matcher(params)],
+    )
+    with pytest.raises(NotFound):
+        Baseline.from_name(
+            name=BASELINE_NAME,
+            model_name=MODEL_NAME,
+            project_name=PROJECT_NAME,
+        )
+
+
+@responses.activate
+def test_baseline_list_success() -> None:
+    responses.get(
+        url=f'{URL}/v3/baselines',
+        json=LIST_API_RESPONSE,
+    )
+    for baseline in Baseline.list():
+        assert isinstance(baseline, Baseline)
+
+
+@responses.activate
+def test_baseline_list_empty() -> None:
+    resp = API_RESPONSE_FROM_NAME.copy()
+    resp['data']['total'] = 0
+    resp['data']['item_count'] = 0
+    resp['data']['items'] = []
+
+    responses.get(
+        url=f'{URL}/v3/baselines',
+        json=resp,
+    )
+    assert len(list(Baseline.list())) == 0
+
+
+@responses.activate
+def test_add_baseline_success() -> None:
+    responses.post(
+        url=f'{URL}/v3/baselines',
+        json=API_RESPONSE_200,
+    )
+    baseline = Baseline(
+        name=BASELINE_NAME,
+        model_id=MODEL_ID,
+        environment='PRE_PRODUCTION',
+        dataset_id=DATASET_ID,
+        type_=BaselineType.STATIC,
+    ).create()
+
+    assert isinstance(baseline, Baseline)
+    assert baseline.id == UUID(BASELINE_ID)
+    assert baseline.name == BASELINE_NAME
+
+
+@responses.activate
+def test_add_baseline_conflict() -> None:
+    responses.post(
+        url=f'{URL}/v3/baselines', json=API_RESPONSE_409, status=HTTPStatus.CONFLICT
+    )
+
+    with pytest.raises(Conflict):
+        Baseline(
+            name=BASELINE_NAME,
+            model_id=MODEL_ID,
+            environment='PRE_PRODUCTION',
+            dataset_id=DATASET_ID,
+            type_=BaselineType.STATIC,
+        ).create()
+
+
+@responses.activate
+def test_delete_baseline() -> None:
+    responses.get(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+        json=API_RESPONSE_200,
+    )
+    baseline = Baseline.get(id_=BASELINE_ID)
+
+    responses.delete(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+    )
+
+    baseline.delete()
+
+
+@responses.activate
+def test_delete_baseline_not_found() -> None:
+    responses.get(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+        json=API_RESPONSE_200,
+    )
+    baseline = Baseline.get(id_=BASELINE_ID)
+
+    responses.delete(
+        url=f'{URL}/v3/baselines/{BASELINE_ID}',
+        json=API_RESPONSE_404,
+        status=HTTPStatus.NOT_FOUND,
+    )
+
+    with pytest.raises(NotFound):
+        baseline.delete()

fiddler3/tests/apis/test_dataset.py

@@ -0,0 +1,173 @@
+from http import HTTPStatus
+
+import pytest
+import responses
+from responses import matchers
+
+from fiddler3.entities.dataset import Dataset
+from fiddler3.exceptions import NotFound
+from fiddler3.tests.constants import (
+    DATASET_ID,
+    DATASET_NAME,
+    MODEL_ID,
+    MODEL_NAME,
+    ORG_ID,
+    ORG_NAME,
+    PROJECT_ID,
+    PROJECT_NAME,
+    URL,
+)
+
+API_RESPONSE_200 = {
+    'data': {
+        'id': DATASET_ID,
+        'name': DATASET_NAME,
+        'type': 'PRE_PRODUCTION',
+        'row_count': 10000,
+        'model': {'id': MODEL_ID, 'name': MODEL_NAME},
+        'project': {'id': PROJECT_ID, 'name': PROJECT_NAME},
+        'organization': {'id': ORG_ID, 'name': ORG_NAME},
+        'created_at': '2023-09-19T13:27:03.684345+00:00',
+        'updated_at': '2023-09-19T13:27:03.684345+00:00',
+    },
+    'api_version': '3.0',
+    'kind': 'NORMAL',
+}
+API_RESPONSE_FROM_NAME = {
+    'data': {
+        'page_size': 100,
+        'total': 1,
+        'item_count': 1,
+        'page_count': 1,
+        'page_index': 1,
+        'offset': 0,
+        'items': [API_RESPONSE_200['data']],
+    }
+}
+
+LIST_API_RESPONSE = {
+    'data': {
+        'page_size': 100,
+        'total': 2,
+        'item_count': 2,
+        'page_count': 1,
+        'page_index': 1,
+        'offset': 0,
+        'items': [
+            API_RESPONSE_200['data'],
+            {
+                'id': '2531bfd9-2ca2-4a7b-bb5a-136c8da09ca1',
+                'name': 'dataset2',
+                'type': 'PRE_PRODUCTION',
+                'row_count': 10000,
+                'model': {'id': MODEL_ID, 'name': MODEL_NAME},
+                'project': {'id': PROJECT_ID, 'name': PROJECT_NAME},
+                'organization': {'id': ORG_ID, 'name': ORG_NAME},
+                'created_at': '2023-09-19T13:27:03.684345+00:00',
+                'updated_at': '2023-09-19T13:27:03.684345+00:00',
+            },
+        ],
+    }
+}
+
+API_RESPONSE_404 = {
+    'error': {
+        'code': 404,
+        'message': 'Environment not found for the given identifier',
+        'errors': [
+            {
+                'reason': 'ObjectNotFound',
+                'message': 'Environment not found for the given identifier',
+                'help': '',
+            }
+        ],
+    }
+}
+
+
+@responses.activate
+def test_get_dataset_success() -> None:
+    responses.get(
+        url=f'{URL}/v3/environments/{DATASET_ID}',
+        json=API_RESPONSE_200,
+    )
+
+    dataset = Dataset.get(id_=DATASET_ID)
+    assert isinstance(dataset, Dataset)
+
+
+@responses.activate
+def test_get_dataset_not_found() -> None:
+    responses.get(
+        url=f'{URL}/v3/environments/{DATASET_ID}',
+        json=API_RESPONSE_404,
+        status=HTTPStatus.NOT_FOUND,
+    )
+
+    with pytest.raises(NotFound):
+        Dataset.get(id_=DATASET_ID)
+
+
+@responses.activate
+def test_dataset_from_name() -> None:
+    params = {
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "dataset3"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+    }
+    responses.get(
+        url=f'{URL}/v3/environments',
+        json=API_RESPONSE_FROM_NAME,
+        match=[matchers.query_param_matcher(params)],
+    )
+    dataset = Dataset.from_name(
+        name=DATASET_NAME,
+        model_name=MODEL_NAME,
+        project_name=PROJECT_NAME,
+    )
+    assert isinstance(dataset, Dataset)
+
+
+@responses.activate
+def test_dataset_from_name_not_found() -> None:
+    resp = API_RESPONSE_FROM_NAME.copy()
+    resp['data']['total'] = 0
+    resp['data']['item_count'] = 0
+    resp['data']['items'] = []
+
+    params = {
+        'filter': '{"condition": "AND", "rules": [{"field": "name", "operator": "equal", "value": "dataset3"}, {"field": "project_name", "operator": "equal", "value": "bank_churn"}, {"field": "model_name", "operator": "equal", "value": "bank_churn"}]}'
+    }
+    responses.get(
+        url=f'{URL}/v3/environments',
+        json=resp,
+        match=[matchers.query_param_matcher(params)],
+    )
+    with pytest.raises(NotFound):
+        Dataset.from_name(
+            name=DATASET_NAME,
+            model_name=MODEL_NAME,
+            project_name=PROJECT_NAME,
+        )
+
+
+@responses.activate
+def test_dataset_list_success() -> None:
+    responses.get(
+        url=f'{URL}/v3/environments',
+        json=LIST_API_RESPONSE,
+    )
+    for dataset in Dataset.list():
+        assert isinstance(dataset, Dataset)
+
+
+@responses.activate
+def test_dataset_list_empty() -> None:
+    resp = API_RESPONSE_FROM_NAME.copy()
+    resp['data']['total'] = 0
+    resp['data']['item_count'] = 0
+    resp['data']['items'] = []
+
+    responses.get(
+        url=f'{URL}/v3/environments',
+        json=resp,
+    )
+    assert len(list(Dataset.list())) == 0