Skip to main content

Conformal Anomaly Detection

Project description

Logo


Python versions codecov PyPI version Docs

Conformal Anomaly Detection

Thresholds for anomaly detection are often arbitrary and lack theoretical guarantees. nonconform wraps anomaly detectors (from PyOD, scikit-learn, or custom implementations) and transforms their raw anomaly scores into statistically valid p-values. It applies principles from conformal prediction to one-class classification, enabling anomaly detection with provable statistical guarantees and a controlled false discovery rate.

Note: The methods in nonconform assume that training and test data are exchangeable [Vovk et al., 2005]. Therefore, the package is not suited for data with spatial or temporal autocorrelation unless such dependencies are explicitly handled in preprocessing or model design.

:hatching_chick: Getting Started

Installation via PyPI:

pip install nonconform

Note: The following examples use an external dataset API. Install with pip install oddball or pip install "nonconform[data]" to include it. (see Optional Dependencies)

Classical (Conformal) Approach

Example: Detecting anomalies with Isolation Forest on the Shuttle dataset. The approach splits data for calibration, trains the model, then converts anomaly scores to p-values by comparing test scores against the calibration distribution. See ConformalDetector, Split, and FDR Control.

from pyod.models.iforest import IForest
from scipy.stats import false_discovery_control

from nonconform import ConformalDetector, Split
from nonconform.metrics import false_discovery_rate, statistical_power
from oddball import Dataset, load

x_train, x_test, y_test = load(Dataset.SHUTTLE, setup=True, seed=42)

detector = ConformalDetector(
    detector=IForest(behaviour="new"),
    strategy=Split(n_calib=1_000),
    seed=42,
)
p_values = detector.fit(x_train).compute_p_values(x_test)
decisions = false_discovery_control(p_values, method="bh") <= 0.2

print(f"Empirical FDR: {false_discovery_rate(y_test, decisions)}")
print(f"Statistical Power: {statistical_power(y_test, decisions)}")

Output:

Empirical FDR: 0.18
Statistical Power: 0.99

:hatched_chick: Advanced Methods

Two advanced approaches are implemented that may increase the power of a conformal anomaly detector:

  • A KDE-based (probabilistic) approach that models the calibration scores to achieve continuous p-values in contrast to the standard empirical distribution function.
  • A weighted approach that prioritizes calibration scores by their similarity to the test batch at hand and is more robust to covariate shift between test and calibration data (can be combined with the probabilistic approach).
  • Exchangeability martingales for sequential evidence monitoring on conformal p-value streams (PowerMartingale, SimpleMixtureMartingale, SimpleJumperMartingale).

Probabilistic Conformal Approach:

from pyod.models.iforest import IForest

from nonconform import ConformalDetector, Split, Probabilistic

detector = ConformalDetector(
    detector=IForest(behaviour="new"),
    strategy=Split(n_calib=1_000),
    estimation=Probabilistic(n_trials=10),
    seed=42,
)

Weighted Conformal Anomaly Detection:

from pyod.models.iforest import IForest

from nonconform import ConformalDetector, Split, logistic_weight_estimator

detector = ConformalDetector(
    detector=IForest(behaviour="new"),
    strategy=Split(n_calib=1_000),
    weight_estimator=logistic_weight_estimator(),
    seed=42,
)

Note: Weighted procedures require weighted FDR control for statistical validity (see nonconform.fdr.weighted_false_discovery_control()).

Exchangeability Martingales (sequential monitoring):

This snippet shows martingale setup only. In normal use:

  • a fitted ConformalDetector produces streaming conformal p-values from model scores
  • each incoming p-value is fed to the martingale via martingale.update(p_t)
from nonconform.martingales import AlarmConfig, PowerMartingale

martingale = PowerMartingale(
    epsilon=0.5,
    alarm_config=AlarmConfig(ville_threshold=100.0),
)

# update one p-value at a time
state = martingale.update(float(p_t))

# or update a sequence of p-values
states = martingale.update_many(p_values_chunk)

Note: Martingale alarms are evidence-monitoring signals on sequential p-values. They are not a replacement for cross-hypothesis FDR control. See the user guide for a compact end-to-end flow: Exchangeability Martingales.

Beyond Static Data

While primarily designed for static (single-batch) applications, the optional onlinefdr dependency provides FDR control methods appropriate for streaming scenarios.

Custom Detectors

Any detector implementing the AnomalyDetector protocol works with nonconform:

from typing import Self

import numpy as np

class MyDetector:
    def fit(self, X, y=None) -> Self: ...
    def decision_function(self, X) -> np.ndarray: ...  # higher = more anomalous
    def get_params(self, deep=True) -> dict: ...
    def set_params(self, **params) -> Self: ...

For custom detectors, either set score_polarity explicitly ("higher_is_anomalous" in most cases), or omit it to use the pre-release default behavior. Use score_polarity="auto" only when you want strict detector-family validation.

See Detector Compatibility for details and examples.

Citation

If you find this repository useful for your research, please cite the following papers:

Leave-One-Out-, Bootstrap- and Cross-Conformal Anomaly Detectors
@inproceedings{Hennhofer2024,
    title     = {Leave-One-Out-, Bootstrap- and Cross-Conformal Anomaly Detectors},
    author    = {Hennhofer, Oliver and Preisach, Christine},
    year      = {2024},
    month     = {Dec},
    booktitle = {2024 IEEE International Conference on Knowledge Graph (ICKG)},
    publisher = {IEEE Computer Society},
    address   = {Los Alamitos, CA, USA},
    pages     = {110--119},
    doi       = {10.1109/ICKG63256.2024.00022},
    url       = {https://doi.ieeecomputersociety.org/10.1109/ICKG63256.2024.00022}
}
Testing for Outliers with Conformal p-Values
@article{Bates2023,
    title     = {Testing for outliers with conformal p-values},
    author    = {Bates, Stephen and Candès, Emmanuel and Lei, Lihua and Romano, Yaniv and Sesia, Matteo},
    year      = {2023},
    month     = {Feb},
    journal   = {The Annals of Statistics},
    publisher = {Institute of Mathematical Statistics},
    volume    = {51},
    number    = {1},
    doi       = {10.1214/22-aos2244},
    issn      = {0090-5364},
    url       = {http://dx.doi.org/10.1214/22-AOS2244}
}
Algorithmic Learning in a Random World
@book{Vovk2005,
    title     = {Algorithmic Learning in a Random World},
    author    = {Vladimir Vovk and Alex Gammerman and Glenn Shafer},
    year      = {2005},
    publisher = {Springer},
    note      = {Springer, New York},
    language  = {English}
}
Testing Exchangeability On-line
@inproceedings{Vovk2003,
    title     = {Testing Exchangeability On-line},
    author    = {Vovk, Vladimir and Nouretdinov, Ilia and Gammerman, Alex},
    booktitle = {Proceedings of the 20th International Conference on Machine Learning (ICML)},
    year      = {2003}
}
Retrain or Not Retrain: Conformal Test Martingales for Change-Point Detection
@inproceedings{Vovk2021,
    title     = {Retrain or Not Retrain: Conformal Test Martingales for Change-Point Detection},
    author    = {Vovk, Vladimir and Volkhonskiy, Daniil and Nouretdinov, Ilia and Gammerman, Alex},
    booktitle = {Proceedings of The 10th Symposium on Conformal and Probabilistic Prediction and Applications},
    series    = {PMLR},
    volume    = {152},
    pages     = {210--231},
    year      = {2021},
    url       = {https://proceedings.mlr.press/v152/vovk21b.html}
}

Optional Dependencies

For additional features, you might need optional dependencies:

  • pip install nonconform[pyod] - Includes PyOD anomaly detection library
  • pip install nonconform[data] - Includes oddball for loading benchmark datasets
  • pip install nonconform[fdr] - Includes advanced FDR control methods (online-fdr)
  • pip install nonconform[probabilistic] - Includes KDEpy and Optuna for probabilistic estimation/tuning
  • pip install nonconform[all] - Includes all optional dependencies

Please refer to the pyproject.toml for details.

Contact

Bug reporting: https://github.com/OliverHennhoefer/nonconform/issues


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nonconform-0.98.72.tar.gz (624.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nonconform-0.98.72-py3-none-any.whl (55.7 kB view details)

Uploaded Python 3

File details

Details for the file nonconform-0.98.72.tar.gz.

File metadata

  • Download URL: nonconform-0.98.72.tar.gz
  • Upload date:
  • Size: 624.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.5

File hashes

Hashes for nonconform-0.98.72.tar.gz
Algorithm Hash digest
SHA256 1f05620aa7b974d970f468bb072729a063e2dcaf10c8d43de1344c3d61426bee
MD5 f47bb097c1c86f8d7ee579518dac72cb
BLAKE2b-256 ef09f4bed7acd2174e280cb51da4c2296dca98539b16298f140cb99a133947ed

See more details on using hashes here.

File details

Details for the file nonconform-0.98.72-py3-none-any.whl.

File metadata

File hashes

Hashes for nonconform-0.98.72-py3-none-any.whl
Algorithm Hash digest
SHA256 7308909e88a4772808bc0dc5bfbeadff8599f802897a7dd340d96dd8f1304266
MD5 61ee193c3262574230ccb6c9468a782f
BLAKE2b-256 1d8780d6d94f2233eccc0eb968c69af40cb269c3de1afeb89acb7f98865d4b51

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page