QuoVadisTAD contains the artifacts of our ICML 2024 position paper Quo Vadis, Unsupervised Time Series Anomaly Detection?.

Our position paper criticises the prevailing practices in Time Series Anomaly Detection (TAD), pinpointing issues with persistent use of flawed evaluation metrics, benchmarking inconsistencies, and unnecessary complexity in the offered deep learning based models for the task. We advocate for consistent benchmarking, better datasets, and a focus on model utility by drawing simpler baselines. Our findings suggest that simple methods often exceed the performance of complex TAD deep models, which typically learn linear mappings. We offer simple & effective baselines and a repository with benchmarks and strict evaluation protocols to redirect TAD research towards more meaningful progress.

Although this project started as academic research, feedbacks from practitioners show the potential of further developing it with tools that prioritize clarity and effectiveness and make it a valuable asset for the academic research and open-source communities.

If you would be interested to contribute, please follow the how to contribute section below.

Citation

If you use the QuoVadisTAD components in your research, please cite our paper via:

@inproceedings{quovadisTAD,
  title={Position Paper: Quo Vadis, Unsupervised Time Series Anomaly Detection?},
  author={M. Saquib Sarfraz, Mei-Yen Chen, Lukas Layer, Kunyu Peng, Marios Koulakis},
  booktitle={International Conference on Machine Learning},
  pages={},
  year={2024},
}

We use Poetry to manage the dependencies , though non-poetry users can also easily install. For detailed installation instructions, please see the Installation notes.

Two notebooks are provided as quick-start tutorials for running and evaluating our simple & neural network baselines on any dataset/s.

• Evaluate and visualize simple baselines on a custom dataset

• Run Simple baselines on dataset/s and evaluate

• Train and test Neural Network baselines

We use various multivariate and univariate datasets, see the paper for details. Please note some datasets still requires to sign up an access request on the providers website, see the readme in the processed_datasets folder for respective copyright notices and details. After downloading the datasets please copy those into the [./resources/processed_datasets] folder.

To generate the documentation of the API, run poetry install --with dev && poetry run nox. In the doc folder, you can then find the documentation about the APIs in this package. Those documents were automatically generated by running poetry run nox under the project folder. More information on how to document the code can be found here.

We welcome contribution from Free and Open Source Software community. Please follow the contribution guideline below:

1. create issue to resolve
2. create branch following the naming convention #[issue_number]_[branch_name]
3. clone repository using git clone <repo-url> --recurse-submodules
4. if Poetry has not already been installed, please follow the installation notes.
5. to install the required dependencies run poetry install --with dev
6. Make your changes. To check your code and update the documentation, run poetry run nox and check for errors / failures.
7. Add new or remove old dependencies using poetry.
8. run poetry run nox

   This will automatically format the code and run all tests

9. Commit your changes.
10. create pull request and wait for review