Install Graphsignal agent by running:
pip install graphsignal
Or clone and install the GitHub repository:
git clone https://github.com/graphsignal/graphsignal.git python setup.py install
Configure Graphsignal agent by specifying your API key directly or via
GRAPHSIGNAL_API_KEY environment variable.
import graphsignal graphsignal.configure(api_key='my-api-key', deployment='my-model-prod-v1')
To track deployments, versions and environments separately, specify a
Use the following examples to integrate Graphsignal agent into your machine learning application. See integration documentation and API reference for full reference.
Graphsignal agent is optimized for production. All executions will be measured, but only a few will be recorded to ensure low overhead.
Monitoring and tracing
with graphsignal.start_trace(endpoint='predict'): pred = model(x)
@graphsignal.trace_function def predict(x): return model(x)
Other integrations and callbacks are available as well. See integration documentation for more information.
start_trace method with
with context manager or callbacks, exceptions are automatically recorded. For other cases, use
To track data metrics and record data profiles,
EndpointTrace.set_data method can be used.
with graphsignal.start_trace(endpoint='predict') as trace: trace.set_data('input', input_data)
The following data types are currently supported:
No raw data is recorded by the agent, only statistics such as size, shape or number of missing values.
After everything is setup, log in to Graphsignal to monitor and analyze execution performance and monitor for issues.
import graphsignal graphsignal.configure(api_key='my-api-key', deployment='my-model-prod') ... def predict(x): with graphsignal.start_trace(endpoint='predict'): return model(x)
import graphsignal graphsignal.configure(api_key='my-api-key', deployment='my-model') ... for x in data: with graphsignal.start_trace(endpoint='predict', tags=dict(job_id='job1')): preds = model(x)
More integration examples are available in
Graphsignal agent is very lightweight. While all executions are measured, Graphsignal agent only records certain executions, automatically limiting the overhead.
To enable debug logging, add
configure(). If the debug log doesn't give you any hints on how to fix a problem, please report it to our support team via your account.
In case of connection issues, please make sure outgoing connections to