Skip to content

About

A simple-to-use Python tool for time series anomaly detection!

Topics

Resources

Contributing

Stars

63 stars

Watchers

4 watching

Forks

Repository files navigation

dtaianomaly

Time series anomaly detection

Unit tests Doctest docs-stable docs-latest PyPi Version Downloads PyPI license Code style: black InTimeAD UI

A simple-to-use Python package for the development and analysis of time series anomaly detection techniques. Here we describe the main usage of dtaianomaly, but be sure to check out the documentation for more information.

Installation

The preferred way to install dtaianomaly is via PyPi. See the documentation for more options.

pip install dtaianomaly

Features

The three key features of dtaianomaly are as follows:

  1. State-of-the-art time series anomaly detection via a simple API. Learn more!
  2. Develop custom models for anomaly detection. Learn more!
  3. Quantitative evaluation of time series anomaly detection. Learn more!

Example

Below code shows a simple example of dtaianomaly, in which we detect anomalies in a time series of the UCR time series anomaly archive using HydraAD. This time series is included in the data folder of this repository. The example is part of the anomaly detection notebook, which also generates the figure below. More examples are provided in the other notebooks and in the documentation.

from dtaianomaly.data import UCRLoader
from dtaianomaly.anomaly_detection import HydraAD
from dtaianomaly.visualization import plot_anomaly_scores

# Load the data
data = UCRLoader("data/UCR-time-series-anomaly-archive/002_UCR_Anomaly_DISTORTED2sddb40_35000_56600_56900.txt").load()

# Fit HydraAD on the training data, with an automatically computed window size
detector = HydraAD(window_size="fft")
detector.fit(data.X_train)

# Compute the anomaly scores of the test data
anomaly_scores = detector.predict_proba(data.X_test)

# Visualize the anomaly scores
plot_anomaly_scores(data.X_test, data.y_test, anomaly_scores, figsize=(10, 3))

example-README.svg

Acknowledgments

If you find dtaianomaly useful for your work, we would appreciate the following citation:

@article{carpentier2025dtaianomaly,
      title={{dtaianomaly: A Python library for time series anomaly detection}}, 
      author={Louis Carpentier and Nick Seeuws and Wannes Meert and Mathias Verbeke},
      year={2025},
      eprint={2502.14381},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/2502.14381}, 
}

Carpentier, L., Seeuws, N., Meert, W., Verbeke, M.: dtaianomaly: A Python library for time series anomaly detection (2025), https://arxiv.org/abs/2502.14381

Contribute

The goal of dtaianomaly is to be community-driven. All types of contributions are welcome. This includes code, but also bug reports, improvements to the documentation, additional tests and more. Check out the documentation to find more information about how you can contribute!

License

Copyright (c) 2023-2025 KU Leuven, DTAI Research Group

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

A simple-to-use Python tool for time series anomaly detection!

Topics

Resources

Contributing

Stars

63 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages