Skip to main content

XGBoostLSS - An extension of XGBoost to probabilistic modelling

Project description

Documentation · Release Notes
Open Source Apache 2.0
CI/CD github-actions Documentation status badge
Code !pypi !python-versions Code coverage status badge
Downloads Pepy Total Downlods
Citation Arxiv link

XGBoostLSS - An extension of XGBoost to probabilistic modelling

We introduce a comprehensive framework that models and predicts the full conditional distribution of univariate and multivariate targets as a function of covariates. Choosing from a wide range of continuous, discrete, and mixed discrete-continuous distributions, modelling and predicting the entire conditional distribution greatly enhances the flexibility of XGBoost, as it allows to create probabilistic forecasts from which prediction intervals and quantiles of interest can be derived.

Features

:white_check_mark: Estimation of all distributional parameters.
:white_check_mark: Normalizing Flows allow modelling of complex and multi-modal distributions.
:white_check_mark: Mixture-Densities can model a diverse range of data characteristics.
:white_check_mark: Multi-target regression allows modelling of multivariate responses and their dependencies.
:white_check_mark: Zero-Adjusted and Zero-Inflated Distributions for modelling excess of zeros in the data.
:white_check_mark: Automatic derivation of Gradients and Hessian of all distributional parameters using PyTorch.
:white_check_mark: Automated hyper-parameter search, including pruning, is done via Optuna.
:white_check_mark: The output of XGBoostLSS is explained using SHapley Additive exPlanations.
:white_check_mark: XGBoostLSS provides full compatibility with all the features and functionality of XGBoost.
:white_check_mark: XGBoostLSS is available in Python.

News

:boom: [2025-12-11] Release of v0.6.1 to PyPI. See the release notes for an overview.
:boom: [2025-10-31] Release of v0.5.0 - python 3.13 support and dependency minimization. See the release notes for an overview.
:boom: [2024-01-19] Release of XGBoostLSS to PyPI.
:boom: [2023-08-25] Release of v0.4.0 introduces Mixture-Densities. See the release notes for an overview.
:boom: [2023-07-19] Release of v0.3.0 introduces Normalizing Flows. See the release notes for an overview.
:boom: [2023-06-22] Release of v0.2.2. See the release notes for an overview.
:boom: [2023-06-21] XGBoostLSS now supports multi-target regression.
:boom: [2023-06-07] XGBoostLSS now supports Zero-Inflated and Zero-Adjusted Distributions.
:boom: [2023-05-26] Release of v0.2.1. See the release notes for an overview.
:boom: [2023-05-18] Release of v0.2.0. See the release notes for an overview.
:boom: [2021-12-22] XGBoostLSS now supports estimating the full predictive distribution via Expectile Regression.
:boom: [2021-12-20] XGBoostLSS is initialized with suitable starting values to improve convergence of estimation.
:boom: [2021-12-04] XGBoostLSS now supports automatic derivation of Gradients and Hessians.
:boom: [2021-12-02] XGBoostLSS now supports pruning during hyperparameter optimization.
:boom: [2021-11-14] XGBoostLSS v0.1.0 is released!

Installation

To install the development version, please use

pip install git+https://github.com/StatMixedML/XGBoostLSS.git

For the PyPI version, please use

pip install xgboostlss

Available Distributions

Our framework is built upon PyTorch and Pyro, enabling users to harness a diverse set of distributional families. XGBoostLSS currently supports the following distributions.

How to Use

Please visit the example section for guidance on how to use the framework.

Documentation

For more information and context, please visit the documentation.

Feedback

We encourage you to provide feedback on how to enhance XGBoostLSS or request the implementation of additional distributions by opening a new discussion.

How to Cite

If you use XGBoostLSS in your research, please cite it as:

@misc{Maerz2023,
  author = {Alexander M\"arz},
  title = {{XGBoostLSS: An Extension of XGBoost to Probabilistic Modelling}},
  year = {2023},
  note = {GitHub repository, Version 0.6.1},
  howpublished = {\url{https://github.com/StatMixedML/XGBoostLSS}}
}

Reference Paper

Arxiv link
Arxiv link
Arxiv link

Star History

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

xgboostlss-0.6.1.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

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

xgboostlss-0.6.1-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file xgboostlss-0.6.1.tar.gz.

File metadata

  • Download URL: xgboostlss-0.6.1.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xgboostlss-0.6.1.tar.gz
Algorithm Hash digest
SHA256 d3f44878459169faf389b1948499f6d58ba462298a2c0d784f79022ac4901bbf
MD5 568cb9d06dba2ad0ea8e4c0c1242ada9
BLAKE2b-256 d2dab4ad83f475e18eaa68bd660ac933f4ec083bf21c7c25b453c54270ad1f62

See more details on using hashes here.

Provenance

The following attestation bundles were made for xgboostlss-0.6.1.tar.gz:

Publisher: release.yml on StatMixedML/XGBoostLSS

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

File details

Details for the file xgboostlss-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: xgboostlss-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xgboostlss-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae1de732bef58ece4d066fe8d75730328f92ff849417b8581facfefebbf1ee6b
MD5 35c380002e9c464ac526f15884efaa0e
BLAKE2b-256 be4f2cb2be8c9ce9776a69ba2e9b1486008ccbf93a9dbdcc886b1b2d1d67b86d

See more details on using hashes here.

Provenance

The following attestation bundles were made for xgboostlss-0.6.1-py3-none-any.whl:

Publisher: release.yml on StatMixedML/XGBoostLSS

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