Skip to main content

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

Project description

deup

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) and Lahlou et al. (2023).

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.0.tar.gz (206.7 kB 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.0-py3-none-any.whl (60.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for deup-0.4.0.tar.gz
Algorithm Hash digest
SHA256 52476fa3384884527f72d9265173fc6a3fe937a0b3e7747f1f89ce8d2a7d8979
MD5 fd0e57067ab097d52fee4bf220d5c7df
BLAKE2b-256 9e10b98db7e23885f411a7e9bdabf50d4e03a052aef488608fabee829d94d9d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for deup-0.4.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: deup-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 60.1 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad8a77618b9735fc384433681795847e1defcda5c33de71d01570fb69b9f8d30
MD5 29bfbc4af4a92cd15ce0d42802f111bb
BLAKE2b-256 440bb32a5bc5c8e2d223604a95480318dd29d7460fe37b5f9820b522f49ba895

See more details on using hashes here.

Provenance

The following attestation bundles were made for deup-0.4.0-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