Adding `libspot` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add libspot

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

libspot = "2.0.0-beta.6.0"

The libspot library will be automatically available globally. Read the libspot library documentation.

Back to the crate overview.

Readme

libspot

A safe Rust wrapper (using FFI) for the libspot time series anomaly detection library.

Quick Start

use libspot::{SpotDetector, SpotConfig, SpotStatus};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create detector with default configuration
    let config = SpotConfig::default();
    let mut detector = SpotDetector::new(config)?;

    // Fit with training data
    let training_data: Vec<f64> = (0..1000)
        .map(|i| 5.0 + (i as f64 * 0.01).sin() * 2.0)
        .collect();
    detector.fit(&training_data)?;

    // Detect anomalies in real-time
    let test_value = 50.0; // This should be an anomaly
    match detector.step(test_value)? {
        SpotStatus::Normal => println!("Normal data point"),
        SpotStatus::Excess => println!("In the tail distribution"),
        SpotStatus::Anomaly => println!("Anomaly detected! 🚨"),
    }

    Ok(())
}

Alternative

For a pure Rust implementation without FFI dependencies, see the libspot-rs crate.

License

This project is licensed under the GNU Lesser General Public License v3.0 (LGPL-3.0).

Adding libspot library as a dependency

Adding `libspot` library as a dependency