cupbearer is a Python library for
mechanistic anomaly detection.
Its main purpose is to make it easy to implement either a new mechanistic anomaly
detection task, or a new detection method, and evaluate it against a suite of existing
tasks or methods. To that end, the library provides:
- A clearly defined interface for tasks and detectors to ensure compatibility
- Scripts and other helpers for training and evaluating detectors that satisfy this interface (to reduce the amount of boilerplate code you need to write)
- Implementations of several tasks and detectors as baselines (currently not that many)
Contributions of new tasks or detectors are very welcome! See the developer guide to get started.
The easy way: inside a virtual environment with Python >= 3.10, run
pip install git+https://github.com/ejnnr/cupbearer.git(You could also pip install cupbearer, but note that the library is under heavy
development and the PyPi version will often be outdated.)
Alternatively, if you're going to do development work on the library itself:
- Clone this git repository
- Create a virtual environment with Python 3.10 and activate it
- Run
pip install -e .inside the git repo to install the package in editable mode
Depending on what platform you're on, you may need to install Pytorch separately before
installing cupbearer, in particular if you want to control CUDA version etc.
We provide scripts in cupbearer.scripts for more easily running experiments.
See the demo notebook for a quick example of how to use them---this is likely
also the best way to get an overview of how the components of cupbearer fit together.
These "scripts" are Python functions and designed to be used from within Python,
e.g. in a Jupyter notebook or via submitit
if on Slurm. But of course you could also write a simple Python wrapper and then use
them from the CLI. The scripts are designed to be pretty general,
which sometimes comes at the cost of being a bit verbose---we recommend writing helper
functions for your specific use case on top of the general script interface.
Of course you can also use the components of cupbearer directly without going through
any of the scripts.
Just like a cupbearer tastes wine to avoid poisoning the king, mechanistic anomaly detection methods taste new inputs to check whether they're poisoned. (Or more generally, anomalous in terms of how they affect the king ... I mean, model. I admit the analogy is becoming a bit strained here.)