subselect 0.0.1__py3-none-any.whl

subselect/__init__.py

@@ -0,0 +1,3 @@
+"""Subset-contrast unsupervised model selection for anomaly detection."""
+__version__ = "0.0.1"
+__all__ = ["__version__"]

subselect-0.0.1.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.4
+Name: subselect
+Version: 0.0.1
+Summary: Subset-contrast unsupervised model selection for anomaly detection
+Project-URL: Homepage, https://github.com/k-kammler/subselect
+Project-URL: Repository, https://github.com/k-kammler/subselect
+Project-URL: Issues, https://github.com/k-kammler/subselect/issues
+Author-email: Kevin Kammler <k.kammler@uni-mainz.de>
+License: MIT License
+        
+        Copyright (c) 2026 Kevin Kammler
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: anomaly detection,hyperparameter selection,model selection,outlier detection,unsupervised learning
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# subselect
+
+**Subset-contrast unsupervised model selection for anomaly detection.**
+
+Given a pool of trained anomaly-detection models with no ground-truth labels,
+pick the best one by measuring the contrast between each model's top-ranked
+points (predicted anomalies) and the rest of the data.
+
+## Why
+
+In anomaly detection, practitioners must choose among many models (Isolation
+Forest, LOF, kNN, OCSVM, ...) with different hyperparameters. The standard way
+to evaluate models is supervised, using metrics like ROC-AUC that require
+labelled anomalies. In practice, labelled anomalies are rarely available; if
+they were, the problem would already be partly solved.
+
+`subselect` selects a model from a pool **without any labels**. A good model
+concentrates real anomalies at the top of its score ranking, so its top subset
+looks distinct from the rest of the data in feature space; a bad model's top
+subset looks like ordinary data. Measuring that contrast with a density or
+distance metric gives an unsupervised ranking that correlates with the hidden
+supervised ROC-AUC ranking.
+
+## Install
+
+```bash
+pip install subselect
+```
+
+Requires Python 3.10+ with numpy, scipy, pandas, and scikit-learn.
+
+## Quickstart
+
+```python
+import subselect as ss
+
+# scores: (n_samples, n_models) anomaly score per (sample, model); higher = more anomalous
+# X:      (n_samples, n_features) original feature matrix
+# model_names: length-n_models identifiers aligned with the columns of scores
+best = ss.Evaluator().select(scores=scores, X=X, model_names=model_names)
+print("Picked:", model_names[best])
+```
+
+`Evaluator()` selects with a single default metric (Mahalanobis distance). Pass
+a list of metrics and `ensemble=True` to combine several and add their
+rank-aggregated ensemble (the strongest configuration in our benchmarks):
+
+```python
+ev = ss.Evaluator(metrics=["mahalanobis_distance", "gmm_likelihood"], ensemble=True)
+results = ev.evaluate(scores, X, model_names)
+print(results.selected_per_metric)   # pick per metric, plus 'ensemble'
+```
+
+## Shipped metrics
+
+Five contrast metrics across the density and distance families:
+
+| name | family | direction |
+|------|--------|-----------|
+| `mahalanobis_distance` | distance, global covariance | higher = better |
+| `knn_avg_distance` | distance, local | higher = better |
+| `lof_score` | local density (LOF) | higher = better |
+| `kde_log_likelihood` | density, non-parametric | lower = better |
+| `gmm_likelihood` | density, parametric | lower = better |
+
+`ss.list_metrics()` lists them and `ss.metric_sets["core"]` is all five.
+
+## Custom contrast metric
+
+Three ways to add your own:
+
+```python
+# 1. Subclass - most flexible
+class MyMetric(ss.ContrastMetric):
+    direction = +1                          # higher value -> better model
+    kind = "per-point"
+
+    def fit_reference(self, X_ref):         # fit on the complement (the reference)
+        return self
+
+    def score_subset(self, X_sub):
+        return {"mean": ..., "std": ..., "median": ...}
+
+# 2. Decorator - one function
+@ss.contrast_metric(direction=+1, kind="per-point", name="my_metric")
+def my_metric(subset_X, reference_X):
+    return float(...)
+
+# 3. Inline callable - quickest
+ss.Evaluator(metrics=[(my_metric_callable, +1)]).select(scores, X, model_names)
+```
+
+## Citation
+
+See [CITATION.cff](CITATION.cff). A paper describing the method is forthcoming.
+
+## License
+
+MIT. See [LICENSE](LICENSE).

subselect-0.0.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+subselect/__init__.py,sha256=SrctYDLzZCVfDPEGlQAY_24rRRA3Eg2qaZ5tTQKSgN8,122
+subselect-0.0.1.dist-info/METADATA,sha256=RXS5VRogIfx1igg0_2dcMDjAuQ6QhDCLKJ8IBPnCPnM,5756
+subselect-0.0.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+subselect-0.0.1.dist-info/licenses/LICENSE,sha256=ldi5oagLySp_hbm8BFKNnUOj6aS2DCTbHj-o7ui8XSE,1070
+subselect-0.0.1.dist-info/RECORD,,

subselect-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

subselect-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kevin Kammler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.