Skip to main content

StreamAD

StreamAD Logo

Anomaly detection for data streams/time series. Detectors process the univariate or multivariate data one by one to simulte a real-time scene.

Documentation

PyPI PyPI - Python Version PyPI - Implementation

Read the Docs GitHub Downloads

example workflow codecov Maintainability FOSSA Status


Installation

The stable version can be installed from PyPI:

pip install streamad

The development version can be installed from GitHub:

pip install git+https://github.com/Fengrui-Liu/StreamAD

Quick Start

Start once detection within 5 lines of code. You can find more example with visualization results here.

from streamad.util import StreamGenerator, UnivariateDS
from streamad.model import SpotDetector

ds = UnivariateDS()
stream = StreamGenerator(ds.data)
model = SpotDetector()

for x in stream.iter_item():
    score = model.fit_score(x)

Models

For univariate time series

If you want to detect multivarite time series with these models, you need to apply them on each feature separately.

Model Example API Usage Paper
KNNCAD streamad.model.KNNDetector Conformalized density- and distance-based anomaly detection in time-series data
SPOT streamad.model.SpotDetector Anomaly detection in streams with extreme value theory
Spectral Residual streamad.model.SRDetector Time-series anomaly detection service at microsoft
Z score streamad.model.ZScoreDetector Standard score
One-class SVM streamad.model.OCSVMDetector One-class SVM
MAD streamad.model.MadDetector Median absolute deviation
SARIMAX streamad.model.SArimaDetector Seasonal Arima Detector

For multivariate time series

These models are compatible with univariate time series.

Models Example API Usage Paper
xStream streamad.model.xStramDetector Xstream: outlier detection in feature-evolving data streams
RShash streamad.model.RShashDetector Subspace Outlier Detection in Linear Time with Randomized Hashing
HSTree streamad.model.HSTreeDetector Fast Anomaly Detection for Streaming Data
LODA streamad.model.LodaDetector Lightweight on-line detector of anomalies
RRCF streamad.model.RrcfDetector Robust random cut forest based anomaly detection on streams

Metadata

Release files for streamad 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for streamad 0.3.1
File Size Uploaded
streamad-0.3.1.tar.gz 49.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for streamad 0.3.1
File Interpreter ABI Platform
streamad-0.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 109.7 kB

Release files / streamad-0.3.1.tar.gz

Download URL streamad-0.3.1.tar.gz
Size 49.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0bcccf8d77f749a785040a09e2b3a2a8af22d2a96af2e15bef1423ce73fb82a5
BLAKE2b-256 checksum
How to use checksums
e2174024cbdee1b23524d9f9d171deb9f3bbe7fd69ef8dc00525c1e3b84b4f50
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.11.0 Linux/5.15.0-1037-azure

Release files / streamad-0.3.1-py3-none-any.whl

Download URL streamad-0.3.1-py3-none-any.whl
Size 60.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7f776794824c7e623aba4b9abcd6a20b415cc62803316b74b8c288ffe42ddd90
BLAKE2b-256 checksum
How to use checksums
f6b3e84bfe275dbd925a9fbcf6418fceecbbdccffcb1ea17ad2ec0da26fb9c60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.11.0 Linux/5.15.0-1037-azure

Release history Release notifications | RSS feed

This release

0.3.1 This release

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page