Skip to main content

A PyTorch Library for benchmarking and leveraging efficient predictive uncertainty quantification techniques.

Project description

Torch Uncertainty

tests Code Coverage Code style: black

Torch Uncertainty is a package designed to help you leverage uncertainty quantification techniques and make your neural networks more reliable. It is based on PyTorch Lightning to handle multi-GPU training and inference and automatic logging through tensorboard.


This package provides a multi-level API, including:

  • ready-to-train baselines on research datasets, such as CIFAR and ImageNet
  • baselines available for training on your datasets
  • layers available for use in your networks

Installation

The package can be installed from PyPI or from source.

From PyPI (available soon)

Install the package via pip: pip install torch-uncertainty

From source

Installing Poetry

Installation guidelines for poetry are available on https://python-poetry.org/docs/. They boil down to executing the following command:

curl -sSL https://install.python-poetry.org | python3 -

Installing the package

Clone the repository:

git clone https://github.com/ENSTA-U2IS/torch-uncertainty.git

Create a new conda environment and activate it with:

conda create -n uncertainty && conda activate uncertainty

Install the package using poetry:

poetry install torch-uncertainty or, for development, poetry install torch-uncertainty --with dev

Depending on your system, you may encounter errors. If so, kill the process and add PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring at the beginning of every poetry install commands.

Contributing

In case that you would like to contribute, install from source and add the pre-commit hooks with pre-commit install

Getting Started and Documentation

Please find the documentation at torch-uncertainty.github.io.

A quickstart is available at torch-uncertainty.github.io/quickstart.

Implemented baselines

To date, the following baselines are implemented:

  • Deep Ensembles
  • Masksembles
  • Packed-Ensembles

Awesome Torch repositories

You may find a lot of information about modern uncertainty estimation techniques on the Awesome Uncertainty in Deep Learning.

References

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

torch_uncertainty-0.1.0.tar.gz (37.7 kB view details)

Uploaded Source

Built Distribution

torch_uncertainty-0.1.0-py3-none-any.whl (69.7 kB view details)

Uploaded Python 3

File details

Details for the file torch_uncertainty-0.1.0.tar.gz.

File metadata

  • Download URL: torch_uncertainty-0.1.0.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for torch_uncertainty-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6ca3ce96f97b711fd4482197230efc5cdb1183710ad7da344477e3818a1fb496
MD5 960db0911444f5d031d5ee6802ef403c
BLAKE2b-256 c996f6139d8fc85c217bf41285a9b4463eb344af84cbdc6c8c0c723779783efa

See more details on using hashes here.

File details

Details for the file torch_uncertainty-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for torch_uncertainty-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a959860e727bb68295862c7a0c00eb0a376c6493958f578a34a1d50449b94748
MD5 2c5e6c56bee057e7081b2ae2ed1e0459
BLAKE2b-256 1b6ebbd5e764818d845196f0093969f6b555dfd992200d042e84e2a80562f2fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page