Ordinal Gradient Boosting (OGBoost)
Overview
OGBoost is a scikit-learn-compatible, Python package for gradient boosting tailored to ordinal regression problems. It does so by alternating between:
- Fitting a Machine Learning (ML) regression model - such as a decision tree - to predict a latent score that specifies the mean of a probability density function (PDF), and
- Fitting a set of thresholds that generate discrete outcomes from the PDF.
In other words, OGBoost implements coordinate-descent optimization that combines functional gradient descent - for updating the regression function - with ordinary gradient descent - for updating the threshold vector.
The main class of the package, GradientBoostingOrdinal, is designed to have the same look and feel as scikit-learn's GradientBoostingClassifier. It includes many of the same features such as custom link functions, sample weighting, early stopping using a validation set, and staged predictions.
There are, however, important differences as well.
Unique Features of OGBoost
Latent-Score Prediction
The decision_function method of the GradientBoostingOrdinal behaves differently from scikit-learn's classifiers. Assuming the target variable has K distinct classes, a nominal classifier's decision function would return K values for each sample. On the other hand, decision_function in ogboost would return the latent score for each sample, which is a single value. This latent score can be considered a high-resolution alternative to class labels, and thus may have superior ranking performance.
Early Stopping using Cross-Validation (CV)
In addition to using a single validation set for early stopping, similar to GradientBoostingClassifier, ogboost implements early stopping using CV, which means the entire data is used for calculating out-of-sample performance. This can improve the robustness of early-stopping, especially for small and/or imbalanced datasets.
Heterogeneous Ensemble
While most gradient-boosting software packages exclusively use decision trees with a predetermined set of hyperparameters as the base learner in all boosting iterations, ogboost offers significantly more flexibility.
- Users can pass in a
base_learnerparameter to the class initializer to override the default choice of aDecisionTreeRegressor. This can be any scikit-learn regression algorithm such as a feed-forward neural network (MLPRegressor), or a K-nearest-neighbor regressor (KNeighborsRegressor), etc. - Rather than a single base learner, users can specify a list (or a generator) of base learners, which will be drawn from in that order in each boosting iteration. This amounts to creating a heterogeneous ensemble as opposed to a homogeneous ensemble.
Installation
pip install ogboost
To access StatsModelsOrderedModel, which is a wrapper for the OrderedModel class from the statsmodels package to make it compatible with scikit-learn, please run:
pip install ogboost[param]
Package Vignette
For a more detailed introduction to OGBoost, including the underlying math, see the package's peer-reviewed article in the Journal of Statistical Software (an earlier preprint is available on arXiv).
Quick Start
Load the Wine Quality Dataset
The package includes a utility to load the wine quality dataset (red and white) from the UCI repository. Note that load_wine_quality shifts the target variable (quality) to start from 0. (This is required by the GradientBoostingOrdinal class.)
from ogboost import load_wine_quality
X, y, _, _ = load_wine_quality(return_X_y=True)
Training, Prediction and Evaluation
Latent scores perform better on discrminative tasks vs. class labels as they contain more information due to higher resolution:
from ogboost import GradientBoostingOrdinal
## training ##
model = GradientBoostingOrdinal(n_estimators=100, link_function='logit', verbose=1)
model.fit(X, y)
## prediction ##
# class labels
predicted_labels = model.predict(X)
# class probabilities
predicted_probabilities = model.predict_proba(X)
# latent score
predicted_latent = model.decision_function(X)
# evaluation
concordance_latent = model.score(X, y) # concordance using latent scores
concordance_label = model.score(X, y, pred_type = 'labels') # concordance using class labels
print(f"Concordance - class labels: {concordance_label:.3f}")
print(f"Concordance - latent scores: {concordance_latent:.3f}")
Early-Stopping using Cross-Validation
Using cross-validation for early stopping can produce more robust results compared to a single holdout set, especially for small and/or imbalanced datasets:
from sklearn.model_selection import cross_val_score
from sklearn.model_selection import RepeatedKFold
import time
n_splits = 10
n_repeats = 10
kf = RepeatedKFold(n_splits=n_splits, n_repeats=n_repeats)
# early-stopping using a simple holdout set
model_earlystop_simple = GradientBoostingOrdinal(n_iter_no_change=10, validation_fraction=0.2)
start = time.time()
c_index_simple = cross_val_score(model_earlystop_simple, X, y, cv=kf, n_jobs=-1)
end = time.time()
print(f'Simple early stopping: {c_index_simple.mean():.3f} ({end - start:.1f} seconds)')
# early-stopping using cross-validation
model_earlystop_cv = GradientBoostingOrdinal(n_iter_no_change=10, cv_early_stopping_splits=5)
start = time.time()
c_index_cv = cross_val_score(model_earlystop_cv, X, y, cv=kf, n_jobs=-1)
end = time.time()
print(f'CV early stopping: {c_index_cv.mean():.3f} ({end - start:.1f} seconds)')
Heterogeneous Ensemble
Rather than a single base learner, users can supply a heterogeneous list of base learners to GradientBoostingOrdinal. The utility function generate_heterogeneous_learners can be used to easily generate random samples from hyperparameter spaces of one or more base learners:
import numpy as np
from sklearn.tree import DecisionTreeRegressor
from ogboost import generate_heterogeneous_learners
# Number of samples to generate
n_samples = 100
max_depth_choices = [3, 6, 9, None]
max_leaf_nodes_choices = [10, 20, 30, None]
dt_overrides = {
"max_depth": lambda rng: rng.choice(max_depth_choices),
"max_leaf_nodes": lambda rng: rng.choice(max_leaf_nodes_choices)
}
# Create list of DecisionTreeRegressor models
random_learners = generate_heterogeneous_learners(
[DecisionTreeRegressor()],
[dt_overrides],
total_samples=n_samples
)
Such heterogenous boosting ensembles can be a more efficient alternative to hyperparameter tuning (e.g., via grid search):
model_heter = GradientBoostingOrdinal(
base_learner=random_learners,
n_estimators=n_samples
)
cv_heter = cross_val_score(model_heter, X, y, cv=kf, n_jobs=-1)
print(f'average cv score of heterogeneous ensemble: {np.mean(cv_heter):.3f}')
Parametric Ordinal Regression
The StatsModelsOrderedModel is a scikit-learn wrapper for the OrderedModel class of the statsmodels package:
from ogboost import StatsModelsOrderedModel
cv_param = cross_val_score(StatsModelsOrderedModel(), X, y, cv=kf, n_jobs=-1)
print(f'average cv score of parametric model: {np.mean(cv_param):.3f}')
This model can be useful for benchmarking against ML models, or as part of an ensemble alongside them.
Documentation
Full API reference and additional guides are available at asmahani.github.io/ogboost.
Citing OGBoost
If you use OGBoost in your work, please cite:
Sharabiani, M. T. A., Bottle, A., & Mahani, A. S. (2026). OGBoost: A Python Package for Ordinal Regression Gradient Boosting. Journal of Statistical Software, 117(5), 1-38. https://doi.org/10.18637/jss.v117.i05
@article{ogboost2026,
title = {{OGBoost}: A {Python} Package for Ordinal Regression Gradient Boosting},
author = {Sharabiani, Mansour T. A. and Bottle, Alex and Mahani, Alireza S.},
journal = {Journal of Statistical Software},
year = {2026},
volume = {117},
number = {5},
pages = {1--38},
doi = {10.18637/jss.v117.i05}
}
License
This package is licensed under the MIT License.
Release Notes
See CHANGELOG.md for the full release history.
Release files for ogboost 0.8.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ogboost-0.8.4.tar.gz | 33.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ogboost-0.8.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.1 kB
Release files / ogboost-0.8.4.tar.gz
| Download URL | ogboost-0.8.4.tar.gz |
|---|---|
| Size | 33.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2d4729e6cf52caf3f03444eb5e5633a0f1bc5c2c7228db042cd3cce16b0d45ea
|
|
BLAKE2b-256 checksum How to use checksums |
f3ddc778ad7a42f0ce9919564ed5776a7202324230e0f91f9855c81bd3227628
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / ogboost-0.8.4-py3-none-any.whl
| Download URL | ogboost-0.8.4-py3-none-any.whl |
|---|---|
| Size | 33.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6c780a4eee62fac35b45f02bf86023dcfff49e3abf64ef49473d57b052196ba7
|
|
BLAKE2b-256 checksum How to use checksums |
77d6b406d427169f84540497f3b5fed4979f2b7f79b29f98083a6bca8b118527
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency log