pub struct GradientBoostingMultiOutput<S = Untrained> { /* private fields */ }Expand description
Gradient Boosting Multi-Output
A gradient boosting implementation that can handle multiple output variables simultaneously. This implementation builds an additive model of weak learners (multi-target regression trees) in a forward stage-wise fashion, optimizing a loss function for all targets jointly.
§Mathematical Foundation
For multi-target regression, gradient boosting minimizes:
- L(y, F(x)) = Σ_i Σ_j (y_ij - F_j(x_i))^2 for all samples i and targets j
- F_j(x) = F_0j + Σ_m ρ_m * h_mj(x) where h_mj are weak learners for target j at stage m
- At each stage, fit weak learners to negative gradients: -∂L/∂F_j
§Examples
use sklears_multioutput::GradientBoostingMultiOutput;
use sklears_core::traits::{Predict, Fit};
// Use SciRS2-Core for arrays and random number generation (SciRS2 Policy)
use scirs2_core::ndarray::array;
let X = array![[1.0, 2.0], [2.0, 3.0], [3.0, 1.0], [4.0, 4.0]];
let y = array![[1.5, 2.5], [2.5, 3.5], [3.5, 1.5], [4.5, 4.5]];
let gbm = GradientBoostingMultiOutput::new()
.n_estimators(50)
.learning_rate(0.1)
.max_depth(3);
let fitted = gbm.fit(&X.view(), &y.view()).unwrap();
let predictions = fitted.predict(&X.view()).unwrap();Implementations§
Source§impl GradientBoostingMultiOutput<Untrained>
impl GradientBoostingMultiOutput<Untrained>
Sourcepub fn n_estimators(self, n_estimators: usize) -> Self
pub fn n_estimators(self, n_estimators: usize) -> Self
Set the number of estimators
Sourcepub fn learning_rate(self, learning_rate: Float) -> Self
pub fn learning_rate(self, learning_rate: Float) -> Self
Set the learning rate
Sourcepub fn min_samples_split(self, min_samples_split: usize) -> Self
pub fn min_samples_split(self, min_samples_split: usize) -> Self
Set the minimum samples to split
Sourcepub fn random_state(self, random_state: Option<u64>) -> Self
pub fn random_state(self, random_state: Option<u64>) -> Self
Set the random state
Source§impl GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
impl GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
Sourcepub fn feature_importances(&self) -> Array1<Float>
pub fn feature_importances(&self) -> Array1<Float>
Get the feature importance scores
Sourcepub fn training_loss_history(&self) -> Vec<Float> ⓘ
pub fn training_loss_history(&self) -> Vec<Float> ⓘ
Get the training loss history
Trait Implementations§
Source§impl<S: Clone> Clone for GradientBoostingMultiOutput<S>
impl<S: Clone> Clone for GradientBoostingMultiOutput<S>
Source§fn clone(&self) -> GradientBoostingMultiOutput<S>
fn clone(&self) -> GradientBoostingMultiOutput<S>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<S: Debug> Debug for GradientBoostingMultiOutput<S>
impl<S: Debug> Debug for GradientBoostingMultiOutput<S>
Source§impl Estimator for GradientBoostingMultiOutput<Untrained>
impl Estimator for GradientBoostingMultiOutput<Untrained>
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>> for GradientBoostingMultiOutput<Untrained>
impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>> for GradientBoostingMultiOutput<Untrained>
Source§type Fitted = GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
type Fitted = GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
The fitted model type
Source§fn fit(
self,
x: &ArrayView2<'_, Float>,
y: &ArrayView2<'_, Float>,
) -> SklResult<Self::Fitted>
fn fit( self, x: &ArrayView2<'_, Float>, y: &ArrayView2<'_, Float>, ) -> SklResult<Self::Fitted>
Fit the model to the provided data with validation
Source§fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
Fit with custom validation and early stopping
Source§impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for GradientBoostingMultiOutput<GradientBoostingMultiOutputTrained>
Source§fn predict(&self, x: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>
fn predict(&self, x: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>
Make predictions on the provided data
Source§fn predict_with_uncertainty(
&self,
x: &X,
) -> Result<(Output, UncertaintyMeasure), SklearsError>
fn predict_with_uncertainty( &self, x: &X, ) -> Result<(Output, UncertaintyMeasure), SklearsError>
Make predictions with confidence intervals
Auto Trait Implementations§
impl<S> Freeze for GradientBoostingMultiOutput<S>where
S: Freeze,
impl<S> RefUnwindSafe for GradientBoostingMultiOutput<S>where
S: RefUnwindSafe,
impl<S> Send for GradientBoostingMultiOutput<S>where
S: Send,
impl<S> Sync for GradientBoostingMultiOutput<S>where
S: Sync,
impl<S> Unpin for GradientBoostingMultiOutput<S>where
S: Unpin,
impl<S> UnwindSafe for GradientBoostingMultiOutput<S>where
S: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features