Reference
Task & Metric Classes
Core classes for defining selective inference tasks and metrics
- SelectiveInferenceTask
-
Wrap a trained
LightningModuleto attach selection results during inference. - SelectiveMetric
-
Evaluate a metric on full, selected, and rejected subsets.
- RiskCoverageMetric
-
Build a risk-coverage curve from scores and per-sample errors.
- RiskCoverage
-
Container for risk-coverage results.
Embedding based Confidence Scores
Confidence scoring methods for embedding-based approaches
- scores.CosineScore
-
Returns the KNN-distance based on the cosine distance to the nearest samples.
- scores.EuclideanScore
-
Returns the KNN-distance based on the Euclidean distance to the nearest samples.
- scores.MahalanobisScore
-
Returns the Mahalanobis distance to the training samples distribution.
- scores.PCAScore
-
Returns confidence scores based on PCA reconstruction errors.
- scores.PyODScore
-
Confidence scores based on detectors supplied by PyOD.
Logit based Confidence Scores
Confidence scoring methods based on model logits
- scores.EnergyScore
-
Energy-based confidence score.
- scores.EntropyScore
-
Entropy-based confidence score.
- scores.MarginScore
-
Top-two margin confidence score.
- scores.SoftmaxScore
-
Maximum softmax probability confidence score.
Other Confidence Scores
Confidence scoring methods based on other principles
- scores.RandomScore
-
Returns random confidence scores per sample.
Abstract Classes
Abstract base classes
- scores.ConfidenceScore
-
Abstract Base Class for Confidence Scores.
- scores.EmbeddingScore
-
Base class for embedding-based confidence scores.
- scores.KNNScore
-
Abstract base class for KNN distance-based confidence scores.
- scores.LogitScore
-
Base class for logit-based confidence scores.
Utilities
Helpers for progress and logging
- utils.track()
-
Wrap an iterable with a progress bar.
- utils.enable()
-
Globally enable progress reporting.
- utils.disable()
-
Globally disable progress reporting.
- utils.set_backend()
-
Select the progress-bar backend.
- utils.get_backend()
-
Return the name of the currently selected backend.
- utils.get_logger()
-
Return a logger scoped to the seapig package.
- utils.configure_logging()
-
Configure the seapig package logger.