Skip to main content

A package for unsupervised time series anomaly detection

Project description

Anomaly Detection Toolkit (ADTK)

Build Status Documentation Status Coverage Status PyPI Downloads Code style: black Binder

Anomaly Detection Toolkit (ADTK) is a Python package for unsupervised / rule-based time series anomaly detection.

As the nature of anomaly varies over different cases, a model may not work universally for all anomaly detection problems. Choosing and combining detection algorithms (detectors), feature engineering methods (transformers), and ensemble methods (aggregators) properly is the key to build an effective anomaly detection model.

This package offers a set of common detectors, transformers and aggregators with unified APIs, as well as pipe classes that connect them together into models. It also provides some functions to process and visualize time series and anomaly events.

See https://adtk.readthedocs.io for complete documentation.

Installation

Prerequisites: Python 3.5 or later.

It is recommended to install the most recent stable release of ADTK from PyPI.

pip install adtk

Alternatively, you could install from source code. This will give you the latest, but unstable, version of ADTK.

git clone https://github.com/arundo/adtk.git
cd adtk/
git checkout develop
pip install ./

Examples

Please see Quick Start for a simple example.

For more detailed examples of each module of ADTK, please refer to Examples section in the documentation or an interactive demo notebook.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update unit tests as appropriate.

Please see Contributing for more details.

License

ADTK is licensed under the Mozilla Public License 2.0 (MPL 2.0). See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adtk-0.6.2.tar.gz (54.5 kB view details)

Uploaded Source

Built Distribution

adtk-0.6.2-py3-none-any.whl (61.0 kB view details)

Uploaded Python 3

File details

Details for the file adtk-0.6.2.tar.gz.

File metadata

  • Download URL: adtk-0.6.2.tar.gz
  • Upload date:
  • Size: 54.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for adtk-0.6.2.tar.gz
Algorithm Hash digest
SHA256 6cfafb44b5ad26a2ffd640aeb79d84fc5383d2d42c97a47420695badbee27be8
MD5 33fb6b3c68ad46f5557a29b34f49327a
BLAKE2b-256 dc72ba10b935b4941a5d7e54edce86354ec389d08d06b53aae4e7fa464fed0e3

See more details on using hashes here.

File details

Details for the file adtk-0.6.2-py3-none-any.whl.

File metadata

  • Download URL: adtk-0.6.2-py3-none-any.whl
  • Upload date:
  • Size: 61.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for adtk-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 971bad7545220a588520cd03f8e8085bd4ec5dd3ebdf60b5dae8d6b9ca7d55a8
MD5 c018c9f93942cde5a7de4bb149049fcb
BLAKE2b-256 3b26d897eebc4385d2aeaa45caf83bf5f9f7ce1a4b9a9046bdf04ad1b3cf33d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page