README.md

October 15, 2024 · View on GitHub

AnomLLM

Can LLMs Understand Time Series Anomalies?

| Introduction

We challenge common assumptions about Large Language Models' capabilities in time series understanding. This repository contains the code for reproducing results and benchmarking your own large language models' (as long as they are compatible with OpenAI API) anomaly detection capabilities.

| Citation

[2410.05440] Can LLMs Understand Time Series Anomalies?

@misc{zhou2024llmsunderstandtimeseries,
      title={Can LLMs Understand Time Series Anomalies?}, 
      author={Zihao Zhou and Rose Yu},
      year={2024},
      eprint={2410.05440},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/2410.05440}, 
}

| Installation

Dependencies: conda
Run export PYTHONPATH=$PYTHONPATH:$(pwd)/src first
Jpyter notebook path shall be the root directory of the project.

conda env create --file environment.yml
conda activate anomllm
poetry install --no-root 
# Or `poetry install --no-root --with dev` if you need jupyter and etc.

| Dataset Download

We recommend using s5cmd to download the dataset from the NRP S3 bucket.

s5cmd --no-sign-request --endpoint-url https://s3-west.nrp-nautilus.io cp "s3://anomllm/data/*" data/

Alternatively, you can download the dataset from the following link: Google Drive or synthesize your own dataset using synthesize.sh. Make sure the dataset is stored in the data directory.

| API Configuration

Create a credentials.yml file in the root directory with the following content:

gpt-4o:
  api_key: <YOUR_OPENAI_API_KEY>
  base_url: "https://api.openai.com/v1"
gpt-4o-mini:
  api_key: <YOUR_OPENAI_API_KEY>
  base_url: "https://api.openai.com/v1"
gemini-1.5-flash:
  api_key: <YOUR_GOOGLE_API_KEY>
internvlm-76b:
  api_key: <YOUR_LOCAL_OPENAI_SERVER_API_KEY>
  base_url: <YOUR_LOCAL_OPENAI_SERVER_ENDPOINT> (ended with v1)
qwen:
  api_key: <YOUR_LOCAL_OPENAI_SERVER_API_KEY>
  base_url: <YOUR_LOCAL_OPENAI_SERVER_ENDPOINT> (ended with v1)

| Example Usage for Single Time Series

Check out the example notebook.

To run the example notebook, you only need the gemini-1.5-flash model in the credentials.yml file.

| Batch Run using OpenAI BatchAPI

python src/batch_api.py --data $datum --model $model --variant $variant

See test.sh for comprehensive lists of models, variants, and datasets. The Batch API only works with OpenAI proprietary models and will reduce the cost by 50%, but it does not finish in real-time. Your first run will create a request file, and subsequent runs will check the status of the request and retrieve the results when they are ready.