Skip to main content

GG-SRP hereditary oblique GBDT — native NaN/categorical, high-performance C++ backend

Project description

OQBoost

High-performance gradient-boosted oblique decision trees with hereditary projection evolution.

OQBoost replaces standard axis-aligned splits with gradient-guided oblique hyperplanes that are inherited and mutated from parent nodes. It builds oblique splits without expensive numerical optimization, yielding superior boundaries on complex tabular datasets.


Installation

pip install oqboost

Pre-compiled wheels are available for macOS (arm64, x86_64) and Linux (x86_64). On other platforms, a C++17 compiler (such as clang++ or g++) is required to compile from source.


Quickstart

1. Classification (OQBoostClassifier)

OQBoostClassifier provides binary and multiclass classification. For multiclass classification, the default strategy is "shared" (Multi-value Shared Leaves) which trains extremely fast by building a single tree ensemble with vector-valued leaf outputs.

from oqboost import OQBoostClassifier
from sklearn.datasets import make_classification

X, y = make_classification(n_samples=1000, n_features=10, random_state=42)

clf = OQBoostClassifier(
    n_estimators=500,
    learning_rate=0.03,
    max_depth=6,
    multi_strategy="shared",  # "shared" (fastest, default) or "ovr" (One-vs-Rest)
    random_state=42
)
clf.fit(X, y)
preds = clf.predict(X)
probas = clf.predict_proba(X)

2. Regression (OQBoostRegressor)

OQBoostRegressor supports continuous target prediction with standard GBDT loss functions.

from oqboost import OQBoostRegressor
from sklearn.datasets import make_regression

X, y = make_regression(n_samples=1000, n_features=10, noise=0.1, random_state=42)

reg = OQBoostRegressor(
    loss="squared_error",  # "squared_error" (MSE), "absolute_error" (MAE), or "huber"
    n_estimators=500,
    learning_rate=0.03,
    max_depth=5,
    random_state=42
)
reg.fit(X, y)
predictions = reg.predict(X)

Detailed Hyperparameter Reference

Core Parameters

  • n_estimators (int, default=1000):
    • Values: Positive integer.
    • Role: The number of boosting rounds (trees to build). Increasing this generally increases model capacity, but requires early stopping to prevent overfitting.
  • learning_rate (float, default=0.03):
    • Values: Positive float (typically in [0.01, 0.2]).
    • Role: Step size shrinkage applied to each tree's updates to prevent overfitting. Smaller values require more n_estimators.
  • max_depth (int, default=6):
    • Values: Positive integer (typically in [3, 10]).
    • Role: Maximum depth of each decision tree. Allocates up to $2^{\text{max_depth}}$ leaves per tree using a best-first (leaf-wise) strategy.
  • max_leaves (int or None, default=None):
    • Values: Positive integer or None.
    • Role: Explicit leaf budget per tree. If None, defaults to $2^{\text{max_depth}}$.

Regularization

  • reg_alpha (float, default=0.0):
    • Values: Non-negative float.
    • Role: L1 regularization coefficient. Applies soft-thresholding to leaf weights, shrinking small coefficients to exactly zero (encouraging tree sparsity).
  • reg_lambda (float, default=1.0):
    • Values: Non-negative float.
    • Role: L2 regularization coefficient on leaf weights and split gains. Stabilizes tree weights under small samples.
  • gamma (float, default=0.0):
    • Values: Non-negative float.
    • Role: Minimum split gain threshold. A node will not be split if the best split gain is less than gamma.
  • min_child_weight (float, default=1.0):
    • Values: Positive float.
    • Role: Minimum sum of instance Hessian (data density) required in a child node. If a split creates a node with less than min_child_weight, the split is discarded.

Subsampling & Speedups

  • goss (bool, default=True):
    • Values: True or False.
    • Role: Activates Gradient-based One-Side Sampling (GOSS). When active, keeps samples with large gradients and randomly samples a fraction of samples with small gradients, speeding up training on large datasets by 2x+ with negligible performance loss.
  • goss_top_rate (float, default=0.2):
    • Values: Float in (0.0, 1.0].
    • Role: Fraction of high-gradient (large error) samples retained by GOSS.
  • goss_other_rate (float, default=0.1):
    • Values: Float in (0.0, 1.0].
    • Role: Fraction of low-gradient (small error) samples randomly sampled by GOSS.
  • subsample (float, default=0.8):
    • Values: Float in (0.0, 1.0].
    • Role: Row subsampling ratio used to build trees (ignored if goss=True).
  • colsample_bynode (float, default=1.0):
    • Values: Float in (0.0, 1.0].
    • Role: Feature subsampling ratio. Evaluates only a subset of features at each node split candidate.
  • max_bin (int, default=255):
    • Values: Integer in [2, 255].
    • Role: Maximum number of buckets for continuous values. Lower values (like 63 or 31) speed up training dramatically by increasing CPU cache efficiency.

Loss & Strategy Configurations

  • loss (str, default="squared_error", Regressor Only):
    • Values: "squared_error" (MSE), "absolute_error" (MAE), "huber".
    • Role: The regression objective function to minimize.
  • huber_delta (float, default=1.0, Regressor Only):
    • Values: Positive float.
    • Role: Delta threshold at which Huber loss switches from quadratic (MSE) to linear (MAE).
  • multi_strategy (str, default="shared", Classifier Only):
    • Values: "shared" or "ovr".
    • Role: Multiclass strategy. "shared" builds a single tree ensemble with multi-value vector leaf outputs (fastest). "ovr" trains separate binary trees per class (One-vs-Rest, standard GBDT parity).

Features Usage

Native NaN & Categorical Support

import numpy as np
import pandas as pd

# NaNs are handled natively during split sweeps
X_train[50, 3] = np.nan

# Categoricals are rank-encoded based on gradient ranks per round
clf = OQBoostClassifier(cat_features=["city", "product"])
clf.fit(X_train, y_train)

Early Stopping & Serialization

from oqboost import load_model

# Early stopping
clf = OQBoostClassifier(n_estimators=2000, early_stopping_rounds=50)
clf.fit(X_train, y_train, eval_set=[(X_val, y_val)])

# Save model
clf.save("model.joblib")

# Load model (automatically loads Classifier or Regressor)
model = load_model("model.joblib")

License

OQBoost is licensed under the MIT License. See LICENSE for details.

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

oqboost-0.1.8.tar.gz (130.3 kB view details)

Uploaded Source

File details

Details for the file oqboost-0.1.8.tar.gz.

File metadata

  • Download URL: oqboost-0.1.8.tar.gz
  • Upload date:
  • Size: 130.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for oqboost-0.1.8.tar.gz
Algorithm Hash digest
SHA256 9547ca43c08087698426d93225e40d4ea7bac46d3c8d1a70a6aeef64b4d13239
MD5 f41ff57e822995bb837529260ece1322
BLAKE2b-256 09eab82772b9cbbf86476e7a8678bd5695de15491629b642e8eeef59c2e14199

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