driftwatch 0.1.0

Data & model drift detection for Rust — PSI, KL/JS divergence, KS and chi-square tests, live windowing, and pluggable alerting.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! With the `prometheus-export` feature on, a check must emit correctly-labeled
//! gauges onto the installed `metrics` recorder.
#![cfg(feature = "prometheus-export")]

use driftwatch::export::{DATASET_DRIFT_GAUGE, FEATURE_DRIFT_GAUGE};
use driftwatch::{DatasetMonitor, EqualFrequencyBinning, LiveFeature, ReferenceDistribution};
use metrics_util::debugging::{DebugValue, DebuggingRecorder};

fn linspace(lo: f64, hi: f64, n: usize) -> Vec<f64> {
    (0..n)
        .map(|i| lo + (hi - lo) * i as f64 / (n - 1) as f64)
        .collect()
}

#[test]
fn check_emits_drift_gauges() {
    let recorder = DebuggingRecorder::new();
    let snapshotter = recorder.snapshotter();
    recorder.install().expect("install debugging recorder");

    let mut monitor = DatasetMonitor::new();
    monitor.add_feature(
        ReferenceDistribution::fit_continuous(
            "score",
            &linspace(0.0, 1.0, 500),
            EqualFrequencyBinning::new(10).unwrap(),
        )
        .unwrap(),
    );

    let shifted = linspace(2.0, 3.0, 500);
    let report = monitor
        .check(&[("score", LiveFeature::Continuous(&shifted))])
        .unwrap();
    assert!(report.dataset_drift_detected());

    let snapshot = snapshotter.snapshot().into_vec();

    let mut dataset_gauge = None;
    let mut feature_gauge = None;
    for (composite, _unit, _desc, value) in snapshot {
        let key = composite.key();
        let name = key.name();
        if let DebugValue::Gauge(v) = value {
            if name == DATASET_DRIFT_GAUGE {
                dataset_gauge = Some(v.into_inner());
            } else if name == FEATURE_DRIFT_GAUGE {
                let has_feature_label = key
                    .labels()
                    .any(|l| l.key() == "feature" && l.value() == "score");
                assert!(has_feature_label, "feature gauge missing 'feature=score'");
                feature_gauge = Some(v.into_inner());
            }
        }
    }

    assert_eq!(
        dataset_gauge,
        Some(1.0),
        "dataset drift gauge should be 1.0"
    );
    let feature_gauge = feature_gauge.expect("feature drift gauge should be present");
    assert!(
        feature_gauge > 0.25,
        "feature drift score should exceed threshold"
    );
}