Skip to main content

Direct Epistemic Uncertainty Prediction (DEUP) for scikit-learn and gradient-boosting models, with first-class time-series support.

Project description

deup

deup library overview

Direct Epistemic Uncertainty Prediction (DEUP) for any scikit-learn model — with first-class, leakage-correct time-series support.

PyPI CI Docs

DEUP estimates epistemic uncertainty by training a secondary error predictor on your model's out-of-sample errors — no ensembles, no Bayesian retraining, works with the model you already use.

Method credit: DEUP is due to Lahlou et al., 2023 (TMLR). This package is a maintained, benchmarked, scikit-learn-compatible implementation with time-series / cross-sectional finance support and aggregation-reliability diagnostics.

Repository: https://github.com/ursinasanderink/deup · Docs: https://ursinasanderink.github.io/deup/

Quickstart

from sklearn.ensemble import RandomForestRegressor
from deup import DEUPRegressor

model = DEUPRegressor(base_model=RandomForestRegressor())
model.fit(X_train, y_train)

pred, unc = model.predict(X_test, return_uncertainty=True)

Tabular gradient boosting (LightGBM / XGBoost / CatBoost):

from deup.domains.tabular import TabularDEUP

model = TabularDEUP(backend="lgbm", cv=5).fit(X_train, y_train)
unc = model.predict_epistemic(X_test)

Time-series / cross-sectional finance (flagship preset):

from deup.domains.finance import CrossSectionalDEUP

model = CrossSectionalDEUP(horizon=20).fit(panel_df)
pred, unc = model.predict(test_df, return_uncertainty=True)
health = model.health_report(test_df)

Install

pip install deup                 # core (numpy + scikit-learn)
pip install "deup[gbm]"          # + LightGBM (TabularDEUP backend)
pip install "deup[xgb]"          # + XGBoost
pip install "deup[catboost]"     # + CatBoost
pip install "deup[gbm-all]"      # all gradient-boosting backends
pip install "deup[finance]"      # + pandas (CrossSectionalDEUP)
pip install "deup[docs]"         # + MkDocs site locally

Why this package?

The only public DEUP code was a stale research repo of notebooks — no maintained pip-installable package. Major UQ libraries (torch-uncertainty, uncertainty-toolbox, MAPIE) don't implement DEUP. deup fills that gap with leakage-correct OOF error construction and walk-forward / purged CV for time-series and finance.

Comparison (California housing, Spearman ρ vs realized squared error)

Method ρ Notes
DEUP 0.509 OOF error predictor (RF base)
DEUP + LightGBM 0.444 TabularDEUP(backend="lgbm")
DEUP + XGBoost 0.400 TabularDEUP(backend="xgb")
DEUP + CatBoost 0.407 TabularDEUP(backend="catboost")
Ensemble disagreement 0.460 Bootstrap variance
Conformal residual 0.447 |y − ŷ| on cal split
Laplace (last-layer) 0.015 Not applicable to trees

Full results: Benchmarks.

Documentation

Topic Link
Getting started docs/getting-started
Five-axis guide docs/concepts
Domain presets docs/domains
Tutorials tabular · finance · conformal · active learning
When is agg-g reliable? reliability
PyTorch / TorchUncertainty pytorch-integration
Contributing CONTRIBUTING.md

Status

v0.4.0 — complete library: core DEUP, conformal calibration, reliability diagnostics, domain presets (tabular GBM backends, finance, vision), benchmarks, tutorials, TorchUncertainty integration.

Citing

Cite this software (CITATION.cff), Lahlou et al. (2023) for the DEUP method, and Sanderink (2026) for cross-sectional ranking and aggregation- reliability extensions:

Sanderink, U. (2026) 'When Alpha Breaks: Two-Level Uncertainty for Safe Deployment of Cross-Sectional Stock Rankers', arXiv preprint arXiv:2603.13252. Available at: https://arxiv.org/pdf/2603.13252

License

Apache-2.0. See LICENSE.

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

deup-0.4.3.tar.gz (2.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deup-0.4.3-py3-none-any.whl (62.2 kB view details)

Uploaded Python 3

File details

Details for the file deup-0.4.3.tar.gz.

File metadata

  • Download URL: deup-0.4.3.tar.gz
  • Upload date:
  • Size: 2.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for deup-0.4.3.tar.gz
Algorithm Hash digest
SHA256 6d6d58adff0b8e62ef2a674dba66448e69b80723ed4457e9a994112c7794f20d
MD5 a81bc1ad1d47caa0155be3d6b7e0e179
BLAKE2b-256 1c8fedde91146f80002e2ba10dba6c7f7949ec4b9eb4201431060be5ddee4da0

See more details on using hashes here.

Provenance

The following attestation bundles were made for deup-0.4.3.tar.gz:

Publisher: release.yml on ursinasanderink/deup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file deup-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: deup-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 62.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for deup-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2abb591f699cbfde523eaa94916f0360f525d6c8708c1cdef69463e53ba72155
MD5 f540afafa28eec20ec44bb3d7ddfebdc
BLAKE2b-256 e31cb90aa0d4ff4cc85df3f969d4a183a796d330956c15f93b5aa677c9d423ef

See more details on using hashes here.

Provenance

The following attestation bundles were made for deup-0.4.3-py3-none-any.whl:

Publisher: release.yml on ursinasanderink/deup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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