Skip to main content

pyharbinger

PyPI Python versions License: MIT

Python port of the R harbinger — a framework for time series event detection (anomalies, change points, and motifs/discords), built on the DAL Toolbox Experiment Line.

pyharbinger unifies many detection methods under one interface (fit → detect → evaluate) and a common evaluation protocol, so different detectors can be compared fairly — reusing classic libraries (scikit-learn, numpy, pandas, scipy, ruptures) through thin adapters.

It is the capstone of the DAL Python family:

  • Builds on pydaltoolbox (foundation) and pytspredit (time series prediction) — its regressors power the forecasting-based anomaly detectors.

Installation

pip install pyharbinger

On Python 3.14, ruptures 1.1.x has no prebuilt wheel yet; install with pip install --prefer-binary pyharbinger so pip uses the pure-Python ruptures 1.0.6 wheel. Python 3.9–3.13 install directly.

Quickstart

from pyharbinger import HanrFft, HarEval, datasets

# a labeled example series (one injected anomaly)
dataset = datasets.examples_anomalies()["simple"]
serie, event = dataset["serie"], dataset["event"]

# fit -> detect -> evaluate
model = HanrFft().fit(serie)
detection = model.detect(serie)
print(detection[detection["event"]])

metrics = model.evaluate(detection, event)
print(metrics["confMatrix"])
print("F1:", metrics["F1"])

What's included

Every detector extends Harbinger and returns a detection table with columns idx / event / type ("anomaly", "changepoint", "discord" or "").

Group Classes
Core Harbinger (base contract), deviation / filter / candidate-selection utilities
Evaluation HarEval (hard), HarEvalSoft (SoftED, soft matching via the Hungarian algorithm)
Anomaly HanrMl (forecasting residuals, wraps a pytspredit regressor), HanrFft, HanrHistogram, HanrFbiad
Change point HcpAmoc, HcpBinseg, HcpPelt (via ruptures), HcpKswin, HcpPageHinkley
Clustering HanctKmeans (anomalies / discords)
Classification HancMl (supervised; wraps a pydaltoolbox classifier)
Multivariate HmuPca (PCA reconstruction error)
Datasets datasets.examples_anomalies(), datasets.examples_changepoints()

Detectors accept a univariate series or, for the multivariate ones, a DataFrame with one column per variable.

Roadmap

Later releases expand coverage toward feature parity with R in two cycles. The low-dependency cycle adds the FFT-hybrid anomaly detectors, the extended change-point family (ChangeFinder, Chow, GFT, join-point, BOCPD, ...), native SAX motif/discord, ensembles, plotting, and the streaming runners. The heavy-dependency cycle then adds — each behind an optional extra — matrix profile (stumpy), GARCH (arch), EMD (EMD-signal), wavelets (PyWavelets), DTW clustering, and the autoencoder detectors (deep-learning backend). See develop/planejamento.md for the full plan.

Faithfulness to R

The port is validated against the R package on the same data at every step. Deterministic components match R to numerical precision (deviation measures, filters, candidate selection, hard/soft evaluation, FFT/histogram/FBIAD detectors, HanrMl with a deterministic regressor, HanctKmeans centroids count, and HcpPageHinkley). Where the backend or RNG differs, the tolerance is documented:

  • HanrMl with a rank-reduced ELM (nhid < input_size, purelin) depends on the hidden-weight RNG.
  • HanctKmeans and HcpKswin depend on initialization / random-subsample RNG.
  • HcpAmoc/HcpBinseg/HcpPelt use ruptures (Gaussian cost); R uses changepoint::cpt.meanvar with the MBIC penalty, so agreement is approximate.
  • HancMl detections match R (e.g. the hanc_ml k-NN example flags the same positions), but class probabilities can differ because scikit-learn and R's class::knn break ties differently.
  • HmuPca matches R exactly (same events and residuals) after fixing a latent degeneracy in R's hmu_pca, which kept all principal components; both now reconstruct from a reduced set (90% variance by default, capped at n_features - 1).

License

MIT

Metadata

Release files for pyharbinger 0.2.0

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

Source distribution (sdist)

Source distribution for pyharbinger 0.2.0
File Size Uploaded Provenance Actions
pyharbinger-0.2.0.tar.gz 90.7 kB Without provenance Details for pyharbinger-0.2.0.tar.gz

Built distribution (wheel)

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

Total release size: 181.6 kB

Release files / pyharbinger-0.2.0.tar.gz

Download URL pyharbinger-0.2.0.tar.gz
Size 90.7 kB
Tags Source
SHA-256 checksum
How to use checksums
26f6e5542edf735ca71dc9fca608a4824fa99dae424e04ce49c2361ec7e159d9
BLAKE2b-256 checksum
How to use checksums
1a0ec77a021e9e84c0ea0163ac42d14f9e57ccec77caaa8018b13d16d05fac75
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / pyharbinger-0.2.0-py3-none-any.whl

Download URL pyharbinger-0.2.0-py3-none-any.whl
Size 90.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0b7bcb74b5e93af9a3c2252eb55a52f4753ff135b156798ee1c3236a62d2b32b
BLAKE2b-256 checksum
How to use checksums
269236d7737de2bc92c021fe81baa0dbaa2a9d460b4ca45cc8148a756e588502
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Security for pyharbinger 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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