# seapig

> Selective prediction based on confidence scores

## Docs

### API Reference

#### Task & Metric Classes
> Core classes for defining selective inference tasks and metrics

- [SelectiveInferenceTask](www.seapig.dev/reference/reference/SelectiveInferenceTask.html): Wrap a trained `LightningModule` to attach selection results during inference
- [SelectiveMetric](www.seapig.dev/reference/reference/SelectiveMetric.html): Evaluate a metric on full, selected, and rejected subsets
- [RiskCoverageMetric](www.seapig.dev/reference/reference/RiskCoverageMetric.html): Build a risk-coverage curve from scores and per-sample errors
- [RiskCoverage](www.seapig.dev/reference/reference/RiskCoverage.html): Container for risk-coverage results

#### Embedding based Confidence Scores
> Confidence scoring methods for embedding-based approaches

- [scores.CosineScore](www.seapig.dev/reference/reference/scores.CosineScore.html)
- [scores.EuclideanScore](www.seapig.dev/reference/reference/scores.EuclideanScore.html)
- [scores.MahalanobisScore](www.seapig.dev/reference/reference/scores.MahalanobisScore.html)
- [scores.PCAScore](www.seapig.dev/reference/reference/scores.PCAScore.html)
- [scores.PyODScore](www.seapig.dev/reference/reference/scores.PyODScore.html)

#### Logit based Confidence Scores
> Confidence scoring methods based on model logits

- [scores.EnergyScore](www.seapig.dev/reference/reference/scores.EnergyScore.html)
- [scores.EntropyScore](www.seapig.dev/reference/reference/scores.EntropyScore.html)
- [scores.MarginScore](www.seapig.dev/reference/reference/scores.MarginScore.html)
- [scores.SoftmaxScore](www.seapig.dev/reference/reference/scores.SoftmaxScore.html)

#### Other Confidence Scores
> Confidence scoring methods based on other principles

- [scores.RandomScore](www.seapig.dev/reference/reference/scores.RandomScore.html)

#### Abstract Classes
> Abstract base classes

- [scores.ConfidenceScore](www.seapig.dev/reference/reference/scores.ConfidenceScore.html)
- [scores.EmbeddingScore](www.seapig.dev/reference/reference/scores.EmbeddingScore.html)
- [scores.KNNScore](www.seapig.dev/reference/reference/scores.KNNScore.html)
- [scores.LogitScore](www.seapig.dev/reference/reference/scores.LogitScore.html)

#### Utilities
> Helpers for progress and logging

- [utils.track](www.seapig.dev/reference/reference/utils.track.html)
- [utils.enable](www.seapig.dev/reference/reference/utils.enable.html)
- [utils.disable](www.seapig.dev/reference/reference/utils.disable.html)
- [utils.set_backend](www.seapig.dev/reference/reference/utils.set_backend.html)
- [utils.get_backend](www.seapig.dev/reference/reference/utils.get_backend.html)
- [utils.get_logger](www.seapig.dev/reference/reference/utils.get_logger.html)
- [utils.configure_logging](www.seapig.dev/reference/reference/utils.configure_logging.html)