TinyConformal
Related project: tinyshift
TinyConformal is a Python library for conformal prediction in classification and regression.
It provides tools to build valid prediction sets and prediction intervals with a target significance level (alpha).
For more information on a previous project related to Out-of-Bag (OOB) solutions, visit this link.
Recent updates
- Added support for exactness-bound-based calibration through
ExactnessBoundfor ICP and CQR workflows. - Added
unlabeled_fitsupport for conformal classifiers and regressors, enabling calibration without labeled calibration data when an exactness bound is available. - Classifiers can now be calibrated from unlabeled data using pseudo-labels derived from model predictions, while regressors can use a pre-estimated exactness bound to build the conformity scores.
Previously, calibrate used Balanced Accuracy Score; it can now also be calibrated with Matthews Correlation Coefficient or Bookmaker Informedness Score for improved reliability. The evaluate method also reports bm and mcc.
Currently, TinyConformal supports Out-of-Bag (OOB) solutions for RandomForestClassifier in binary classification problems, as well as RandomForestRegressor and RandomForestQuantileRegressor for regression tasks. For additional options and advanced features, you may want to explore Crepes.
Installation
Using pip
pip install tinyconformal
Optional extras:
pip install "tinyconformal[plot]"
pip install "tinyconformal[notebook]"
pip install "tinyconformal[dev]"
Using uv
Install in the current environment:
uv pip install tinyconformal
Add as a dependency in a project:
uv add tinyconformal
Optional extras with uv:
uv pip install "tinyconformal[plot]"
uv pip install "tinyconformal[notebook]"
uv pip install "tinyconformal[dev]"
Submodules and usage
TinyConformal is organized into two main submodules:
tinyconformal.classifier: conformal classifiers for binary classification.tinyconformal.regressor: conformal regressors and exactness-bound utilities.
Classifier submodule
Import from tinyconformal.classifier:
from tinyconformal.classifier import BinaryMarginalConformalClassifier
from tinyconformal.classifier import BinaryClassConditionalConformalClassifier
Regressor submodule
Import from tinyconformal.regressor:
from tinyconformal.regressor import ConformalizedRegressor
from tinyconformal.regressor import ConformalizedQuantileRegressor
from tinyconformal.regressor import ExactnessBound
Example
Example usage of BinaryClassConditionalConformalClassifier:
from sklearn.ensemble import RandomForestClassifier
from tinyconformal.classifier import BinaryClassConditionalConformalClassifier
# Create and fit a RandomForestClassifier
learner = RandomForestClassifier(n_estimators=100, oob_score=True)
X_train, y_train = ... # your training data
learner.fit(X_train, y_train)
# Create and fit the conformal classifier
conformal_classifier = BinaryClassConditionalConformalClassifier(learner)
conformal_classifier.fit(y=y_train, oob=True)
# Make predictions
X_test = ... # your test data
predictions = conformal_classifier.predict(X_test)
Unlabeled calibration example
For settings where labeled calibration data are unavailable, you can fit the conformal model directly on unlabeled data:
from sklearn.ensemble import RandomForestClassifier
from tinyconformal.classifier import BinaryMarginalConformalClassifier
learner = RandomForestClassifier(n_estimators=100, oob_score=True)
learner.fit(X_train, y_train)
conformal_classifier = BinaryMarginalConformalClassifier(learner)
conformal_classifier.unlabeled_fit(X_unlabeled)
predictions = conformal_classifier.predict(X_test)
For regressors, you can combine an exactness bound estimate with unlabeled calibration:
from sklearn.ensemble import RandomForestRegressor
from tinyconformal.regressor import ConformalizedRegressor, ExactnessBound
learner = RandomForestRegressor(random_state=42)
tilde_beta, beta = ExactnessBound.estimate_icp_bound(
learner, X_train, y_train, p=0.95, cv=5
)
# Fit learner before using conformal regressor
learner.fit(X_train, y_train)
regressor = ConformalizedRegressor(learner, alpha=0.05)
regressor.unlabeled_fit(X_unlabeled, tilde_beta=tilde_beta, beta=beta)
intervals = regressor.predict_interval(X_test)
Evaluating the Classifier
Evaluate the performance of the conformal classifier using the evaluate method:
results = conformal_classifier.evaluate(X_test, y_test)
print(results)
Classes
BinaryMarginalConformalClassifier
BinaryMarginalConformalClassifier is a marginal-coverage conformal classifier that uses a classifier as the underlying learner.
- Training via labeled calibration:
fit(X, y) - Training via OOB calibration:
fit(y=y_train, oob=True) - Training via unlabeled calibration:
unlabeled_fit(X, beta=...)
BinaryClassConditionalConformalClassifier
BinaryClassConditionalConformalClassifier is a class-conditional conformal classifier that uses a classifier as the underlying learner.
- Training via labeled calibration:
fit(X, y) - Training via OOB calibration:
fit(y=y_train, oob=True) - Training via unlabeled calibration:
unlabeled_fit(X, beta=...)using pseudo-labels derived from the model probabilities
ConformalizedRegressor
ConformalizedRegressor is a conformal regressor built on a regression learner.
- Training via labeled calibration:
fit(X, y) - Training via OOB calibration:
fit(X, y, oob=True) - Training via unlabeled calibration:
unlabeled_fit(X, tilde_beta=..., beta=...)using an exactness bound
ConformalizedQuantileRegressor
ConformalizedQuantileRegressor is a conformal quantile regressor built on a quantile regressor.
- Training via labeled calibration:
fit(X, y) - Training via OOB calibration:
fit(X, y, oob=True) - Training via unlabeled calibration:
unlabeled_fit(X, tilde_beta=..., beta=...)using an exactness bound
ExactnessBound
ExactnessBound provides helper methods to estimate the exactness bound used in unlabeled conformal calibration for ICP and CQR workflows.
License
This project is licensed under the MIT License.
Release files for tinyconformal 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tinyconformal-0.2.0.tar.gz | 18.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tinyconformal-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.0 kB
Release files / tinyconformal-0.2.0.tar.gz
| Download URL | tinyconformal-0.2.0.tar.gz |
|---|---|
| Size | 18.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c394a29c3e0277a7a51533b90925b95ff11e8c271e06c5975920a415acc247c
|
|
BLAKE2b-256 checksum How to use checksums |
2e0868fea4feb314623f3f31904fcfd13b91fe747da1347836146d0f400328eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|
Release files / tinyconformal-0.2.0-py3-none-any.whl
| Download URL | tinyconformal-0.2.0-py3-none-any.whl |
|---|---|
| Size | 21.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f676808e9d41a77604abab11fa6f652a888ea629b5d530d72981f0050d2ad64
|
|
BLAKE2b-256 checksum How to use checksums |
8f39176dd8053410409716cf1e7d4a51e9d89bd4ac85d713d06d3039c8b9df61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.22
|