Metadata-Version: 2.1
Name: dirichletcal
Version: 0.1.dev1
Summary: Python code for Dirichlet calibration
Home-page: https://github.com/dirichletcal/dirichlet_python
Author: Miquel Perello Nieto and Hao Song
Author-email: perello.nieto@gmail.com
License: UNKNOWN
Download-URL: https://github.com/dirichletcal/dirichlet_python/archive/0.1.dev1.tar.gz
Keywords: classifier,calibration,dirichlet,multiclass,probability
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: numpy (<0.19.2jaxjaxlibautograd,<1.0.1scikit-learn>=0.19.1,<1.14.3scipy>=1.0.0,>=1.14.2)

# Dirichlet Calibration Python implementation

This is a Python implementation of the Dirichlet Calibration presented in
__Beyond temperature scaling: Obtaining well-calibrated multi-class probabilities
with Dirichlet calibration__ at NeurIPS 2019.

# Installation

```
# Clone the repository
git clone git@github.com:dirichletcal/dirichlet_python.git
# Go into the folder
cd dirichlet_python
# Create a new virtual environment with Python3
python3.6 -m venv venv
# Load the generated virtual environment
source venv/bin/activate
# Upgrade pip
pip install --upgrade pip
# Install all the dependencies
pip install -r requirements.txt
```

# Unittest

```
python -m unittest discover dirichletcal
```


# Cite

If you use this code in a publication please cite the following paper


```
@inproceedings{kull2019dircal,
  title={Beyond temperature scaling: Obtaining well-calibrated multi-class probabilities with Dirichlet calibration},
  author={Kull, Meelis and Nieto, Miquel Perello and K{\"a}ngsepp, Markus and Silva Filho, Telmo and Song, Hao and Flach, Peter},
  booktitle={Advances in Neural Information Processing Systems},
  pages={12295--12305},
  year={2019}
}
```


