API Reference ============= .. currentmodule:: torch_uncertainty Routines -------- The routine are the main building blocks of the library. They define the framework in which the models are trained and evaluated. They allow for easy computation of different metrics crucial for uncertainty estimation in different contexts, namely classification, regression and segmentation. .. currentmodule:: torch_uncertainty.routines Classification ^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst ClassificationRoutine Segmentation ^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst SegmentationRoutine Regression ^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst RegressionRoutine Pixelwise Regression ^^^^^^^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst PixelRegressionRoutine Baselines --------- .. warning:: The baselines will soon be removed from the library to avoid confusion with the routines. TorchUncertainty provide lightning-based models that can be easily trained and evaluated. These models inherit from the routines and are specifically designed to benchmark different methods in similar settings, here with constant architectures. .. currentmodule:: torch_uncertainty.baselines.classification Classification ^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst ResNetBaseline VGGBaseline WideResNetBaseline .. currentmodule:: torch_uncertainty.baselines.regression Regression ^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst MLPBaseline .. currentmodule:: torch_uncertainty.baselines.segmentation Segmentation ^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst DeepLabBaseline SegFormerBaseline .. currentmodule:: torch_uncertainty.baselines.depth Monocular Depth Estimation ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BTSBaseline Layers ------ Ensemble layers ^^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.layers .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst PackedLinear PackedConv2d PackedMultiheadAttention PackedLayerNorm PackedTransformerEncoderLayer PackedTransformerDecoderLayer BatchLinear BatchConv2d MaskedLinear MaskedConv2d Bayesian layers ^^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.layers.bayesian .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BayesLinear BayesConv1d BayesConv2d BayesConv3d LPBNNLinear LPBNNConv2d Density layers ^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.layers.distributions Linear Layers """"""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst NormalLinear LaplaceLinear CauchyLinear StudentTLinear NormalInverseGammaLinear Convolution Layers """""""""""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst NormalConvNd LaplaceConvNd CauchyConvNd StudentTConvNd NormalInverseGammaConvNd Models ------ .. currentmodule:: torch_uncertainty.models Wrappers ^^^^^^^^ Functions """"""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: function.rst batch_ensemble deep_ensembles mc_dropout Classes """"""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BatchEnsemble CheckpointCollector EMA MCDropout StochasticModel SWA SWAG Metrics ------- Classification ^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.metrics.classification Proper Scores """"""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class_with_ex.rst BrierScore .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst CategoricalNLL Out-of-Distribution Detection """"""""""""""""""""""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst FPRx FPR95 Selective Classification """""""""""""""""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst AUGRC AURC CovAtxRisk CovAt5Risk RiskAtxCov RiskAt80Cov Calibration """"""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst AdaptiveCalibrationError CalibrationError Conformal Predictions """"""""""""""""""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst CoverageRate SetSize Diversity """"""""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst Disagreement Entropy MutualInformation VariationRatio Others """""" .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst GroupingLoss Regression ^^^^^^^^^^ .. currentmodule:: torch_uncertainty.metrics.regression .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst DistributionNLL Log10 MeanAbsoluteErrorInverse MeanGTRelativeAbsoluteError MeanGTRelativeSquaredError MeanSquaredErrorInverse MeanSquaredLogError SILog ThresholdAccuracy Segmentation ^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.metrics.segmentation .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst MeanIntersectionOverUnion SegmentationBinaryAUROC SegmentationBinaryAveragePrecision SegmentationFPR95 Others ^^^^^^ .. currentmodule:: torch_uncertainty.metrics .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst AUSE Losses ------ .. currentmodule:: torch_uncertainty.losses .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BCEWithLogitsLSLoss BetaNLL ConflictualLoss ConfidencePenaltyLoss DECLoss DERLoss DistributionNLLLoss ELBOLoss FocalLoss KLDiv Post-Processing Methods ----------------------- .. currentmodule:: torch_uncertainty.post_processing .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst LaplaceApprox MCBatchNorm Scaling Methods ^^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class_inherited.rst MatrixScaler TemperatureScaler VectorScaler OOD Scores ----------------------- .. currentmodule:: torch_uncertainty.ood_criteria .. autosummary:: :toctree: generated/ :nosignatures: :template: class_inherited.rst TUOODCriterion MaxLogitCriterion EnergyCriterion MaxSoftmaxCriterion EntropyCriterion MutualInformationCriterion PostProcessingCriterion VariationRatioCriterion Datamodules ----------- .. currentmodule:: torch_uncertainty.datamodules.abstract .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst .. currentmodule:: torch_uncertainty.datamodules Classification ^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst CIFAR10DataModule CIFAR100DataModule ImageNetDataModule MNISTDataModule TinyImageNetDataModule UCI Tabular Classification ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BankMarketingDataModule DOTA2GamesDataModule HTRU2DataModule OnlineShoppersDataModule SpamBaseDataModule Regression ^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst UCIRegressionDataModule .. currentmodule:: torch_uncertainty.datamodules.segmentation Segmentation ^^^^^^^^^^^^ .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst CamVidDataModule CityscapesDataModule MUADDataModule Datasets -------- .. currentmodule:: torch_uncertainty.datasets Classification ^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.datasets.classification .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst MNISTC NotMNIST CIFAR10C CIFAR100C CIFAR10H CIFAR10N CIFAR100N ImageNetA ImageNetC ImageNetO ImageNetR TinyImageNet TinyImageNetC OpenImageO UCI Tabular Classification ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.datasets.classification.uci .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst BankMarketing DOTA2Games HTRU2 OnlineShoppers SpamBase Regression ^^^^^^^^^^ .. currentmodule:: torch_uncertainty.datasets.regression .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst UCIRegression Segmentation ^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.datasets.segmentation .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst CamVid Cityscapes Others & Cross-Categories ^^^^^^^^^^^^^^^^^^^^^^^^^ .. currentmodule:: torch_uncertainty.datasets .. autosummary:: :toctree: generated/ :nosignatures: :template: class.rst Fractals FrostImages KITTIDepth MUAD NYUv2