Skip to main content

Compute and push AI model drift metrics to Compass StayReady. Zero-dependency core; optional local metric computation and an Evidently adapter.

Project description

StayReady Python SDK

Push drift events and audit entries from your MLOps pipeline to Compass StayReady — continuous AI governance monitoring for regulated sectors.

Install

pip install stayready                # zero-dependency client
pip install "stayready[metrics]"     # + local metric computation (adds numpy)

The core client depends on nothing outside the standard library, on purpose: it drops into a locked-down environment without dragging a dependency tree through a security review. Metric computation is an opt-in extra.

Three ways to use it

You have Use Needs
Metrics already (any tool) sr.drift(...) nothing
Raw data, no drift tooling Monitor [metrics] extra
Evidently already running from_evidently(...) nothing

Quick start

import os
from stayready import StayReady

sr = StayReady(
    api_key=os.environ["STAYREADY_API_KEY"],
    model_id="your-model-uuid",  # from your StayReady dashboard
)

# Report drift when your monitoring detects it — StayReady computes severity
# itself from value/threshold/direction and this metric's own history; you
# don't set it.
sr.drift(
    type="data_drift",              # data_drift | concept_drift | performance_degradation | regulatory_change
    metric="PSI",
    value=0.28,
    threshold=0.20,
    description="Population Stability Index exceeded threshold on income feature.",
    affected_domains=["Data Quality", "Model Monitoring"],
    action_required="Retrain on recent data and re-validate before next production cycle.",
)

# Log lifecycle events to the immutable audit trail
sr.audit("model_retrained", "Retrained on Q2 data, Gini improved to 0.61", actor="ml-pipeline")

Severity is computed server-side by comparing value against threshold and this model+metric's own trailing baseline — not something you set. Critical and High results trigger an email alert (and webhook, if configured), deduped so repeated near-identical events don't re-notify, and can flag your linked GovernReady audit for re-assessment.

Most metrics are "higher is worse" (PSI, KS, error rate) — the default. If a drop is what's bad for your metric (Gini, accuracy, F1), pass direction="lower_is_worse" on the first call you ever make for that model+metric; it registers the metric's polarity and is ignored on later calls, so you can't accidentally flip it mid-stream.

Integration examples

Evidently AI

psi = report.as_dict()["metrics"][0]["result"]["dataset_drift_share"]
sr.drift(type="data_drift", metric="PSI", value=psi,
         threshold=0.2, description="Evidently reported this drift share.")

Airflow (post-training validation)

def report_validation(**ctx):
    gini = ctx["ti"].xcom_pull(key="gini")
    sr.drift(type="performance_degradation", metric="Gini", value=gini,
             threshold=0.55, direction="lower_is_worse",
             description="Gini after retrain.")

Requirements

Python 3.9+. Zero dependencies (standard library only).

Support

np@dendrons.ai · stayready.dendrons.ai

Compute metrics from your own data (Monitor)

If you don't already have a drift tool, Monitor computes the standard metrics locally and pushes them. Only aggregate values leave your infrastructure — a handful of floats per column. No raw records, no feature values, no model outputs. That property is usually the deciding factor in a regulated buyer's security review.

from stayready import StayReady, Monitor

sr = StayReady(api_key=..., model_id=...)
mon = Monitor(sr)

# Always dry-run first: computes and returns, sends nothing.
print(mon.check_drift(reference=train_df, current=recent_df, dry_run=True))

# Input drift, one metric per column (psi | ks | js | chisquare)
mon.check_drift(reference=train_df, current=recent_df, metric="psi")

# Model quality. Gini is pushed as lower_is_worse automatically —
# a *drop* is the problem, and getting that backwards inverts severity.
mon.check_performance(y_true=y, y_pred=preds, y_score=scores)

reference and current accept a pandas DataFrame or a plain {"column": [values]} dict — pandas is not required.

Metrics are verified against SciPy: KS matches scipy.stats.ks_2samp, AUC matches scipy.stats.mannwhitneyu, and Jensen-Shannon matches scipy.spatial.distance.jensenshannon (base 2), each to 1e-9.

This is a reference implementation, not a drift-detection product. It computes standard metrics competently; it does not schedule runs, store baselines, or manage windows. If you already run Evidently, use the adapter below instead of computing the same numbers twice.

Already using Evidently? (from_evidently)

from evidently import Report
from evidently.presets import DataDriftPreset
from stayready import StayReady, from_evidently

snapshot = Report([DataDriftPreset()]).run(current_data=cur, reference_data=ref)
from_evidently(snapshot, client=StayReady(api_key=..., model_id=...))

Accepts a Report, a snapshot, its .dict(), or a JSON string. Requires no extra install — it only reads Evidently's output structure.

It handles a trap you'd otherwise hit. Evidently's stattests don't share a direction convention and the JSON doesn't say which applies. Distances (psi, jensenshannon, wasserstein, hellinger, kl_div, ed) report higher = more drift. Test-based stattests (ks, chisquare, z, g_test, TVD, t_test, mannw, anderson, cramer_von_mises, es) report a p-value, where lower = more drift. Forwarding a p-value as higher-is-worse inverts severity exactly: real drift scores healthy, and a healthy model pages someone at 3am. TVD returns a p-value despite the name.

The direction map was built by running each stattest against known-drifted and known-clean samples and recording which way the value actually moved. For a stattest it doesn't recognise, the adapter skips with a warning rather than guessing — override with unknown_method="higher_is_worse" (or "lower_is_worse") when you know which applies.

Project details


Download files

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

Source Distribution

stayready-0.3.0.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stayready-0.3.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file stayready-0.3.0.tar.gz.

File metadata

  • Download URL: stayready-0.3.0.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.14

File hashes

Hashes for stayready-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a399e9eb0baf6a0d4cfbb4545706df506dd959123b47285f691c138a4e87e1db
MD5 b56ed058493c8a1332927ec42f48668a
BLAKE2b-256 abd819127ac493ec1751aba256ff9c699d6b9bb831eced5e13fbda53196c6ae8

See more details on using hashes here.

File details

Details for the file stayready-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: stayready-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.11.14

File hashes

Hashes for stayready-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f56ff63d3578943cdcf42e625a4c2803ae2d4512ef629f0c2e2541e5f70fca5
MD5 5f6286844defe902c6ea9a65db9a8927
BLAKE2b-256 893b05a7a3f341fd5a990fb897bd88a198b8781eac3cb75fc752075297154870

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page