Skip to main content

GradientBoostingClassifier

Struct GradientBoostingClassifier 

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

Gradient Boosting for classification (binary + multiclass).

  • Binary: fits a single sequence of trees to log-loss pseudo-residuals.
  • Multiclass (K > 2): fits K sequences of trees (one-vs-all softmax).

Uses Newton-Raphson leaf correction (second-order gradient step) for optimal leaf values, matching sklearn’s GradientBoostingClassifier.

§Example

use scry_learn::dataset::Dataset;
use scry_learn::tree::GradientBoostingClassifier;

// Simple linearly separable data.
let features = vec![
    vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0],
    vec![0.1, 0.2, 0.3, 0.4, 0.5, 0.6],
];
let target = vec![0.0, 0.0, 0.0, 1.0, 1.0, 1.0];
let data = Dataset::new(features, target, vec!["x1".into(), "x2".into()], "class");

let mut gbc = GradientBoostingClassifier::new()
    .n_estimators(50)
    .learning_rate(0.1)
    .max_depth(2);
gbc.fit(&data).unwrap();

let preds = gbc.predict(&[vec![1.5, 0.15], vec![5.5, 0.55]]).unwrap();
assert_eq!(preds[0], 0.0);
assert_eq!(preds[1], 1.0);

Implementations§

Source§

impl GradientBoostingClassifier

Source

pub fn new() -> Self

Create a new classifier 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).

Source

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

Set maximum depth per tree.

Source

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

Set minimum samples required to split.

Source

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

Set minimum samples required in a leaf.

Source

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

Set subsample fraction for stochastic GBT.

Source

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

Set random seed.

Source

pub fn class_weight(self, cw: ClassWeight) -> Self

Set class weighting strategy for imbalanced datasets.

Source

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

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

Source

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

Train the gradient boosting classifier.

Source

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

Predict class labels for new samples.

Source

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

Predict class probabilities for new samples.

Source

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

Feature importances averaged across all trees.

Source

pub fn n_classes(&self) -> usize

Number of classes.

Source

pub fn n_trees(&self) -> usize

Total number of trees across all class sequences.

Source

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

Return training history (populated after fit()).

Source

pub fn class_trees(&self) -> &[Vec<DecisionTreeRegressor>]

Get tree sequences per class (for inspection or ONNX export). class_trees()[class_idx][estimator_idx] is the tree for that class/round.

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_predictions_val(&self) -> &[f64]

Initial predictions per class.

Trait Implementations§

Source§

impl CalibrableClassifier for GradientBoostingClassifier

Source§

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

Train on a dataset.
Source§

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

Predict class labels.
Source§

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

Predict class probabilities. Returns [n_samples][n_classes].
Source§

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

Clone into a boxed trait object.
Source§

impl Clone for GradientBoostingClassifier

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 GradientBoostingClassifier

Source§

fn default() -> Self

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

impl PipelineModel for GradientBoostingClassifier

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 GradientBoostingClassifier

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.