Guides
Regression workflow
- Train or define any black-box predictor
f(x).
- Wrap it in
SelfCalibratingConformalPredictor.
- Calibrate on an independent calibration set.
- Use
predict_point, predict_venn_abers, and predict_interval on new data.
- Use
check_coverage and plot to inspect empirical behavior on held-out data.
Quantile-loss workflow
- Choose a conformity score
S(x, y), typically |y - mu(x)|.
- Train a predictor for the
(1 - alpha) quantile of that score.
- Wrap the quantile predictor in
VennAbersQuantileConformalPredictor.
- Calibrate using isotonic quantile calibration.
- Form intervals from the score level set
{ y : S(x, y) <= threshold(x, y) }.
- Inspect both marginal coverage and threshold calibration with
check_threshold_calibration.
Customization hooks
- Provide any callable or
.predict model as the base predictor.
- Swap in a custom calibrator with the same signature as the built-ins.
- Provide a custom conformity score on either the regression or quantile workflow.
- Use the advanced notebook when you want custom-score examples instead of the default absolute-residual construction.