Skip to main content

Library for probabilistic predictions via gradient boosting.

Project description

NGBoost: Natural Gradient Boosting for Probabilistic Prediction

Python package GitHub Repo Size Github License Code style: black PyPI PyPI Downloads

ngboost is a Python library that implements Natural Gradient Boosting, as described in "NGBoost: Natural Gradient Boosting for Probabilistic Prediction". It is built on top of Scikit-Learn, and is designed to be scalable and modular with respect to choice of proper scoring rule, distribution, and base learner. A didactic introduction to the methodology underlying NGBoost is available in this slide deck.

Installation

via pip

pip install --upgrade ngboost

via conda-forge

conda install -c conda-forge ngboost

Usage

Probabilistic regression example on the Boston housing dataset:

from ngboost import NGBRegressor

from sklearn.datasets import fetch_california_housing
from sklearn.model_selection import train_test_split
from sklearn.metrics import mean_squared_error

# Load California housing dataset
cal = fetch_california_housing()
X, Y = cal.data, cal.target

X_train, X_test, Y_train, Y_test = train_test_split(X, Y, test_size=0.2)

ngb = NGBRegressor().fit(X_train, Y_train)
Y_preds = ngb.predict(X_test)
Y_dists = ngb.pred_dist(X_test)

# test Mean Squared Error
test_MSE = mean_squared_error(Y_preds, Y_test)
print('Test MSE', test_MSE)

# test Negative Log Likelihood
test_NLL = -Y_dists.logpdf(Y_test).mean()
print('Test NLL', test_NLL)

Details on available distributions, scoring rules, learners, tuning, and model interpretation are available in our user guide, which also includes numerous usage examples and information on how to add new distributions or scores to NGBoost.

License

Apache License 2.0.

Reference

Tony Duan, Anand Avati, Daisy Yi Ding, Khanh K. Thai, Sanjay Basu, Andrew Y. Ng, Alejandro Schuler. 2019. NGBoost: Natural Gradient Boosting for Probabilistic Prediction. arXiv

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

ngboost-0.5.10.dev0.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

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

ngboost-0.5.10.dev0-py3-none-any.whl (52.1 kB view details)

Uploaded Python 3

File details

Details for the file ngboost-0.5.10.dev0.tar.gz.

File metadata

  • Download URL: ngboost-0.5.10.dev0.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.2 Darwin/25.4.0

File hashes

Hashes for ngboost-0.5.10.dev0.tar.gz
Algorithm Hash digest
SHA256 cbc1a51f19cdae92470af0b47cb8118710d96818173a3ab67997af820e63863c
MD5 ce5fbc69ca406e60a42d2265ed47a3a7
BLAKE2b-256 18e3ffff4a518c7d27926a791310f73763d83740d012fc7049d5e06f45071209

See more details on using hashes here.

File details

Details for the file ngboost-0.5.10.dev0-py3-none-any.whl.

File metadata

  • Download URL: ngboost-0.5.10.dev0-py3-none-any.whl
  • Upload date:
  • Size: 52.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.2 Darwin/25.4.0

File hashes

Hashes for ngboost-0.5.10.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc4ea512c70cdd33d911eb107de1ca2726a912b3381019d29b4006d6395308ea
MD5 c9d5e219a2ee6788a688d3f56063680c
BLAKE2b-256 e23fbda19175daded837d2ac85eb651183d849ab68b6046fc421ff558a19cf02

See more details on using hashes here.

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