arize 8.0.0a3__py3-none-any.whl → 8.0.0a5__py3-none-any.whl

arize/version.py

@@ -1 +1 @@
-__version__ = "8.0.0a3"
+__version__ = "8.0.0a5"

{arize-8.0.0a3.dist-info → arize-8.0.0a5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arize
-Version: 8.0.0a3
+Version: 8.0.0a5
 Summary: A helper library to interact with Arize AI APIs
 Project-URL: Homepage, https://arize.com
 Project-URL: Documentation, https://docs.arize.com/arize
@@ -65,7 +65,24 @@ Description-Content-Type: text/markdown
 
 ---
 
-## Overview
+# Table of Contents <!-- omit in toc -->
+
+- [Overview](#overview)
+- [Key Features](#key-features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Instrumentation](#instrumentation)
+  - [Operations on Spans](#operations-on-spans)
+    - [Logging spans](#logging-spans)
+    - [Update spans Evaluations, Annotations, and Metadata](#update-spans-evaluations-annotations-and-metadata)
+    - [Exporting spans](#exporting-spans)
+  - [Operations on ML Models](#operations-on-ml-models)
+    - [Stream log ML Data for a Classification use-case](#stream-log-ml-data-for-a-classification-use-case)
+    - [Log a batch of ML Data for a Classification use-case](#log-a-batch-of-ml-data-for-a-classification-use-case)
+    - [Exporting ML Data](#exporting-ml-data)
+- [Community](#community)
+
+# Overview
 
 A helper package to interact with Arize AI APIs.
 
@@ -78,7 +95,7 @@ Arize has both Enterprise and OSS products to support this goal:
 
 We log over 1 trillion inferences and spans, 10 million evaluation runs, and 2 million OSS downloads every month. 
 
-## Key Features
+# Key Features
 - [**_Tracing_**](https://docs.arize.com/arize/observe/tracing) - Trace your LLM application's runtime using OpenTelemetry-based instrumentation.
 - [**_Evaluation_**](https://docs.arize.com/arize/evaluate/online-evals) - Leverage LLMs to benchmark your application's performance using response and retrieval evals.
 - [**_Datasets_**](https://docs.arize.com/arize/develop/datasets) - Create versioned datasets of examples for experimentation, evaluation, and fine-tuning.
@@ -86,7 +103,7 @@ We log over 1 trillion inferences and spans, 10 million evaluation runs, and 2 m
 - [**_Playground_**](https://docs.arize.com/arize/develop/prompt-playground)- Optimize prompts, compare models, adjust parameters, and replay traced LLM calls.
 - [**_Prompt Management_**](https://docs.arize.com/arize/develop/prompt-hub)- Manage and test prompt changes systematically using version control, tagging, and experimentation.
 
-## Installation
+# Installation
 
 Install Arize (version 8 is currently under alpha release) via `pip` or `conda`:
 
@@ -99,9 +116,9 @@ where `x` denotes the specific alpha release. Install the `arize-otel` package f
 pip install arize-otel
 ```
 
-## Usage
+# Usage
   
-### Instrumentation
+## Instrumentation
 
 See [arize-otel in PyPI](https://pypi.org/project/arize-otel/):
 
@@ -120,13 +137,14 @@ tracer_provider = register(
 OpenAIInstrumentor().instrument(tracer_provider=tracer_provider)
 ```
 
-
-### Logging Spans, Evaluations, and Annotations
+## Operations on Spans
 
 Use `arize.spans` to interact with spans: log spans into Arize, update the span's evaluations, annotations and metadata in bulk. 
 
 > **WARNING**: This is currently under an alpha release. Install with `pip install arize==8.0.0ax` where the `x` denotes the specific alpha version. Check the [pre-releases](https://pypi.org/project/arize/#history) page in PyPI.
 
+### Logging spans
+
 ```python
 from arize import ArizeClient
 
@@ -138,26 +156,173 @@ client.spans.log(
     space_id=SPACE_ID,
     project_name=PROJECT_NAME,
     dataframe=spans_df,
-    evals_df=evals_df, # Optionally pass the evaluations together with the spans
+    # evals_df=evals_df, # Optionally pass the evaluations together with the spans
 )
+```
+
+### Update spans Evaluations, Annotations, and Metadata
+
+```python
+from arize import ArizeClient
+
+client = ArizeClient(api_key=API_KEY)
+SPACE_ID = "<your-space-id>"
+PROJECT_NAME = "<your-project-name>"
 
 client.spans.update_evaluations(
+    space_id=SPACE_ID,
+    project_name=PROJECT_NAME,
     dataframe=evals_df,
-    project_name="your-llm-project",
+    # force_http=... # Optionally pass force_http to update evaluations via HTTP instead of gRPC, defaults to False
 )
 
 client.spans.update_annotations(
+    space_id=SPACE_ID,
+    project_name=PROJECT_NAME,
     dataframe=annotations_df,
-    project_name="your-llm-project",
 )
 
 client.spans.update_metadata(
-    dataframe=annotations_df,
-    project_name="your-llm-project",
+    space_id=SPACE_ID,
+    project_name=PROJECT_NAME,
+    dataframe=metadata_df,
+)
+```
+
+### Exporting spans
+
+Use the `export_to_df` or `export_to_parquet` to export large amounts of spans from Arize.
+
+```python
+from arize import ArizeClient
+from datetime import datetime
+
+FMT  = "%Y-%m-%d"
+start_time = datetime.strptime("2024-01-01",FMT)
+end_time = datetime.strptime("2026-01-01",FMT)
+
+client = ArizeClient(api_key=API_KEY)
+SPACE_ID = "<your-space-id>"
+PROJECT_NAME = "<your-project-name>"
+
+df = client.spans.export_to_df(
+    space_id=SPACE_ID,
+    project_name=PROJECT_NAME,
+    start_time=start_time,
+    end_time=end_time,
+)
+```
+
+## Operations on ML Models
+
+Use `arize.models` to interact with ML models: log ML data (traininv, validation, production) into Arize, either streaming or in batches.
+
+> **WARNING**: This is currently under an alpha release. Install with `pip install arize==8.0.0ax` where the `x` denotes the specific alpha version. Check the [pre-releases](https://pypi.org/project/arize/#history) page in PyPI.
+
+### Stream log ML Data for a Classification use-case
+
+```python
+from arize import ArizeClient
+from arize.types import ModelTypes, Environments
+
+client = ArizeClient(api_key=API_KEY)
+SPACE_ID = "<your-space-id>"
+MODEL_NAME = "<your-model-name>"
+
+features=...
+embedding_features=...
+
+response = client.models.log_stream(
+    space_id=SPACE_ID,
+    model_name=MODEL_NAME,
+    model_type=ModelTypes.SCORE_CATEGORICAL,
+    environment=Environments.PRODUCTION,
+    prediction_label=("not fraud",0.3),
+    actual_label=("fraud",1.0),
+    features=features,
+    embedding_features=embedding_features,
+)
+```
+
+### Log a batch of ML Data for a Classification use-case
+
+```python
+from arize import ArizeClient
+from arize.types import ModelTypes, Environments
+
+client = ArizeClient(api_key=API_KEY)
+SPACE_ID = "<your-space-id>"
+MODEL_NAME = "<your-model-name>"
+MODEL_VERSION = "1.0"
+
+from arize.types import Schema, EmbeddingColumnNames, ObjectDetectionColumnNames, ModelTypes, Environments
+
+tags = ["drift_type"]
+embedding_feature_column_names = {
+    "image_embedding": EmbeddingColumnNames(
+        vector_column_name="image_vector", link_to_data_column_name="url"
+    )
+}
+object_detection_prediction_column_names = ObjectDetectionColumnNames(
+    bounding_boxes_coordinates_column_name="prediction_bboxes",
+    categories_column_name="prediction_categories",
+    scores_column_name="prediction_scores",
+)
+object_detection_actual_column_names = ObjectDetectionColumnNames(
+    bounding_boxes_coordinates_column_name="actual_bboxes",
+    categories_column_name="actual_categories",
+)
+
+# Define a Schema() object for Arize to pick up data from the correct columns for logging
+schema = Schema(
+    prediction_id_column_name="prediction_id",
+    timestamp_column_name="prediction_ts",
+    tag_column_names=tags,
+    embedding_feature_column_names=embedding_feature_column_names,
+    object_detection_prediction_column_names=object_detection_prediction_column_names,
+    object_detection_actual_column_names=object_detection_actual_column_names,
+)
+
+# Logging Production DataFrame
+response = client.models.log_batch(
+    space_id=SPACE_ID,
+    model_name=MODEL_NAME,
+    model_type=ModelTypes.OBJECT_DETECTION,
+    dataframe=prod_df,
+    schema=schema,
+    environment=Environments.PRODUCTION,
+    model_version = MODEL_VERSION, # Optionally pass a model version
+)
+```
+
+### Exporting ML Data
+
+Use the `export_to_df` or `export_to_parquet` to export large amounts of spans from Arize.
+
+```python
+from arize import ArizeClient
+from datetime import datetime
+
+FMT  = "%Y-%m-%d"
+start_time = datetime.strptime("2024-01-01",FMT)
+end_time = datetime.strptime("2026-01-01",FMT)
+
+client = ArizeClient(api_key=API_KEY)
+SPACE_ID = "<your-space-id>"
+MODEL_NAME = "<your-model-name>"
+MODEL_VERSION = "1.0"
+
+df = client.models.export_to_df(
+    space_id=SPACE_ID,
+    model_name=MODEL_NAME,
+    environment=Environments.TRAINING,
+    model_version=MODEL_VERSION,
+    start_time=start_time,
+    end_time=end_time,
 )
 ```
 
-## Community
+# Community
 
 Join our community to connect with thousands of AI builders.
 

{arize-8.0.0a3.dist-info → arize-8.0.0a5.dist-info}/RECORD

@@ -4,7 +4,7 @@ arize/client.py,sha256=ntSYQSzM6MrvcYDxV-lFF-yoxoPjjCvBHKoN-2k1BGg,5688
 arize/config.py,sha256=iynVEZhrOPdTNJTQ_KQmwKOPiwL0LfEP8AUIDYW86Xw,5801
 arize/logging.py,sha256=2vwdta2-kR78GeBFGK2vpk51rQ2d06HoKzuARI9qFQk,7317
 arize/types.py,sha256=z1yg5-brmTD4kVHDmmTVkYke53JpusXXeOOpdQw7rYg,69508
-arize/version.py,sha256=-2w1elCT-feW897Pe_qFisuliwiQu6Fye5bbjMWpdP0,24
+arize/version.py,sha256=qxyqjOLj-plDoT3np3cRvJ4d0Xj2nOzy7psQNZw-WhY,24
 arize/_exporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 arize/_exporter/client.py,sha256=eAxJX1sUfdpLrtaQ0ynMTd5jI37JOp9fbl3NWp4WFEA,15216
 arize/_exporter/validation.py,sha256=6ROu5p7uaolxQ93lO_Eiwv9NVw_uyi3E5T--C5Klo5Q,1021
@@ -107,7 +107,7 @@ arize/utils/arrow.py,sha256=J7uwMsVR9K85myWcnKHb_pUz2H8Timk56U9gV2t5XnA,5477
 arize/utils/casting.py,sha256=KUrPUQN6qJEVe39nxbr0T-0GjAJLHjf4xWuzV71QezI,12468
 arize/utils/dataframe.py,sha256=I0FloPgNiqlKga32tMOvTE70598QA8Hhrgf-6zjYMAM,1120
 arize/utils/proto.py,sha256=9vLo53INYjdF78ffjm3E48jFwK6LbPD2FfKei7VaDy8,35477
-arize-8.0.0a3.dist-info/METADATA,sha256=mF17NSwm6SVVwoZDXNphbIUK4iIwzZJmZHeH0P-EPqg,7265
-arize-8.0.0a3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-arize-8.0.0a3.dist-info/licenses/LICENSE.md,sha256=8vLN8Gms62NCBorxIv9MUvuK7myueb6_-dhXHPmm4H0,1479
-arize-8.0.0a3.dist-info/RECORD,,
+arize-8.0.0a5.dist-info/METADATA,sha256=cGIq0eDVu97TMF8WSYyes9iGO4QoQtZkYIOKb3y-aF0,12340
+arize-8.0.0a5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+arize-8.0.0a5.dist-info/licenses/LICENSE.md,sha256=8vLN8Gms62NCBorxIv9MUvuK7myueb6_-dhXHPmm4H0,1479
+arize-8.0.0a5.dist-info/RECORD,,