Skip to main content

anko

Toolkit for performing anomaly detection algorithm on 1D time series based on numpy, scipy.

Conventional approaches that based on statistical analysis have been implemented, with mainly two approaches included:

  1. Normal Distribution
    Data samples are presumably been generated by normal distribution, and therefore anomalous data points can be targeted by analysing the standard deviation.

  2. Fitting Ansatz
    Data samples are fitted by several ansatzs, and in accordance with the residual, anomalous data points can be selected.

Regarding model selections, models are adopted dynamically by performing normal test and by computing the (Akaike/Bayesian) information criterion. By default, the algorithm will first try to fit in the data into normal distribution, if it passed normal test. If this attempt suffers from the loss of convergence or it did not pass normal test from begining, then the algorithm will pass data into the second methods and try to execute all the available fitting ansatzs simultaneously. The best fitting ansatz will be selected by information criterion, and finally the algorithm will pick up anomalous points in accordance with the residual. click here to see all available methods.

Future development will also include methods that are based on deep learning techniques, such as isolation forest, support vector machine, etc.

Requirements

  • python >= 3.6.0
  • numpy >= 1.16.4
  • scipy >= 1.2.1

Installation

pip install anko

For current release version please refer to PyPI - anko homepage.

Documentation

For details about anko API, see the reference documentation.

Jupyter Notebook Tutorial (in dev)

Run anko_tutorial.ipynb on your local Jupyter Notebook or host on google colab.

Basic Usage

  1. Call AnomalyDetector
from anko.anomaly_detector import AnomalyDetector  
agent = AnomalyDetector(t, series)
  1. Define policies and threshold values (optional)
agent.thres_params["linregress_res"] = 1.5  
agent.apply_policies["z_normalization"] = True  
agent.apply_policies["info_criterion"] = 'AIC'

for the use of AnomalyDetector.thres_params and AnomalyDetector.apply_policies, please refer to the documentation.

  1. Run check
check_result = agent.check()

The type of output check_result is CheckResult, which is basically a dictionary that contains the following attributes:

model: 'increase_step_func'
popt: [220.3243250055105, 249.03846355234577, 74.00000107457113]
perr: [0.4247789247961187, 0.7166253174634686, 0.0]
anomalous_data: [(59, 209)]
residual: [10.050378152592119]
extra_info: ['Info: AnomalyDetector is using z normalization.', 'Info: There are more than 1 discontinuous points detected.']

  • model (str): The best fit model been selected by algorithm.
  • popt (list): Estimated fitting parameters.
  • perr (list): Corresponding errors of popt.
  • anomalous_data (list[tuple(float, float)]): Return a list of anomalous data points (t, series(t)), or an empty list if all data points are in order.
  • residual (list): Residual of anomalous data.
  • extra_info (list): All convergence errors, warnings, informations during the execution are stored here.

Run Test

python -m unittest discover -s test -p '*_test.py'

or simply

make test

Metadata

Release files for anko 0.2.8

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

Source distribution (sdist)

Source distribution for anko 0.2.8
File Size Uploaded Provenance Actions
anko-0.2.8.tar.gz 13.3 kB Without provenance Details for anko-0.2.8.tar.gz

Release files / anko-0.2.8.tar.gz

Download URL anko-0.2.8.tar.gz
Size 13.3 kB
Tags Source
SHA-256 checksum
How to use checksums
b9d80e96a0e8f41f88d4fc38b98923c3a54a16712704e66a805a79674bb04182
BLAKE2b-256 checksum
How to use checksums
67e0ee655313e2954e1865a8f1fe6d544d0912e7dc9fd838adcd681786fc3076
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

Security for anko 0.2.8

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