# Anomaly Detection Toolkit (ADTK)
[](https://travis-ci.com/arundo/adtk)
[](https://adtk.readthedocs.io/en/stable)
[](https://coveralls.io/github/arundo/adtk?branch=master)
[](https://pypi.org/project/adtk/)
[](https://pepy.tech/project/adtk)
[](https://github.com/psf/black)
[](https://mybinder.org/v2/gh/arundo/adtk/master?filepath=docs%2Fnotebooks%2Fdemo.ipynb)
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.
```shell
pip install adtk
```
Alternatively, you could install from source code. This will give you the **latest**, but unstable, version of ADTK.
```shell
git clone https://github.com/arundo/adtk.git
cd adtk/
git checkout develop
pip install ./
```
## Examples
Please see [Quick Start](https://adtk.readthedocs.io/en/stable/quickstart.html) for a simple example.
For more detailed examples of each module of ADTK, please refer to
[Examples](https://adtk.readthedocs.io/en/stable/examples.html)
section in the documentation or [an interactive demo notebook](https://mybinder.org/v2/gh/arundo/adtk/master?filepath=docs%2Fnotebooks%2Fdemo.ipynb).
## 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](https://adtk.readthedocs.io/en/stable/developer.html) for more details.
## License
ADTK is licensed under the Mozilla Public License 2.0 (MPL 2.0). See the
[LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/arundo/adtk",
"name": "adtk",
"maintainer": "Tailai Wen",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "tailai.wen@arundo.com",
"keywords": "anomaly detection,time series",
"author": "Arundo Analytics, Inc.",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/dc/72/ba10b935b4941a5d7e54edce86354ec389d08d06b53aae4e7fa464fed0e3/adtk-0.6.2.tar.gz",
"platform": "",
"description": "# Anomaly Detection Toolkit (ADTK)\n\n[](https://travis-ci.com/arundo/adtk)\n[](https://adtk.readthedocs.io/en/stable)\n[](https://coveralls.io/github/arundo/adtk?branch=master)\n[](https://pypi.org/project/adtk/)\n[](https://pepy.tech/project/adtk)\n[](https://github.com/psf/black)\n[](https://mybinder.org/v2/gh/arundo/adtk/master?filepath=docs%2Fnotebooks%2Fdemo.ipynb)\n\nAnomaly Detection Toolkit (ADTK) is a Python package for unsupervised /\nrule-based time series anomaly detection.\n\nAs the nature of anomaly varies over different cases, a model may not work\nuniversally for all anomaly detection problems. Choosing and combining\ndetection algorithms (detectors), feature engineering methods (transformers),\nand ensemble methods (aggregators) properly is the key to build an effective\nanomaly detection model.\n\nThis package offers a set of common detectors, transformers and aggregators\nwith unified APIs, as well as pipe classes that connect them together into\nmodels. It also provides some functions to process and visualize time series\nand anomaly events.\n\nSee https://adtk.readthedocs.io for complete documentation.\n\n## Installation\n\nPrerequisites: Python 3.5 or later.\n\nIt is recommended to install the most recent **stable** release of ADTK from PyPI.\n\n```shell\npip install adtk\n```\n\nAlternatively, you could install from source code. This will give you the **latest**, but unstable, version of ADTK.\n\n```shell\ngit clone https://github.com/arundo/adtk.git\ncd adtk/\ngit checkout develop\npip install ./\n```\n\n## Examples\n\nPlease see [Quick Start](https://adtk.readthedocs.io/en/stable/quickstart.html) for a simple example.\n\nFor more detailed examples of each module of ADTK, please refer to\n[Examples](https://adtk.readthedocs.io/en/stable/examples.html)\nsection in the documentation or [an interactive demo notebook](https://mybinder.org/v2/gh/arundo/adtk/master?filepath=docs%2Fnotebooks%2Fdemo.ipynb).\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to\ndiscuss what you would like to change.\n\nPlease make sure to update unit tests as appropriate.\n\nPlease see [Contributing](https://adtk.readthedocs.io/en/stable/developer.html) for more details.\n\n\n## License\n\nADTK is licensed under the Mozilla Public License 2.0 (MPL 2.0). See the\n[LICENSE](LICENSE) file for details.\n\n\n",
"bugtrack_url": null,
"license": "Mozilla Public License 2.0 (MPL 2.0)",
"summary": "A package for unsupervised time series anomaly detection",
"version": "0.6.2",
"project_urls": {
"Homepage": "https://github.com/arundo/adtk"
},
"split_keywords": [
"anomaly detection",
"time series"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b26d897eebc4385d2aeaa45caf83bf5f9f7ce1a4b9a9046bdf04ad1b3cf33d8",
"md5": "c018c9f93942cde5a7de4bb149049fcb",
"sha256": "971bad7545220a588520cd03f8e8085bd4ec5dd3ebdf60b5dae8d6b9ca7d55a8"
},
"downloads": -1,
"filename": "adtk-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c018c9f93942cde5a7de4bb149049fcb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 60971,
"upload_time": "2020-04-17T02:18:00",
"upload_time_iso_8601": "2020-04-17T02:18:00.356788Z",
"url": "https://files.pythonhosted.org/packages/3b/26/d897eebc4385d2aeaa45caf83bf5f9f7ce1a4b9a9046bdf04ad1b3cf33d8/adtk-0.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc72ba10b935b4941a5d7e54edce86354ec389d08d06b53aae4e7fa464fed0e3",
"md5": "33fb6b3c68ad46f5557a29b34f49327a",
"sha256": "6cfafb44b5ad26a2ffd640aeb79d84fc5383d2d42c97a47420695badbee27be8"
},
"downloads": -1,
"filename": "adtk-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "33fb6b3c68ad46f5557a29b34f49327a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 54473,
"upload_time": "2020-04-17T02:18:01",
"upload_time_iso_8601": "2020-04-17T02:18:01.587122Z",
"url": "https://files.pythonhosted.org/packages/dc/72/ba10b935b4941a5d7e54edce86354ec389d08d06b53aae4e7fa464fed0e3/adtk-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-04-17 02:18:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arundo",
"github_project": "adtk",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "adtk"
}
JSON
