arize 8.0.0a22__tar.gz → 8.0.0a23__tar.gz

arize-8.0.0a23/LICENSE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

arize-8.0.0a23/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2020, Arize AI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

{arize-8.0.0a22 → arize-8.0.0a23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arize
-Version: 8.0.0a22
+Version: 8.0.0a23
 Summary: A helper library to interact with Arize AI APIs
 Project-URL: Homepage, https://arize.com
 Project-URL: Documentation, https://docs.arize.com/arize
@@ -9,8 +9,9 @@ Project-URL: Source, https://github.com/Arize-ai/client_python
 Project-URL: Changelog, https://github.com/Arize-ai/client_python/blob/main/CHANGELOG.md
 Author-email: Arize AI <support@arize.com>
 Maintainer-email: Arize AI <support@arize.com>
-License: BSD
-License-File: LICENSE.md
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
 Keywords: Arize,Evaluations,Explainability,LLM,Monitoring,Observability,Tracing
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers

{arize-8.0.0a22 → arize-8.0.0a23}/pyproject.toml

@@ -3,7 +3,8 @@ name = "arize"
 description = "A helper library to interact with Arize AI APIs"
 readme = "README.md"
 requires-python = ">=3.10"
-license = { text = "BSD" }
+license = { text = "Apache-2.0" }
+license-files = ["LICENSE", "NOTICE"]
 keywords = [
     "Arize",
     "Observability",
@@ -14,10 +15,10 @@ keywords = [
     "Evaluations",
 ]
 authors = [
-  { name = "Arize AI", email = "support@arize.com" },
+    { name = "Arize AI", email = "support@arize.com" }
 ]
 maintainers = [
-  { name = "Arize AI", email = "support@arize.com" },
+    { name = "Arize AI", email = "support@arize.com" }
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",
@@ -48,7 +49,7 @@ dynamic = ["version"]
 [project.optional-dependencies]
 dev = [
     "pytest==8.4.2",
-    "ruff==0.13.2",
+    "ruff==0.13.2"
 ]
 spans = [
     "openinference-semantic-conventions>=0.1.21, <1",
@@ -61,7 +62,7 @@ spans = [
 ]
 ml-stream = [
     "requests_futures>=1.0.0, <2",
-    "protobuf>=4.21.0,<6",
+    "protobuf>=4.21.0,<6"
 ]
 ml-batch = [
     "pandas>=1.0.0,<3",
@@ -83,7 +84,7 @@ datasets-experiments = [
     # "opentelemetry-proto>=1.38.0",
 ]
 mimic-explainer = [
-    "interpret-community[mimic]>=0.22.0,<1",
+    "interpret-community[mimic]>=0.22.0,<1"
 ]
 auto-embeddings = [
     "Pillow>=8.4.0, <11",
@@ -118,7 +119,7 @@ packages = ["src/arize"]
 [tool.hatch.build.targets.sdist]
 exclude = [
     "tests",
-    "docs",
+    "docs"
 ]
 
 
@@ -126,12 +127,15 @@ exclude = [
 include = '\.pyi?$'
 exclude = '(_pb2\.py$|docs/source/.*\.py)'
 
+# TODO(Kiko): Revisit ruff ignores
 [tool.ruff]
-target-version = "py37"
+target-version = "py310"
 line-length = 80
 exclude = [
     "dist/",
+    "testing_notebooks/",
     "__pycache__",
+    "src/arize/_generated/**/*.py",
     "*_pb2.py*",
     "*_pb2_grpc.py*",
     "*.pyi",
@@ -143,27 +147,35 @@ line-ending = "native"
 
 [tool.ruff.lint]
 select = [
-    # pycodestyle Error
-    "E",
-    # pycodestyle Warning
-    "W",
-    # Pyflakes
-    "F",
-    # pyupgrade
-    "UP",
-    # flake8-bugbear
-    "B",
-    # flake8-simplify
-    "SIM",
-    # isort
-    "I",
-    # TODO: Enable pydocstyle when ready for API docs
-    # # pydocstyle
-    # "D",
-]
-ignore= [
-    "D203", # Do not use a blank line to separate the docstring from the class definition,
-    "D212", # The summary line should be located on the second physical line of the docstring
+    # Core correctness & style
+    # ------------------------
+    "E",   # pycodestyle errors (syntax, indentation, whitespace)
+    "W",   # pycodestyle warnings (less severe style issues)
+    "F",   # Pyflakes (unused imports, undefined names, etc.)
+    "UP",  # pyupgrade (modernize syntax for your Python version)
+    "B",   # flake8-bugbear (likely bugs and design problems)
+    "SIM", # flake8-simplify (simpler / clearer code patterns)
+    "I",   # isort (import ordering)
+
+    # Typing & documentation
+    # ------------------------
+    "ANN", # flake8-annotations (enforce type annotations)
+    "D",   # pydocstyle (docstring conventions for public APIs)
+    "TCH", # flake8-type-checking (TYPE_CHECKING import hygiene)
+
+    # Recommended for SDKs
+    # ------------------------
+    "RUF",  # Ruff-native rules (high-signal correctness & footguns)
+    "C4",   # flake8-comprehensions (cleaner comprehensions)
+    "PIE",  # flake8-pie (small correctness & readability improvements)
+    "PERF", # perflint (common performance pitfalls)
+    "DTZ",  # flake8-datetimez (timezone-aware datetime usage)
+    "TRY",  # tryceratops (better exception handling patterns)
+    "RET",  # flake8-return (return consistency)
+    "S",    # flake8-bandit (basic security issues; tune via ignores)
+]
+ignore = [
+    "TRY003",   # Put long / detailed messages inside the exception class
 ]
 
 [tool.ruff.lint.isort]

{arize-8.0.0a22 → arize-8.0.0a23}/src/arize/__init__.py

@@ -1,9 +1,12 @@
+"""Arize SDK for model observability and LLM tracing."""
+
 import logging
 from collections.abc import Mapping
 
 from arize._generated.api_client import models
 from arize.client import ArizeClient
 from arize.config import SDKConfiguration
+from arize.regions import Region
 
 # Attach a NullHandler by default in the top-level package
 # so that if no configuration is installed, nothing explodes.
@@ -14,23 +17,27 @@ try:
     from .logging import auto_configure_from_env
 
     auto_configure_from_env()
-except Exception:
-    # Never let logging config crash imports
+except Exception:  # noqa: S110
+    # Intentionally silent: logging configuration is optional and should never
+    # prevent SDK initialization. Users can configure logging explicitly if needed.
     pass
 
-__all__ = ["ArizeClient", "SDKConfiguration"]
+__all__ = [
+    "ArizeClient",
+    "Region",
+    "SDKConfiguration",
+]
 
 
-def make_to_df(field_name: str):
+def make_to_df(field_name: str) -> object:
     def to_df(
-        self,
+        self: object,
         by_alias: bool = False,
         exclude_none: str | bool = False,
         json_normalize: bool = False,
         convert_dtypes: bool = True,
-    ):
-        """
-        Convert a list of objects to a pandas DataFrame.
+    ) -> object:
+        """Convert a list of objects to a pandas DataFrame.
 
         Behavior:
           - If an item is a Pydantic v2 model, use `.model_dump(by_alias=...)`.
@@ -85,6 +92,7 @@ def make_to_df(field_name: str):
 
 
 models.DatasetsList200Response.to_df = make_to_df("datasets")  # type: ignore[attr-defined]
-models.DatasetsListExamples200Response.to_df = make_to_df("examples")  # type: ignore[attr-defined]
+models.DatasetsExamplesList200Response.to_df = make_to_df("examples")  # type: ignore[attr-defined]
 models.ExperimentsList200Response.to_df = make_to_df("experiments")  # type: ignore[attr-defined]
 models.ExperimentsRunsList200Response.to_df = make_to_df("experiment_runs")  # type: ignore[attr-defined]
+models.ProjectsList200Response.to_df = make_to_df("projects")  # type: ignore[attr-defined]

{arize-8.0.0a22 → arize-8.0.0a23}/src/arize/_exporter/client.py

@@ -2,7 +2,6 @@
 import logging
 from dataclasses import dataclass
 from datetime import datetime
-from typing import List, Tuple
 
 import pandas as pd
 import pyarrow.parquet as pq
@@ -16,7 +15,7 @@ from arize._exporter.validation import (
     validate_input_type,
     validate_start_end_time,
 )
-from arize._generated.protocol.flight import export_pb2
+from arize._generated.protocol.flight import flight_pb2
 from arize.logging import CtxAdapter
 from arize.types import Environments, SimilaritySearchParams
 from arize.utils.dataframe import reset_dataframe_index
@@ -33,19 +32,20 @@ class ArizeExportClient:
         space_id: str,
         model_id: str,
         environment: Environments,
-        start_time: str | datetime,
-        end_time: str | datetime,
+        start_time: datetime,
+        end_time: datetime,
         where: str = "",
-        columns: List | None = None,
+        columns: list | None = None,
         similarity_search_params: SimilaritySearchParams | None = None,
         model_version: str = "",
         batch_id: str = "",
         include_actuals: bool = False,
         stream_chunk_size: int | None = None,
-    ):
-        """
-        Exports data of a specific model in the Arize platform to a pandas dataframe for a defined
-        time interval and model environment, optionally by model version and/or batch id.
+    ) -> object:
+        """Exports data of a specific model in the Arize platform to a pandas dataframe.
+
+        The export covers a defined time interval and model environment, and can
+        optionally be filtered by model version and/or batch id.
 
         Args:
             space_id (str): The id for the space where to export models from, can be retrieved from
@@ -104,14 +104,14 @@ class ArizeExportClient:
             return pd.DataFrame()
         progress_bar = self._get_progress_bar(num_recs)
         list_of_df = []
-        while True:
-            try:
+        try:
+            while True:
                 flight_batch = stream_reader.read_chunk()
                 batch_df = flight_batch.data.to_pandas()
                 list_of_df.append(batch_df)
                 progress_bar.update(batch_df.shape[0])
-            except StopIteration:
-                break
+        except StopIteration:
+            pass
         progress_bar.close()
         df = pd.concat(list_of_df)
         null_columns = df.columns[df.isnull().all()]
@@ -139,16 +139,17 @@ class ArizeExportClient:
         start_time: datetime,
         end_time: datetime,
         where: str = "",
-        columns: List | None = None,
+        columns: list | None = None,
         similarity_search_params: SimilaritySearchParams | None = None,
         model_version: str = "",
         batch_id: str = "",
         include_actuals: bool = False,
         stream_chunk_size: int | None = None,
     ) -> None:
-        """
-        Exports data of a specific model in the Arize platform to a parquet file for a defined time
-        interval and model environment, optionally by model version and/or batch id.
+        """Exports data of a specific model in the Arize platform to a parquet file.
+
+        The export covers a defined time interval and model environment, and can
+        optionally be filtered by model version and/or batch id.
 
         Args:
             path (str): path to the file to store exported data. File must be in parquet format and
@@ -208,17 +209,17 @@ class ArizeExportClient:
             stream_chunk_size=stream_chunk_size,
         )
         if stream_reader is None:
-            return None
+            return
         progress_bar = self._get_progress_bar(num_recs)
         with pq.ParquetWriter(path, schema=stream_reader.schema) as writer:
-            while True:
-                try:
+            try:
+                while True:
                     flight_batch = stream_reader.read_chunk()
                     record_batch = flight_batch.data
                     writer.write_batch(record_batch)
                     progress_bar.update(record_batch.num_rows)
-                except StopIteration:
-                    break
+            except StopIteration:
+                pass
         progress_bar.close()
 
     def _get_stream_reader(
@@ -233,9 +234,9 @@ class ArizeExportClient:
         batch_id: str = "",
         where: str = "",
         similarity_search_params: SimilaritySearchParams | None = None,
-        columns: List | None = None,
+        columns: list | None = None,
         stream_chunk_size: int | None = None,
-    ) -> Tuple[flight.FlightStreamReader, int]:
+    ) -> tuple[flight.FlightStreamReader | None, int]:
         # Bind common context for this operation
         log = CtxAdapter(
             logger,
@@ -273,7 +274,7 @@ class ArizeExportClient:
         validate_start_end_time(start_time, end_time)
 
         # Create query descriptor
-        query_descriptor = export_pb2.RecordQueryDescriptor(
+        query_descriptor = flight_pb2.RecordQueryDescriptor(
             space_id=space_id,
             model_id=model_id,
             environment=environment.name,
@@ -289,9 +290,11 @@ class ArizeExportClient:
                 else None
             ),
             projected_columns=columns if columns else [],
-            stream_chunk_size=Int64Value(value=stream_chunk_size)
-            if stream_chunk_size is not None
-            else None,
+            stream_chunk_size=(
+                Int64Value(value=stream_chunk_size)
+                if stream_chunk_size is not None
+                else None
+            ),
         )
 
         try:
@@ -306,17 +309,24 @@ class ArizeExportClient:
                 logger.warning("Query returns no data")
                 return None, 0
             logger.debug("Ticket: %s", flight_info.endpoints[0].ticket)
-
-            # Retrieve the result set as flight stream reader
-            reader = self.flight_client.do_get(flight_info.endpoints[0].ticket)
-            return reader, flight_info.total_records
         except Exception as e:
             msg = f"Error getting flight info or do_get: {e}"
-            logger.error(msg)
+            logger.exception(msg)
             raise RuntimeError(msg) from e
+        # Retrieve the result set as flight stream reader
+        reader = self.flight_client.do_get(flight_info.endpoints[0].ticket)
+        return reader, flight_info.total_records
 
     @staticmethod
-    def _get_progress_bar(num_recs):
+    def _get_progress_bar(num_recs: int) -> tqdm:
+        """Create a progress bar for export operations.
+
+        Args:
+            num_recs: Total number of records to export.
+
+        Returns:
+            A tqdm progress bar configured for data export display.
+        """
         return tqdm(
             total=num_recs,
             desc=f"  exporting {num_recs} rows",
@@ -329,8 +339,17 @@ class ArizeExportClient:
 
 def _get_pb_similarity_search_params(
     similarity_params: SimilaritySearchParams,
-) -> export_pb2.SimilaritySearchParams:
-    proto_params = export_pb2.SimilaritySearchParams()
+) -> flight_pb2.SimilaritySearchParams:
+    """Convert SimilaritySearchParams to protocol buffer format.
+
+    Args:
+        similarity_params: Similarity search parameters containing search column name,
+            threshold, and reference examples.
+
+    Returns:
+        A protocol buffer SimilaritySearchParams object for Flight requests.
+    """
+    proto_params = flight_pb2.SimilaritySearchParams()
     proto_params.search_column_name = similarity_params.search_column_name
     proto_params.threshold = similarity_params.threshold
     for ref in similarity_params.references: