Skip to main content

A helper library to interact with Arize AI APIs

Project description



Arize AI PyPI version CI

Overview

A helper library to interact with Arize AI APIs


Quickstart

Instrument your model to log predictions and latent truth events. The logged events allow the Arize platform to generate visualizations of features, model output and prediction evaluation metrics. Additionally the platform will provide data quality monitoring and data distribution alerts, for your production models.

Start logging with the following steps.

1. Create your account

Sign up for a free account by reaching out to contacts@arize.com.



2. Get your service key

When you create an account, we generate a service api key. You will need this API Key and account id for logging authentication.

3. Instrument your code

Python Client

If you are using our python client, add a few lines to your code to log predictions and truths. Logs are sent to Arize asynchrously.

Install Library

Install our library in an environment using Python 3.

$ pip3 install arize

Or clone the repo:

$ git clone https://github.com/Arize-ai/client_python.git
$ python setup.py install

Initialize Python Client

Initialize arize at the start of your sevice using your previously created Account ID and API Key

NOTE: We suggest adding the API KEY as secrets or an environment variable

from arize.api import AsyncClient

API_KEY = os.environ.get('ARIZE_API_KEY')
arize = AsyncClient(account_id=1234, api_key=API_KEY)

Collect your model input features and labels you'd like to track

You can track all input features used to at prediction time by logging it via a string:string dictionary.

labels = {
    'state': 'ca',
    'city': 'berkeley',
    'lat': '37.8717',
    'lng': '-122.2579',
    'merchant_type': 'educational',
    'charge_amount': '20.11',
    }

Log Predictions

arize.log(
    model_id='sample-model-v1.43.56',
    prediction_id='plED4eERDCasd9797ca34',
    prediction_value=True,
    labels=labels,
    )

We automatically discover new models logged over time based on the model ID sent on each prediction.

Log Truths

arize.log(
    model_id='sample-model-v1.43.56',
    prediction_id='plED4eERDCasd9797ca34',
    truth_value=True,
    )

Once a truth for a prediction is determined, you can log those to Arize and evaluate your metrics over time. What links the truch to the original prediction is the prediction_id for a model_id

4. Log In for Analytics

That's it! Once your service is deployed and predictions are logged you'll be able to log into your Arize account and dive into your data. Slicing it by feature labels, models, time, etc.

Analytics Dashboard




Other languages

If you are using a different language, you'll be able to post an HTTP request to our Arize edge-servers to log your events.

HTTP post request to Arize

curl -X POST -H "Authorization: API_KEY" "https://api.arize.com/v1/log" -d'{"account_id": 0, "model_id": "test_model_1", "prediction_id":"test100", "prediction":{"labels":{"state":"CO", "type":"restaurant"}, "prediction_value": {"binary_value": false}}}'

Contributing

TBD

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for arize, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size arize-0.0.2-py2.py3-none-any.whl (15.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size arize-0.0.2.tar.gz (9.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page