arize 8.0.0a8__tar.gz → 8.0.0a10__tar.gz

{arize-8.0.0a8 → arize-8.0.0a10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arize
-Version: 8.0.0a8
+Version: 8.0.0a10
 Summary: A helper library to interact with Arize AI APIs
 Project-URL: Homepage, https://arize.com
 Project-URL: Documentation, https://docs.arize.com/arize
@@ -30,10 +30,13 @@ Requires-Dist: numpy>=2.0.0
 Provides-Extra: dev
 Requires-Dist: pytest==8.4.2; extra == 'dev'
 Requires-Dist: ruff==0.13.2; extra == 'dev'
+Provides-Extra: mimic-explainer
+Requires-Dist: interpret-community[mimic]<1,>=0.22.0; extra == 'mimic-explainer'
 Provides-Extra: ml-batch
 Requires-Dist: pandas<3,>=1.0.0; extra == 'ml-batch'
 Requires-Dist: protobuf<6,>=4.21.0; extra == 'ml-batch'
 Requires-Dist: pyarrow>=0.15.0; extra == 'ml-batch'
+Requires-Dist: requests<3,>=2.0.0; extra == 'ml-batch'
 Requires-Dist: tqdm; extra == 'ml-batch'
 Provides-Extra: ml-stream
 Requires-Dist: protobuf<6,>=4.21.0; extra == 'ml-stream'
@@ -44,6 +47,7 @@ Requires-Dist: opentelemetry-semantic-conventions<1,>=0.43b0; extra == 'spans'
 Requires-Dist: pandas<3,>=1.0.0; extra == 'spans'
 Requires-Dist: protobuf<6,>=4.21.0; extra == 'spans'
 Requires-Dist: pyarrow>=0.15.0; extra == 'spans'
+Requires-Dist: requests<3,>=2.0.0; extra == 'spans'
 Requires-Dist: tqdm; extra == 'spans'
 Description-Content-Type: text/markdown
 

{arize-8.0.0a8 → arize-8.0.0a10}/pyproject.toml

@@ -34,8 +34,8 @@ classifiers = [
     "Topic :: System :: Monitoring",
 ]
 dependencies = [
+    "numpy>=2.0.0", # For vector embeddings
     "lazy-imports",
-    "numpy>=2.0.0",
     # "requests_futures==1.0.0",
     # "googleapis_common_protos>=1.51.0,<2",
     # "protobuf>=4.21.0,<6",
@@ -57,7 +57,8 @@ spans = [
     "pandas>=1.0.0,<3",
     "protobuf>=4.21.0,<6",
     "pyarrow>=0.15.0",
-    "tqdm",
+    "requests>=2.0.0, <3", # For posting pyarrow files
+    "tqdm", # For export progress bars
 ]
 ml-stream = [
     "requests_futures>=1.0.0, <2",
@@ -65,13 +66,17 @@ ml-stream = [
 ]
 ml-batch = [
     "pandas>=1.0.0,<3",
-    "pyarrow>=0.15.0",
     "protobuf>=4.21.0,<6",
-    "tqdm",
+    "pyarrow>=0.15.0",
+    "requests>=2.0.0, <3", # For posting pyarrow files
+    "tqdm", # For export progress bars
 ]
 # datasets-experiments = [
 #     "pydantic",
 # ]
+mimic-explainer = [
+    "interpret-community[mimic]>=0.22.0,<1",
+]
 
 [project.urls]
 Homepage = "https://arize.com"

{arize-8.0.0a8 → arize-8.0.0a10}/src/arize/client.py

@@ -65,6 +65,7 @@ class ArizeClient(LazySubclientsMixin):
                 "opentelemetry",
                 "pandas",
                 "pyarrow",
+                "requests",
                 "tqdm",
             ),
         ),

{arize-8.0.0a8 → arize-8.0.0a10}/src/arize/models/client.py

@@ -52,7 +52,6 @@ from arize.types import (
     is_list_of,
 )
 from arize.utils.casting import cast_dictionary, cast_typed_columns
-from arize.utils.dataframe import remove_extraneous_columns
 
 if TYPE_CHECKING:
     import concurrent.futures as cf
@@ -75,11 +74,17 @@ _STREAM_EXTRA = "ml-stream"
 
 _BATCH_DEPS = (
     "pandas",
-    "pyarrow",
     "google.protobuf",
+    "pyarrow",
+    "requests",
     "tqdm",
 )
 _BATCH_EXTRA = "ml-batch"
+_MIMIC_DEPS = (
+    "interpret_community.mimic",
+    "sklearn.preprocessing",
+)
+_MIMIC_EXTRA = "mimic-explainer"
 
 
 class MLModelsClient:
@@ -116,7 +121,6 @@ class MLModelsClient:
         timeout: float | None = None,
     ) -> cf.Future:
         require(_STREAM_EXTRA, _STREAM_DEPS)
-
         from arize._generated.protocol.rec import public_pb2 as pb2
         from arize.utils.proto import (
             get_pb_dictionary,
@@ -464,6 +468,7 @@ class MLModelsClient:
 
         from arize.models.batch_validation.validator import Validator
         from arize.utils.arrow import post_arrow_table
+        from arize.utils.dataframe import remove_extraneous_columns
         from arize.utils.proto import get_pb_schema, get_pb_schema_corpus
 
         # This method requires a space_id and project_name
@@ -544,17 +549,10 @@ class MLModelsClient:
             dataframe = dataframe.astype(cat_str_map)
 
         if surrogate_explainability:
-            logger.debug("Running surrogate_explainability.")
+            require(_MIMIC_EXTRA, _MIMIC_DEPS)
+            from arize.models.surrogate_explainer.mimic import Mimic
 
-            try:
-                # WARNING: MIMIC EXPLAINER IS NOT DONE
-                from arize.pandas.surrogate_explainer.mimic import Mimic
-            except ImportError:
-                raise ImportError(
-                    "To enable surrogate explainability, "
-                    "the arize module must be installed with the MimicExplainer option: pip "
-                    "install 'arize[MimicExplainer]'."
-                ) from None
+            logger.debug("Running surrogate_explainability.")
             if schema.shap_values_column_names:
                 logger.info(
                     "surrogate_explainability=True has no effect "

arize-8.0.0a10/src/arize/models/surrogate_explainer/mimic.py

@@ -0,0 +1,164 @@
+from __future__ import annotations
+
+import random
+import string
+from dataclasses import replace
+from typing import TYPE_CHECKING, Callable, Tuple
+
+import numpy as np
+import pandas as pd
+from interpret_community.mimic.mimic_explainer import (
+    LGBMExplainableModel,
+    MimicExplainer,
+)
+from sklearn.preprocessing import LabelEncoder
+
+from arize.types import (
+    CATEGORICAL_MODEL_TYPES,
+    NUMERIC_MODEL_TYPES,
+    ModelTypes,
+)
+
+if TYPE_CHECKING:
+    from arize.types import Schema
+
+
+class Mimic:
+    _testing = False
+
+    def __init__(self, X: pd.DataFrame, model_func: Callable):
+        self.explainer = MimicExplainer(
+            model_func,
+            X,
+            LGBMExplainableModel,
+            augment_data=False,
+            is_function=True,
+        )
+
+    def explain(self, X: pd.DataFrame) -> pd.DataFrame:
+        return pd.DataFrame(
+            self.explainer.explain_local(X).local_importance_values,
+            columns=X.columns,
+            index=X.index,
+        )
+
+    @staticmethod
+    def augment(
+        df: pd.DataFrame, schema: Schema, model_type: ModelTypes
+    ) -> Tuple[pd.DataFrame, Schema]:
+        features = schema.feature_column_names
+        X = df[features]
+
+        if X.shape[1] == 0:
+            return df, schema
+
+        if model_type in CATEGORICAL_MODEL_TYPES:
+            if not schema.prediction_score_column_name:
+                raise ValueError(
+                    "To calculate surrogate explainability, "
+                    f"prediction_score_column_name must be specified in schema for {model_type}."
+                )
+
+            y_col_name = schema.prediction_score_column_name
+            y = df[y_col_name].to_numpy()
+
+            _min, _max = np.min(y), np.max(y)
+            if not 0 <= _min <= 1 or not 0 <= _max <= 1:
+                raise ValueError(
+                    f"To calculate surrogate explainability for {model_type}, "
+                    f"prediction scores must be between 0 and 1, but current "
+                    f"prediction scores range from {_min} to {_max}."
+                )
+
+            # model func requires 1 positional argument
+            def model_func(_):  # type: ignore
+                return np.column_stack((1 - y, y))
+
+        elif model_type in NUMERIC_MODEL_TYPES:
+            y_col_name = schema.prediction_label_column_name
+            if schema.prediction_score_column_name is not None:
+                y_col_name = schema.prediction_score_column_name
+            y = df[y_col_name].to_numpy()
+
+            _finite_count = np.isfinite(y).sum()
+            if len(y) - _finite_count:
+                raise ValueError(
+                    f"To calculate surrogate explainability for {model_type}, "
+                    f"predictions must not contain NaN or infinite values, but "
+                    f"{len(y) - _finite_count} NaN or infinite value(s) are found in {y_col_name}."
+                )
+
+            # model func requires 1 positional argument
+            def model_func(_):  # type: ignore
+                return y
+
+        else:
+            raise ValueError(
+                "Surrogate explainability is not supported for the specified "
+                f"model type {model_type}."
+            )
+
+        # Column name mapping between features and feature importance values.
+        # This is used to augment the schema.
+        col_map = {
+            ft: f"{''.join(random.choices(string.ascii_letters, k=8))}"
+            for ft in features
+        }
+        aug_schema = replace(schema, shap_values_column_names=col_map)
+
+        # Limit the total number of "cells" to 20M, unless it results in too few or
+        # too many rows. This is done to keep the runtime low. Records not sampled
+        # have feature importance values set to 0.
+        samp_size = min(
+            len(X), min(100_000, max(1_000, 20_000_000 // X.shape[1]))
+        )
+
+        if samp_size < len(X):
+            _mask = np.zeros(len(X), dtype=int)
+            _mask[:samp_size] = 1
+            np.random.shuffle(_mask)
+            _mask = _mask.astype(bool)
+            X = X[_mask]
+            y = y[_mask]
+
+        # Replace all pd.NA values with np.nan values
+        for col in X.columns:
+            if X[col].isna().any():
+                X[col] = X[col].astype(object).where(~X[col].isna(), np.nan)
+
+        # Apply integer encoding to non-numeric columns.
+        # Currently training and explaining detasets are the same, but
+        # this can be changed in the future. The student model can be
+        # fitted on a much larger dataset since it takes a lot less time.
+        X = pd.concat(
+            [
+                X.select_dtypes(exclude=[object, "string"]),
+                pd.DataFrame(
+                    {
+                        name: LabelEncoder().fit_transform(data)
+                        for name, data in X.select_dtypes(
+                            include=[object, "string"]
+                        ).items()
+                    },
+                    index=X.index,
+                ),
+            ],
+            axis=1,
+        )
+
+        aug_df = pd.concat(
+            [
+                df,
+                Mimic(X, model_func).explain(X).rename(col_map, axis=1),
+            ],
+            axis=1,
+        )
+
+        # Fill null with zero so they're not counted as missing records by server
+        if not Mimic._testing:
+            aug_df.fillna({c: 0 for c in col_map.values()}, inplace=True)
+
+        return (
+            aug_df,
+            aug_schema,
+        )

{arize-8.0.0a8 → arize-8.0.0a10}/src/arize/utils/arrow.py

@@ -8,11 +8,12 @@ import tempfile
 from typing import TYPE_CHECKING, Any, Dict
 
 import pyarrow as pa
-import requests
 
 from arize.logging import get_arize_project_url, log_a_list
 
 if TYPE_CHECKING:
+    import requests
+
     from arize._generated.protocol.rec import public_pb2 as pb2
 
 logger = logging.getLogger(__name__)
@@ -27,6 +28,9 @@ def post_arrow_table(
     verify: bool,
     tmp_dir: str = "",
 ) -> requests.Response:
+    # We import here to avoid depending onn requests for all arrow utils
+    import requests
+
     logger.debug("Preparing to log Arrow table via file upload")
     logger.debug(
         "Preparing to log Arrow table via file upload",
@@ -71,15 +75,17 @@ def post_arrow_table(
             "Uploading file to Arize",
             extra={"path": outfile, "size_bytes": _filesize(outfile)},
         )
-        resp = _post_file(
-            files_url=files_url,
-            path=outfile,
-            headers=headers,
-            timeout=timeout,
-            verify=verify,
-        )
-        _maybe_log_project_url(resp)
-        return resp
+        # Post file
+        with open(outfile, "rb") as f:
+            resp = requests.post(
+                files_url,
+                timeout=timeout,
+                data=f,
+                headers=headers,
+                verify=verify,
+            )
+            _maybe_log_project_url(resp)
+            return resp
     finally:
         if tdir is not None:
             try:
@@ -98,23 +104,6 @@ def post_arrow_table(
                 )
 
 
-def _post_file(
-    files_url: str,
-    path: str,
-    headers: Dict[str, str],
-    timeout: float | None,
-    verify: bool,
-) -> requests.Response:
-    with open(path, "rb") as f:
-        return requests.post(
-            files_url,
-            timeout=timeout,
-            data=f,
-            headers=headers,
-            verify=verify,
-        )
-
-
 def append_to_pyarrow_metadata(
     pa_schema: pa.Schema, new_metadata: Dict[str, Any]
 ):

arize-8.0.0a10/src/arize/version.py

@@ -0,0 +1 @@
+__version__ = "8.0.0a10"

arize-8.0.0a8/src/arize/version.py

@@ -1 +0,0 @@
-__version__ = "8.0.0a8"