MAPIE - Model Agnostic Prediction Interval Estimator
MAPIE allows you to easily estimate prediction intervals (or prediction sets) using your favourite scikit-learn-compatible model for single-output regression or multi-class classification settings.
Prediction intervals output by MAPIE encompass both aleatoric and epistemic uncertainties and are backed by strong theoretical guarantees [1-4].
🔗
Requirements
Python 3.7+
MAPIE stands on the shoulders of giants.
Its only internal dependency is scikit-learn.
🛠
Installation
Install via pip:
$ pip install mapie
or via conda:
$ conda install -c conda-forge mapie
To install directly from the github repository :
$ pip install git+https://github.com/simai-ml/MAPIE
⚡️
Quickstart
Let us start with a basic regression problem. Here, we generate one-dimensional noisy data that we fit with a linear model.
import numpy as np
from sklearn.linear_model import LinearRegression
from sklearn.datasets import make_regression
regressor = LinearRegression()
X, y = make_regression(n_samples=500, n_features=1, noise=20, random_state=59)
Since MAPIE is compliant with the standard scikit-learn API, we follow the standard sequential fit and predict process like any scikit-learn regressor. We set two values for alpha to estimate prediction intervals at approximately one and two standard deviations from the mean.
from mapie.estimators import MapieRegressor
alpha = [0.05, 0.32]
mapie = MapieRegressor(regressor)
mapie.fit(X, y)
y_pred, y_pis = mapie.predict(X, alpha=alpha)
MAPIE returns a np.ndarray of shape (n_samples, 3, len(alpha)) giving the predictions, as well as the lower and upper bounds of the prediction intervals for the target quantile for each desired alpha value. The estimated prediction intervals can then be plotted as follows.
from matplotlib import pyplot as plt
from mapie.metrics import coverage_score
plt.xlabel("x")
plt.ylabel("y")
plt.scatter(X, y, alpha=0.3)
plt.plot(X, y_pred, color="C1")
order = np.argsort(X[:, 0])
plt.plot(X[order], y_pis[order][:, 0, 1], color="C1", ls="--")
plt.plot(X[order], y_pis[order][:, 1, 1], color="C1", ls="--")
plt.fill_between(
X[order].ravel(),
y_pis[order][:, 0, 0].ravel(),
y_pis[order][:, 1, 0].ravel(),
alpha=0.2
)
coverage_scores = [
coverage_score(y, y_pis[:, 0, i], y_pis[:, 1, i])
for i, _ in enumerate(alpha)
]
plt.title(
f"Target and effective coverages for "
f"alpha={alpha[0]:.2f}: ({1-alpha[0]:.3f}, {coverage_scores[0]:.3f})\n"
f"Target and effective coverages for "
f"alpha={alpha[1]:.2f}: ({1-alpha[1]:.3f}, {coverage_scores[1]:.3f})"
)
plt.show()
The title of the plot compares the target coverages with the effective coverages. The target coverage, or the confidence interval, is the fraction of true labels lying in the prediction intervals that we aim to obtain for a given dataset. It is given by the alpha parameter defined in MapieRegressor, here equal to 0.05 and 0.32, thus giving target coverages of 0.95 and 0.68. The effective coverage is the actual fraction of true labels lying in the prediction intervals.
📘
Documentation
The full documentation can be found on this link.
How does MAPIE work on regression ? It is basically based on cross-validation and relies on:
- Residuals on the whole trainig set obtained by cross-validation,
- Perturbed models generated during the cross-validation.
MAPIE then combines all these elements in a way that provides prediction intervals on new data with strong theoretical guarantees [1].
📝
Contributing
You are welcome to propose and contribute new ideas. We encourage you to open an issue so that we can align on the work to be done. It is generally a good idea to have a quick discussion before opening a pull request that is potentially out-of-scope. For more information on the contribution process, please go here.
🤝
Affiliations
MAPIE has been developed through a collaboration between Quantmetry, Michelin, and ENS Paris-Saclay with the financial support from Région Ile de France.
🔍
References
MAPIE methods belong to the field of conformal inference.
[1] Rina Foygel Barber, Emmanuel J. Candès, Aaditya Ramdas, and Ryan J. Tibshirani. "Predictive inference with the jackknife+." Ann. Statist., 49(1):486–507, February 2021.
[2] Mauricio Sadinle, Jing Lei, and Larry Wasserman. "Least Ambiguous Set-Valued Classifiers With Bounded Error Levels." Journal of the American Statistical Association, 114:525, 223-234, 2019.
[3] Yaniv Romano, Matteo Sesia and Emmanuel J. Candès. "Classification with Valid and Adaptive Coverage." NeurIPS 202 (spotlight).
[4] Anastasios Nikolas Angelopoulos, Stephen Bates, Michael Jordan and Jitendra Malik. "Uncertainty Sets for Image Classifiers using Conformal Prediction." International Conference on Learning Representations 2021.
📝
License
MAPIE is free and open-source software licensed under the 3-clause BSD license.
![[ENHANCEMENT] time series conformal prediction](https://avatars.githubusercontent.com/u/57913701?v=4)
![[ENHANCEMENT] Provide new residual scores for regression](https://avatars.githubusercontent.com/u/77614412?v=4)
![[BUG]: Binary classification](https://avatars.githubusercontent.com/u/63607529?v=4)
176 Jan 04, 2023
328 Dec 29, 2022
174 Dec 22, 2022
16 Jul 27, 2022
16 Dec 26, 2022
3 Dec 19, 2022
69 Dec 26, 2022
71 Dec 25, 2022
95 Dec 24, 2022
3 Dec 18, 2021
875 Dec 31, 2022
169 Dec 23, 2022
81 Dec 14, 2022
1 Nov 26, 2021
1 Jan 07, 2022
21 Nov 21, 2022
40 Oct 11, 2022
45 Dec 29, 2022
479 Dec 08, 2022
110 Dec 07, 2022