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

fiddler3/tests/test_json_encoder.py

@@ -0,0 +1,16 @@
+from uuid import UUID
+
+import pytest
+import simplejson
+
+from fiddler3.libs.json_encoder import RequestClientJSONEncoder
+
+
+def test_json_encoder_uuid():
+    data = {'uuid_field': UUID('ef3e24550e1846e0ae0e6672c3a0d5d9')}
+    with pytest.raises(TypeError):
+        simplejson.dumps(data)
+
+    assert simplejson.dumps(data, cls=RequestClientJSONEncoder) == simplejson.dumps(
+        {'uuid_field': 'ef3e24550e1846e0ae0e6672c3a0d5d9'}
+    )

fiddler3/tests/test_logger.py

@@ -0,0 +1,12 @@
+import logging
+
+from fiddler3.constants.common import LOGGER_NAME
+from fiddler3.utils.logger import set_logging
+
+
+def test_set_logging() -> None:
+    app_logger = logging.getLogger(LOGGER_NAME)
+    assert len(app_logger.handlers) == 0
+
+    set_logging(level=logging.ERROR)
+    assert len(app_logger.handlers) == 1

fiddler3/tests/test_utils.py

@@ -1,4 +1,10 @@
+import os
+from pathlib import Path
+
+import pytest
+
 from fiddler3.schemas.server_info import Version
+from fiddler3.utils.validations import validate_artifact_dir
 from fiddler3.utils.version import match_semver
 
 
@@ -13,3 +19,16 @@ def test_match_semvar_version() -> None:
     assert match_semver(Version.parse('22.10.0'), '<22.10.0') is False
     assert match_semver(Version.parse('22.9.0'), '<22.10.0') is True
     assert match_semver(Version.parse('22.11.0-RC1'), '>=22.11.0') is True
+
+
+def test_validate_artifact_dir(tmp_path) -> None:
+    artifact_dir = os.path.join(Path(__file__).resolve().parent, 'artifact_test_dir')
+    assert validate_artifact_dir(Path(artifact_dir)) is None
+    # Test for artifact_dir not valid directory
+    with pytest.raises(ValueError):
+        validate_artifact_dir(Path('test'))
+    # Test for package.py file not found
+    mock_dir = tmp_path / 'test'
+    mock_dir.mkdir()
+    with pytest.raises(ValueError):
+        validate_artifact_dir(Path(mock_dir))

fiddler3/utils/__init__.py

@@ -0,0 +1 @@
+from fiddler3.utils.logger import set_logging  # noqa

fiddler3/utils/helpers.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+from datetime import datetime
+
+import pandas as pd
+
+from fiddler3.constants.common import TIMESTAMP_FORMAT
+from fiddler3.constants.model import DataType
+from fiddler3.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+def try_series_retype(series: pd.Series, new_type: str) -> pd.DataFrame | pd.Series:
+    """Retype series."""
+    if new_type in ['unknown', 'str']:
+        # Do not retype data
+        return series
+
+    try:
+        return series.astype(new_type)
+    except (TypeError, ValueError) as e:
+        if new_type == 'int':
+            logger.warning(
+                '"%s" cannot be loaded as int '
+                '(likely because it contains missing values, and '
+                'Pandas does not support NaN for ints). Loading '
+                'as float instead.',
+                series.name,
+            )
+            return series.astype('float')
+        if new_type.lower() == DataType.TIMESTAMP.value:
+            try:
+                return series.apply(lambda x: datetime.strptime(x, TIMESTAMP_FORMAT))
+            # if timestamp str doesn't contain millisec.
+            except ValueError:
+                # @TODO: Should such cases be
+                # 1. handled by client OR
+                # 2. should server apped 00 ms if not present during ingestion OR
+                # 3. should it break if timestamp format does not match while ingestion?
+                return series.apply(lambda x: datetime.strptime(x, '%Y-%m-%d %H:%M:%S'))
+        else:
+            raise e

fiddler3/utils/logger.py

@@ -1,8 +1,23 @@
 import logging
+import sys
 from logging import Logger
 
+from fiddler3.constants.common import LOG_FORMAT, LOGGER_NAME
+
 
 def get_logger(name: str) -> Logger:
+    """Get logger instance"""
     logger: Logger = logging.getLogger(name)
     logger.addHandler(logging.NullHandler())
     return logger
+
+
+def set_logging(level: int = logging.INFO) -> None:
+    """Set app logger at given log level"""
+    app_logger = logging.getLogger(LOGGER_NAME)
+    handler = logging.StreamHandler(stream=sys.stdout)
+    formatter = logging.Formatter(LOG_FORMAT)
+    handler.setFormatter(formatter)
+    handler.setLevel(level)
+    app_logger.addHandler(handler)
+    app_logger.setLevel(level)

fiddler3/utils/validations.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+
+def validate_artifact_dir(artifact_dir: Path) -> None:
+    """Check if artifact directory exists."""
+    if not artifact_dir.is_dir():
+        raise ValueError(f'{artifact_dir} is not a valid model directory')
+
+    package_file_path = artifact_dir / 'package.py'
+    if not package_file_path.is_file():
+        raise ValueError(f'package.py file not found at {package_file_path}')

{fiddler_client-2.3.0.dev2.dist-info → fiddler_client-2.4.0.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fiddler-client
-Version: 2.3.0.dev2
+Version: 2.4.0.dev1
 Summary: Python client for Fiddler Service
 Home-page: https://fiddler.ai
 Author: Fiddler Labs
@@ -42,6 +42,10 @@ Documentation for the API can be found [here](https://docs.fiddler.ai/reference/
 
 Version History
 -------------
+### 2.4.0
+ - #### **New Features**
+  - Support for enrichments
+
 ### 2.3.0
   - #### **New Features**
     - Added support for creating alerts on the `Frequency` metric.
@@ -53,10 +57,8 @@ Version History
     - Relax pydantic version to allow any version between 1.9 and 2
 
 ### 2.2.0
- - #### **Modifications**
-  - add_custom_metric() supports an optional `description` parameter
-  - `fql` is renamed to `definition` in add_custom_metric()
-  - A new get_custom_metric() function to get details about a single custom metric.
+ - #### **New Features**
+  - Support segments
 
 ### 2.1.2
   - #### **Modifications**

{fiddler_client-2.3.0.dev2.dist-info → fiddler_client-2.4.0.dev1.dist-info}/RECORD

@@ -1,11 +1,11 @@
-fiddler/__init__.py,sha256=VBrs_sjTcvv58z4jbbnfdXFkiPIS7Pmb6_E374N25UQ,1984
-fiddler/_version.py,sha256=4EjTkN1PSBzZPXNpTc6wvLbnD32jdQH35B3uwSTb8ew,27
+fiddler/__init__.py,sha256=D3soQu7i4pVdlmtuJDjlSwil0jSfusWl9DbpD33oo3k,2018
+fiddler/_version.py,sha256=fVX_KNqblELev-oF0H2yXxy876aUST0Z4w2CHTgkaHk,27
 fiddler/constants.py,sha256=kXJX771B9UoQKh-umPnPfDXGeCRdC8TmTAi40hSK0Cs,1886
-fiddler/core_objects.py,sha256=D3-DanqrXOieCL-h8PqY_HZUn5JePGZ4_c50YG9ElxM,114172
+fiddler/core_objects.py,sha256=7xSBaYF0F24c0xBJ9e9kjgKEf2Qbv0xViG1Z1OSTg_g,116420
 fiddler/exceptions.py,sha256=uC7EhNRmlndYxPvlyHOKQUNTRpe-J8HNulytU_NLmn0,2585
 fiddler/api/__init__.py,sha256=Na9WlUxg8FmKHBzzVJ-CzlYNm7-LClVH5f313SqJx4A,108
-fiddler/api/alert_mixin.py,sha256=NCPRr3jNw8MteP_N0_oaiYVwUPxn_n6FsS27f9NZ8bA,20119
-fiddler/api/api.py,sha256=XScZH7NNfDAD6layLaMMD1p2DYfezx3aHTEDO5BF2ls,3415
+fiddler/api/alert_mixin.py,sha256=t5Ab3p6ByMPDl0RXcN4lKQN8Iti45TJgND4gW1zbm8E,20118
+fiddler/api/api.py,sha256=cdIjG-VZeax-HOPEo8VV08plAkWD-35zxnu3vO_NWIg,3487
 fiddler/api/baseline_mixin.py,sha256=juSezFwyXk8KJMoF-HXeE1WkhlUG7FVehaVS-t1zFC4,7452
 fiddler/api/custom_metrics_mixin.py,sha256=7fpZx_4jSzhELbU1TYyvgDqP8NUMg62NWqlgRwKjkDQ,3459
 fiddler/api/dataset_mixin.py,sha256=c21GDwMk1FiI-IanamCfIxWMABAI-KCZpBs8n7SLy8g,15335
@@ -18,7 +18,7 @@ fiddler/api/model_deployment_mixin.py,sha256=vzbckdEbEPWVssPA9xsLIS_iUF3a5sEbBCH
 fiddler/api/model_mixin.py,sha256=VWf785tKaQHtpicpkoaVv8SZm-hD_nAC9Zb-d5uvUx4,17350
 fiddler/api/project_mixin.py,sha256=14GN7EP53_8qBBnAx27PuHL-ZmCGofU__kjygl6bIMQ,3206
 fiddler/api/segments_mixin.py,sha256=hwsn0cSlXZ4i9MG0Kg_BNlb4-SchqQZM0rDx0zcismw,3396
-fiddler/api/webhooks_mixin.py,sha256=TPUihCL16YjSuwwbRWhifmlZuS-SBRtitV7z-7Goj8w,3793
+fiddler/api/webhooks_mixin.py,sha256=riSbnBCi1A2qQZ-lmDbHBxvAPp1EPslR3oW5r3J-a9Y,3854
 fiddler/assets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fiddler/assets/pg_reserved_words.py,sha256=Z4iNATcECfA4qB5GRJppCIvW7XKtGCwZ6qvPC1AB7Gs,8201
 fiddler/libs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -44,7 +44,7 @@ fiddler/schema/server_info.py,sha256=33tY0ohiSJJNpoeyanUCNZy-sexQwoLRdr2XQrUmNEE
 fiddler/schema/user.py,sha256=8p4r2ZMqPEggggd10l62w_7A5KsRr6Se5QP-xfrEtks,109
 fiddler/schema/webhook.py,sha256=zDYGEgsAYd8NYMDhVOpK74t7dC6VieAvHmSoeadS_Ks,219
 fiddler/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fiddler/schemas/custom_features.py,sha256=yd_cke-nK1n6s1og9xhpOXyAwHsXsw-g3L2PahcmCJk,3329
+fiddler/schemas/custom_features.py,sha256=OAGQMNxob0JxtvjV4vw5zoLnfU8r6IpxXg0_8l50jSs,3578
 fiddler/utils/__init__.py,sha256=DEH6Z0Y4sawrzgpCHYuHfeGfYihxxjDC_z5ZhpICHjg,4622
 fiddler/utils/decorators.py,sha256=jp7oGBgcWpcxfs5O36zHR-urJdtqjLo4hA-5XxR8fIs,3681
 fiddler/utils/formatting.py,sha256=vXldw_Qtcvk22Yv4c2FkROHrkniWNog55dG1DoaIs4Q,1379
@@ -65,46 +65,77 @@ fiddler3/decorators.py,sha256=JH4LPeygR4sPUt-xbsM1ZQ3vPF53iYwREZCWQ6Bmjpo,1823
 fiddler3/exceptions.py,sha256=7o0Xjx6McNMFxvysGMmp7NcXV2iGSM2VCt2h7OXDB0M,2172
 fiddler3/version.py,sha256=WZxVB-2_454JxgdmIIsxG-DUc65ia-VgtyjcgvV4mro,22
 fiddler3/constants/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fiddler3/constants/common.py,sha256=cBYTLyj7o7jtaFlkWBnZWqbjrhZSiCkBQHqd3rwxy_Q,125
+fiddler3/constants/baseline.py,sha256=NhmiGf73gy2IHKKpbm64HCE4eJfbxkAPy3uk_Z-6qSo,321
+fiddler3/constants/common.py,sha256=Ls5VSDNC0hYFqtsKf0RbzsRQ8bYXiSIUM14vm6g3KVU,611
+fiddler3/constants/dataset.py,sha256=ZxPmzycSlrKpUYShpfTDqfmz8LAebzyBtIV_dBy-pRI,126
 fiddler3/constants/job.py,sha256=tMT0vr3x3IiCTQcifP2s1-VWC5gskflKexfU_VfDIzA,233
 fiddler3/constants/model.py,sha256=t8zINOAHVHAXQAE-i7Yg3vbpNi4Pu9uKZxnHNH3HGTA,1456
-fiddler3/entities/__init__.py,sha256=lzf4g0KwW_CYktVcPhJQJ59E3L8DVCXD5f8V7xoMvI4,150
-fiddler3/entities/base.py,sha256=AtwjOnd04URqNTges_SfGjLiN334fLhLgQwRx45qBUA,2178
+fiddler3/constants/model_deployment.py,sha256=SfagLKVD7tK1QmYQFJLDrA4-6FaSeNF6tikP8pH2RTk,278
+fiddler3/constants/xai.py,sha256=GR8VguB6FTfMJZ291FIbfDsY4S9BGOft3VxNW5jMf90,214
+fiddler3/entities/__init__.py,sha256=ncuKKvYmb6Er8lIBFmLZsjGZoRrYGTngUvW_XBUuayw,366
+fiddler3/entities/base.py,sha256=QG6cxJNkiBlB86rbamoS6CcRiN1iB9QczGeaPsMgmaw,2522
+fiddler3/entities/baseline.py,sha256=lVIea8G5Md61KLewKyrTO9oPZSRpywX_VRSwbfPrkJU,7247
+fiddler3/entities/dataset.py,sha256=DKn6uo-6GxWhADas9iI3sLeBtDHM5yvyO7drAiQy-d0,4721
 fiddler3/entities/helpers.py,sha256=4BlxOsHlCZIeZEqErPxS4NznEOuVgZwxisNdfgE9-zE,581
-fiddler3/entities/job.py,sha256=cenqRyRprKtAD_6ZBr-Ako0amA3965vNBaf2J4vpUl4,4543
-fiddler3/entities/model.py,sha256=SHB6bYm_nP4rutjFNitzM2wm7z6IRDd1JnsQHPfTWi4,6992
-fiddler3/entities/project.py,sha256=sl_FFJ7bSMIyLSplb7z0qhvnwPv3N3DYjSdXKBFOoVI,2844
+fiddler3/entities/job.py,sha256=vObT1vdjcc76gOTzFVj6rn-rn6g4e_BRVJNeHTWejg8,4564
+fiddler3/entities/model.py,sha256=4SisJSNGopUS43uRDez9x2VcVv47_eLNMvp7yYIoWH8,10927
+fiddler3/entities/model_artifact.py,sha256=7nWPm5b86E-h8cSNowr7gqopubvAzqwMc4rA4ijD4ig,11028
+fiddler3/entities/model_deployment.py,sha256=g-xXbxdQ99HLpNCHoSuvqk5F4DmDMB7d8HhaW9svbTI,3432
+fiddler3/entities/model_surrogate.py,sha256=IC_JVMMFX-_yGkcvupQg_VAgIoIBhvhO0doHcQg7MD4,2708
+fiddler3/entities/organization.py,sha256=96C-L_GNh0RnwAhqVV2CQuxYK3r61j8OCEOPEE6U8dE,1076
+fiddler3/entities/project.py,sha256=8JR10ghL0KGNBe50APrD24veqIStWp_PwgIARpPx8SY,4578
+fiddler3/entities/user.py,sha256=ev_Xx9QHAdEHYzNDafzQihXOcD8ME5XkpKgc8MiqCnw,1243
+fiddler3/entities/xai.py,sha256=I2tH8XwoblLZd60Ba-8qEMjZMVctYRVJzIrcbc1iWYM,10885
 fiddler3/libs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fiddler3/libs/http_client.py,sha256=TxVrviwehE_FfT61bbkE5Ahw7tgKurJWHqIGsGEN4vk,6581
+fiddler3/libs/http_client.py,sha256=vIJZqdRnGc4WC4PdAlT-gsiMagJWPbgTrGq5sG64eSA,7088
+fiddler3/libs/json_encoder.py,sha256=_D-SKgkyo2DtgM8z8wCd9QSB7VwwFt0KDz-9og9pwSI,330
 fiddler3/libs/semver.py,sha256=3HbXG1S-ABIxL3E0FHSm5OR_YrhYtCB2Q3XJ8-tywts,15995
-fiddler3/schemas/__init__.py,sha256=E435AZxYXSLNkOMdKFjQ7TmXIlFkTui2Q0Du1HpBxe0,304
+fiddler3/schemas/__init__.py,sha256=3X8Is87FXJb2SEeRM2WmeujoIXbo0iTYxGbU1Gi3gHw,502
 fiddler3/schemas/base.py,sha256=upzAmneEz169h_w-UDH_tY0Abo7DeK68YOZ5qVwIMa8,189
-fiddler3/schemas/custom_features.py,sha256=yd_cke-nK1n6s1og9xhpOXyAwHsXsw-g3L2PahcmCJk,3329
-fiddler3/schemas/job.py,sha256=e_MxZ-OHbbJNST5dGc9yVoph5sc-o6tXsFAY4ATBXXE,340
-fiddler3/schemas/model.py,sha256=jcznbvtpV1iiKZsz1Taf8t90qFBFQKzi5PLMyot9g5k,1395
+fiddler3/schemas/baseline.py,sha256=pBnt8J-PBZ4ejEoX5lQDGRLE1a3YQtxGBFwgTPxHkQs,928
+fiddler3/schemas/custom_features.py,sha256=xH5t-Ozkley-bDX08xuMiA0zA0SWWtzGnpECeLM30XM,3542
+fiddler3/schemas/dataset.py,sha256=AXN416sL2S-LlF6VXiJmlO7UXrGOn_X_XHArdErieGE,662
+fiddler3/schemas/deployment_params.py,sha256=XrVCvMfj3Uwd0RFG8exBEvu7rvSI2ifAGBlfPIyjUCU,547
+fiddler3/schemas/filter_query.py,sha256=yInG5FJ88NlPXy8GXQj_Bd7ta_C1n54pdHFdQedpTco,1326
+fiddler3/schemas/job.py,sha256=plqly2vU8mzwwdDcLdcUd3LPBwldIw9VkgbSTcFNXRM,340
+fiddler3/schemas/model.py,sha256=_ec6PDcl8Lonthq6d6e4CaUfxEm9kk-EwARA81ksrHI,1423
+fiddler3/schemas/model_artifact.py,sha256=d2axtyOQq6x0rJGWeCgMn8wcAQ-e2tVw9nLQRdN9YD4,138
+fiddler3/schemas/model_deployment.py,sha256=PnHSmuISLiIl1cNxTWsjOK3pWnIXexcu0dnsFZqs9w8,725
 fiddler3/schemas/model_schema.py,sha256=QtZ5XwL4LC9g2Ia2gpJsimyP-Jq5yemvySym8D3-7yk,1128
 fiddler3/schemas/model_spec.py,sha256=3F1VWVP1NV_i7Kz7Am7so1zLesWFwp9t4vWq_hCZOJw,643
 fiddler3/schemas/model_task_params.py,sha256=zFkTVa2IOdWMgxePH1sWUYWV6uJFqLkR_JrSnoH8eJI,692
-fiddler3/schemas/organization.py,sha256=e8cDA7rsMUIe5vYoEoIWdzHq_pfvVnn_e8aiJGRQE-4,134
-fiddler3/schemas/project.py,sha256=LnJmPz9mxjZkrvcL9YdwaI1V8xknD_fK8GFJYLwauzI,373
+fiddler3/schemas/organization.py,sha256=a7Byp1MWa5tldyyztVd4QFBW1Bx0oAXyENptDG0Haos,282
+fiddler3/schemas/project.py,sha256=DJd2YRyolEBCrdKwAKWBJwtdPsQh3MOHppn5CG4wiNU,381
 fiddler3/schemas/response.py,sha256=jWuUAJXm40UE3i_ZCmfVUXdKY5WLVkrL6G5XLS17KnU,1167
-fiddler3/schemas/server_info.py,sha256=t79g_2ieXZFQEsN7UBiOnV5jsDqvUlPH1Cp9hRITlYk,495
-fiddler3/schemas/user.py,sha256=wlHZtc2x13oKjxMcuauwUmqdsSfI6h__BovUYp2bktc,133
+fiddler3/schemas/server_info.py,sha256=e_uoHVIPJ4tTBTVKNbm3wKoF3mXOfv2HF1MSF9zpgEw,503
+fiddler3/schemas/user.py,sha256=XuUkmXYM2PNOnau5RdYXLb3AfQoI1e7fDorzT2dTLtw,137
+fiddler3/schemas/xai.py,sha256=DnQkICrCJZM6YFTB6z0pa-Rb81VWLbzrYdqWhQ5cp5I,741
 fiddler3/schemas/xai_params.py,sha256=7WbUCBojzZckjOA2NUxnk5y3M2WKKXclSzkt5HBfyUU,313
 fiddler3/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fiddler3/tests/conftest.py,sha256=8NI-g3flCXyEzMBoVthUpYu4aVC4g6UPb-Jm9w0Bdbo,837
-fiddler3/tests/constants.py,sha256=E81j-YwxQMw66cH0WoFntXfcWi9PmDCd35nAndpq0xk,492
+fiddler3/tests/constants.py,sha256=t-HFx7u_8uwdtf7mQShRHu1Ns4U1k8LzTZH4CagznP4,867
 fiddler3/tests/test_connection.py,sha256=QQJ2SDtKKvdPd6du5XDXLwWSNgE9wZs1IR3IU60s7BY,1198
-fiddler3/tests/test_utils.py,sha256=h9ATNh0Q1QiWo6EzhbJzdTjpqO_EQMjmOdPTGrlp-8E,831
+fiddler3/tests/test_json_encoder.py,sha256=DnuyDTBKTq-dYZhY9KWN1OHywCukpBHq1PDBo6koR8E,437
+fiddler3/tests/test_logger.py,sha256=baSk0xtm8JNz0O83A714IR5uO36v_JoKPgDyknr_X4Q,314
+fiddler3/tests/test_utils.py,sha256=Frzk5wftz_MWWhT9rvwOca1vvI4rllsjBA8E1jQ_gOE,1447
 fiddler3/tests/utils.py,sha256=FEDbASW4pYZktdEK2FLnIDyZCwBzpb60m6EzkvOkwSc,335
 fiddler3/tests/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fiddler3/tests/apis/test_baseline.py,sha256=dWvcJ1TPvBjtb7RQwe3LXI72Cs1yb6Zx-PTMixl5l0g,7584
+fiddler3/tests/apis/test_dataset.py,sha256=ub000_6wIOCVcofg7y125p1n4abaiPEO-iP7OvpeLyY,4768
 fiddler3/tests/apis/test_generate_schema.py,sha256=51Xux_Txb2Ica1AKX9794K5LNJ1y569rggbgfWhZLDI,3720
 fiddler3/tests/apis/test_job.py,sha256=4WsB6WoVL4bbK_RgP4e9Wc_DhSF4fCXoFK7wx6mOHQ0,1894
-fiddler3/tests/apis/test_model.py,sha256=sXKqzDwDRq_YpweMyG6qgC3RfhXeA4M1ZWSgBSMbIAQ,9550
-fiddler3/tests/apis/test_project.py,sha256=N2qM9BGtMgWPuwv0IEAT_e1p2kwIoHaLYaOhTz_PMfk,5464
-fiddler3/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-fiddler3/utils/logger.py,sha256=gkFIUa3kGslsZ33oNxc8_PQ5L4z1jyJI4ygG4kbpuVE,189
+fiddler3/tests/apis/test_mixin.py,sha256=-uoeP2v0WMmOpsBoupNCw_BIFRWH1nkSzg4POKNB_J4,2465
+fiddler3/tests/apis/test_model.py,sha256=4z9P951bmuZo8yuD7Vb0bRbOV-stXFyT43N3GX81Asc,12183
+fiddler3/tests/apis/test_model_artifact.py,sha256=piBWhXyVRmN3aYGvUaxkN5jT4dlBwPRm5_LunTq94fc,4997
+fiddler3/tests/apis/test_model_deployment.py,sha256=QLMuNiC9efujd67zQMuDHvF365Jx3NYaYediv4AXftA,2444
+fiddler3/tests/apis/test_model_surrogate.py,sha256=ErFuILpnpQRytteWla4WcqzzOEwH9qrOANm_4-nrWts,4124
+fiddler3/tests/apis/test_project.py,sha256=imhGUyi2hVvMJ4LaRpAoQS8R-fahgD3xboQjjYUvnA0,5987
+fiddler3/tests/apis/test_xai.py,sha256=AxeEZ59opoZHy-4vxVqBoUN3rORIFL-zM-196j7nDUg,21647
+fiddler3/utils/__init__.py,sha256=dq4jUfZTE-0G8P4uYVi2z8oSYG73utqikAy2hPXjBDk,54
+fiddler3/utils/helpers.py,sha256=iFmEQfoebXkSA-mfqh8xlB7-TlBDTOPBPfmP1DhzGgQ,1548
+fiddler3/utils/logger.py,sha256=yyhgUgEKcuyI8bJxyaJSrONxNE9kx6b7n36hya9SbnQ,670
 fiddler3/utils/model_schema_generator.py,sha256=KMBYu24vxIdrrOeYgfu6Wz6awF2le2iUawE2LyGmxqs,8667
+fiddler3/utils/validations.py,sha256=i8NtgrpCsitq6BPa5lygpKDh07oaOXu7PAlCIcMvqzY,408
 fiddler3/utils/version.py,sha256=kCJN8PxmX0_NG2yGtQHyavAyhO6lCt5irCJxkIpLLBk,532
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/test_object_inference.py,sha256=Mj9AOHuU7MCag1fXFj87_d-qFnE4gESx_l1QC7rS00A,5346
@@ -128,6 +159,7 @@ tests/fiddler/test_job.py,sha256=8YGGoJgYL9yJzlT5_YPsf-w_FBasS6EaKH7UY29wn8k,460
 tests/fiddler/test_model.py,sha256=H70vytupFmKSXBjrf_I32VKDfWyLTbO_IhRVe_8O7Cw,7507
 tests/fiddler/test_project.py,sha256=xn_5p85bGNOz6Dh9Y8yP9ZYElHGRcsCniMLVF8B-HGk,6603
 tests/fiddler/test_response_handler.py,sha256=YWhd8QIJrW3nUag-nZ4jutAs1B9eOqQekgUN1vtsbU0,2958
+tests/fiddler/test_segments.py,sha256=XJZJ96SiSdmMZTOKPeeKKTnOkuC_uQDMw2AmG6Or-jI,7984
 tests/fiddler/test_upload_dataset.py,sha256=p7JzcGQkA0jT78S5gKUwtyjbpVDh7xYQg-74SVYp-6s,15299
 tests/fiddler/test_validations.py,sha256=1FUlfXzf1L-DrSth12u4MUBHGGgGAXDCn-x2TS79Y10,581
 tests/fiddler/test_webhook.py,sha256=RKManG4Q1DfsFPURIK_EcOFvF0L7LupXYBER8oX9ly4,4416
@@ -135,8 +167,8 @@ tests/fiddler/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 tests/fiddler/utils/test_general_checks.py,sha256=kxG8n4UdBWXBGchA0SvV7o4t28a7YAc8viorEBpzzcE,1451
 tests/fiddler/utils/test_pandas.py,sha256=7VBh8yJZMVE1bSaUYH0T_qwXpcwXgJ5rI1nL3vGRwjY,8781
 tests/fiddler/utils/tests_utils.py,sha256=kPmMoOlaSIWw6Gk7QnAnn8QJvEyqtd2Rz32kS6RGEc8,1800
-fiddler_client-2.3.0.dev2.dist-info/LICENSE.txt,sha256=w8-LUAb_VLBWSsCNmih0pAqLIicJfGu8OJXpDjkIg_o,559
-fiddler_client-2.3.0.dev2.dist-info/METADATA,sha256=HRap5lgGv8kDLs0oTwEM4ZPM_bbSUzbTg9G5KqFQ524,20200
-fiddler_client-2.3.0.dev2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-fiddler_client-2.3.0.dev2.dist-info/top_level.txt,sha256=d227cAlPARL7zNFhltLEb5Q-04mfc1CJM5-TBDZShlQ,23
-fiddler_client-2.3.0.dev2.dist-info/RECORD,,
+fiddler_client-2.4.0.dev1.dist-info/LICENSE.txt,sha256=w8-LUAb_VLBWSsCNmih0pAqLIicJfGu8OJXpDjkIg_o,559
+fiddler_client-2.4.0.dev1.dist-info/METADATA,sha256=xkmy9cto8DUv4rfiZGgTYfEZoIyu9crjdD2-uRvArgU,20071
+fiddler_client-2.4.0.dev1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+fiddler_client-2.4.0.dev1.dist-info/top_level.txt,sha256=d227cAlPARL7zNFhltLEb5Q-04mfc1CJM5-TBDZShlQ,23
+fiddler_client-2.4.0.dev1.dist-info/RECORD,,

tests/fiddler/test_segments.py

@@ -0,0 +1,227 @@
+from responses import matchers
+from fiddler.schema.segment import Segment
+from fiddler.exceptions import BadRequest
+from tests.fiddler.base import BaseTestCase
+from http import HTTPStatus
+
+
+class TestSegment(BaseTestCase):
+
+    def _get_url(self, uuid: str = None) -> str:
+        base_url = f'{self._url}/segments'
+        if uuid:
+            return f'{base_url}/{uuid}'
+        return base_url
+
+    def test_get_segments(self):
+        response = {
+            "data": {
+                "page_size": 50,
+                "total": 2,
+                "item_count": 2,
+                "page_count": 1,
+                "page_index": 1,
+                "offset": 0,
+                "items": [
+                    {
+                        "project_name": "bank_churn",
+                        "name": "tp_0.8",
+                        "model_name": "churn_classifier",
+                        "definition": "age > 10",
+                        "id": "fbba0596-1d49-4159-a5ea-e1c2f57c9c32",
+                        "organization_name": "test_organization",
+                        "description": "test description",
+                        "extra_field_from_future": "should_not_break",
+                        "created_at": "2021-03-03T18:30:00.000Z",
+                        "created_by": {
+                            "id": "1",
+                            "full_name": "test user",
+                            "email": "testuser@fiddler.ai"
+                        }
+                    },
+                    {
+                        "project_name": "bank_churn",
+                        "name": "tp_0.6",
+                        "model_name": "churn_classifier",
+                        "definition": "credit_score > 600",
+                        "id": "3a352397-a89a-495d-a095-440f1d21a58a",
+                        "organization_name": "test_organization",
+                        "description": "test description",
+                        "created_at": "2021-03-03T18:30:00.000Z",
+                        "created_by": {
+                            "id": "2",
+                            "full_name": "test user",
+                            "email": "testuser@fiddler.ai"
+                        }
+                    }
+                ]
+            },
+            "api_version": "2.0",
+            "kind": "PAGINATED"
+        }
+        url = self._get_url()
+        query_params = {
+            'limit': 300,
+            'offset': 0,
+            'organization_name': 'test_organization',
+            'project_name': 'bank_churn',
+            'model_name': 'churn_classifier',
+        }
+
+        self.requests_mock.get(
+            url, json=response, match=[matchers.query_param_matcher(query_params)]
+        )
+
+        segments = self.client.get_segments(
+            project_id='bank_churn',
+            model_id='churn_classifier',
+        )
+        assert segments == [
+            Segment(
+                id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
+                name='tp_0.8',
+                definition='age > 10',
+                organization_name='test_organization',
+                project_name='bank_churn',
+                model_name='churn_classifier',
+                description='test description',
+                created_at='2021-03-03T18:30:00.000Z',
+                created_by={
+                    "id": "1",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
+            ),
+            Segment(
+                id='3a352397-a89a-495d-a095-440f1d21a58a',
+                name='tp_0.6',
+                definition='credit_score > 600',
+                organization_name='test_organization',
+                project_name='bank_churn',
+                model_name='churn_classifier',
+                description='test description',
+                created_at='2021-03-03T18:30:00.000Z',
+                created_by={
+                    "id": "2",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
+            ),
+        ]
+
+    def test_add_segment(self):
+        response_body = {
+            'data': {
+                'id': 'fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
+            },
+            'api_version': '2.0',
+            'kind': 'NORMAL',
+        }
+
+        url = self._get_url()
+
+        self.requests_mock.post(url, json=response_body)
+
+        segment = self.client.add_segment(
+            name='my segment',
+            definition='age > 10',
+            project_id='bank_churn',
+            model_id='churn_classifier',
+            description='test description',
+        )
+        assert segment == Segment(
+            id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
+            name='my segment',
+            definition='age > 10',
+            organization_name='test_organization',
+            project_name='bank_churn',
+            model_name='churn_classifier',
+            description='test description',
+        )
+
+    def test_add_segment_error(self):
+        response_body = {
+            'error': {
+                'code': 400,
+                'message': 'Column unknown not found in model churn_classifier',
+                'errors': [
+                    {
+                        'reason': 'CustomMetricInvalidColumn',
+                        'message': 'Column unknown not found in model churn_classifier',
+                        'help': ''}
+                ]
+            },
+            'api_version': '2.0',
+            'kind': 'ERROR'
+        }
+
+        url = self._get_url()
+
+        self.requests_mock.post(url, json=response_body, status=HTTPStatus.BAD_REQUEST)
+
+        with self.assertRaises(BadRequest) as context:
+            self.client.add_segment(
+                name='my segment',
+                definition='unknown > 10',
+                project_id='bank_churn',
+                model_id='churn_classifier',
+            )
+        self.assertEqual(
+            context.exception.message,
+            "Column unknown not found in model churn_classifier"
+        )
+
+    def test_get_segment(self):
+        uuid = 'fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        response = {
+            "data": {
+                "project_name": "bank_churn",
+                "name": "tp_0.8",
+                "model_name": "churn_classifier",
+                "definition": "age > 10",
+                "id": "fbba0596-1d49-4159-a5ea-e1c2f57c9c32",
+                "organization_name": "test_organization",
+                "description": "test description",
+                "extra_field_from_future": "should_not_break",
+                "created_at": "2021-03-03T18:30:00.000Z",
+                "created_by": {
+                    "id": "1",
+                    "full_name": "test user",
+                    "email": "testuser@fiddler.ai"
+                }
+            },
+            "api_version": "2.0",
+            "kind": "NORMAL"
+        }
+        url = self._get_url(uuid)
+
+        self.requests_mock.get(url, json=response)
+        cm = self.client.get_segment(
+            segment_id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        )
+        assert cm == Segment(
+            id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32',
+            name='tp_0.8',
+            definition='age > 10',
+            organization_name='test_organization',
+            project_name='bank_churn',
+            model_name='churn_classifier',
+            description='test description',
+            created_at='2021-03-03T18:30:00.000Z',
+            created_by={
+                "id": "1",
+                "full_name": "test user",
+                "email": "testuser@fiddler.ai"
+            }
+        )
+
+    def test_delete_segment(self):
+        uuid = 'fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        url = self._get_url(uuid)
+
+        self.requests_mock.delete(url)
+
+        self.client.delete_segment(
+            segment_id='fbba0596-1d49-4159-a5ea-e1c2f57c9c32'
+        )
+        self.assertEqual(len(self.requests_mock.calls), 1)