Skip to main content

GradientBoostingRegressor

Struct GradientBoostingRegressor 

Source
#[non_exhaustive]
pub struct GradientBoostingRegressor { /* private fields */ }
Expand description

Gradient Boosting for regression.

Builds an additive ensemble of shallow decision trees, each fitting the negative gradient (pseudo-residuals) of the loss function. Supports stochastic subsampling and multiple loss functions.

§Example

use scry_learn::dataset::Dataset;
use scry_learn::tree::GradientBoostingRegressor;

let features = vec![vec![1.0, 2.0, 3.0, 4.0, 5.0]];
let target = vec![2.0, 4.0, 6.0, 8.0, 10.0];
let data = Dataset::new(features, target, vec!["x".into()], "y");

let mut gbr = GradientBoostingRegressor::new()
    .n_estimators(50)
    .learning_rate(0.1)
    .max_depth(3);
gbr.fit(&data).unwrap();

let preds = gbr.predict(&[vec![3.0]]).unwrap();
assert!((preds[0] - 6.0).abs() < 1.0);

Implementations§

Source§

impl GradientBoostingRegressor

Source

pub fn new() -> Self

Create a new regressor with default parameters.

Source

pub fn n_estimators(self, n: usize) -> Self

Set number of boosting rounds.

Source

pub fn learning_rate(self, lr: f64) -> Self

Set learning rate (shrinkage). Lower values need more estimators.

Source

pub fn max_depth(self, d: usize) -> Self

Set maximum depth per tree (default: 3, shallow stumps).

Source

pub fn min_samples_split(self, n: usize) -> Self

Set minimum samples required to split an internal node.

Source

pub fn min_samples_leaf(self, n: usize) -> Self

Set minimum samples required in a leaf node.

Source

pub fn subsample(self, s: f64) -> Self

Set subsample fraction (0.0, 1.0] for stochastic GBT.

Source

pub fn seed(self, s: u64) -> Self

Set random seed.

Source

pub fn n_iter_no_change(self, n: usize) -> Self

Enable early stopping. Training stops when validation loss does not improve for n consecutive rounds.

Source

pub fn validation_fraction(self, frac: f64) -> Self

Set fraction of training data to use as validation for early stopping (default: 0.1).

Source

pub fn tol(self, t: f64) -> Self

Set tolerance for early stopping (default: 1e-4).

Source

pub fn callback(self, cb: Box<dyn TrainingCallback>) -> Self

Add a training callback (invoked after each boosting round).

Source

pub fn n_estimators_used(&self) -> usize

Number of estimators actually used (may be less than n_estimators if early stopping triggered).

Source

pub fn loss(self, l: RegressionLoss) -> Self

Set the regression loss function.

§Example
use scry_learn::tree::{GradientBoostingRegressor, RegressionLoss};

let gbr = GradientBoostingRegressor::new()
    .loss(RegressionLoss::Huber { alpha: 0.9 });
Source

pub fn fit(&mut self, data: &Dataset) -> Result<()>

Train the gradient boosting ensemble.

Source

pub fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict values for new samples.

features is row-major: features[sample_idx][feature_idx].

Source

pub fn feature_importances(&self) -> Result<Vec<f64>>

Feature importances averaged across all trees.

Source

pub fn n_trees(&self) -> usize

Number of estimators (trees) in the ensemble.

Source

pub fn early_stopped(&self) -> bool

Whether early stopping was triggered.

Source

pub fn history(&self) -> Option<&TrainingHistory>

Return training history (populated after fit()).

Source

pub fn trees(&self) -> &[DecisionTreeRegressor]

Get individual trees (for inspection or ONNX export).

Source

pub fn n_features(&self) -> usize

Number of features the model was trained on.

Source

pub fn learning_rate_val(&self) -> f64

Learning rate value.

Source

pub fn init_prediction_val(&self) -> f64

Initial (base) prediction value.

Trait Implementations§

Source§

impl Clone for GradientBoostingRegressor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for GradientBoostingRegressor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PipelineModel for GradientBoostingRegressor

Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Train the model on a dataset.
Source§

fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict on row-major feature matrix.
Source§

impl Tunable for GradientBoostingRegressor

Source§

fn set_param(&mut self, name: &str, _value: ParamValue) -> Result<()>

Apply a named hyperparameter. Read more
Source§

fn clone_box(&self) -> Box<dyn Tunable>

Clone this model into a boxed trait object.
Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Train on a dataset.
Source§

fn predict(&self, features: &[Vec<f64>]) -> Result<Vec<f64>>

Predict on row-major features.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.