Skip to main content

Label-free metrics for unsupervised anomaly detector evaluation

Project description

labelfree

Tests Documentation PyPI

Label-free metrics for comparing unsupervised anomaly detectors and hyperparameters when labeled anomalies are unavailable.

Install

pip install labelfree

Quick start

from labelfree.metrics import score_cluster_metrics

scores = [0.1, 0.2, 0.3, 3.8, 4.1]
metrics = score_cluster_metrics(scores, n_outliers=2)
print(metrics["silhouette"])  # higher is better

The package includes score-cluster, ASI/ASOI, AutoUAD, Laplacian, consensus, ranking-stability, IREOS, SIREOS, and Excess-Mass/Mass-Volume metrics. Every raw-score API requires an explicit score polarity when larger values mean more normal.

Label-free metrics are model-selection signals, not substitutes for labeled evaluation. Check each metric's assumptions and direction before comparing results.

See the documentation for metric selection, API details, and examples.

Development

python -m pip install -e ".[dev]"
pytest

Contributions are welcome; see CONTRIBUTING.md. Released under the MIT License.

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

labelfree-1.0.0.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

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

labelfree-1.0.0-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file labelfree-1.0.0.tar.gz.

File metadata

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

File hashes

Hashes for labelfree-1.0.0.tar.gz
Algorithm Hash digest
SHA256 31df35db17d49664fbc698124b6ca6bce1ae52049623fb364c3702670ed57036
MD5 9fe654868351a31631d5642d542f8860
BLAKE2b-256 bb5fafa472027c4981f5ff225cdfd0b322f92a012d3b443d1d83055a6140d409

See more details on using hashes here.

File details

Details for the file labelfree-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: labelfree-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.5

File hashes

Hashes for labelfree-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ba7d75149ddbe2b20697239db75b68dec47a1a2a003a3338a7540f9b81e310e9
MD5 e028b45c258a904c2d97165a72f0b346
BLAKE2b-256 c10d8f6768e373490c5d8f94c0a77257a5741e6505db7d938ed5bab983259722

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