RandomForestMultiOutput

Struct RandomForestMultiOutput 

Source
pub struct RandomForestMultiOutput<S = Untrained> { /* private fields */ }
Expand description

Random Forest Multi-Output Extension

A random forest that can handle multiple output variables simultaneously. This implementation creates multiple multi-target regression trees and averages their predictions for robust multi-output regression.

§Mathematical Foundation

The random forest combines multiple multi-target regression trees:

  • Each tree is trained on a bootstrap sample of the data
  • Each tree considers only a random subset of features at each split
  • Final prediction is the average of all tree predictions
  • Feature importance is averaged across all trees

§Examples

use sklears_multioutput::RandomForestMultiOutput;
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 forest = RandomForestMultiOutput::new()
    .n_estimators(10)
    .max_depth(Some(3));
let trained_forest = forest.fit(&X.view(), &y).unwrap();
let predictions = trained_forest.predict(&X.view()).unwrap();

Implementations§

Source§

impl RandomForestMultiOutput<Untrained>

Source

pub fn new() -> Self

Create a new RandomForestMultiOutput instance

Source

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

Set the number of trees in the forest

Source

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

Set the maximum depth of the trees

Source

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

Set the minimum number of samples required to split an internal node

Source

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

Set the minimum number of samples required to be at a leaf node

Source

pub fn max_features(self, max_features: Option<usize>) -> Self

Set the number of features to consider when looking for the best split

Source

pub fn bootstrap(self, bootstrap: bool) -> Self

Set whether to use bootstrap samples when building trees

Source

pub fn random_state(self, random_state: Option<u64>) -> Self

Set the random state for reproducible results

Source

pub fn get_n_estimators(&self) -> usize

Get the number of trees in the forest

Source

pub fn get_max_depth(&self) -> Option<usize>

Get the maximum depth of the trees

Source

pub fn get_min_samples_split(&self) -> usize

Get the minimum number of samples required to split an internal node

Source

pub fn get_min_samples_leaf(&self) -> usize

Get the minimum number of samples required to be at a leaf node

Source

pub fn get_max_features(&self) -> Option<usize>

Get the maximum number of features to consider when looking for the best split

Source

pub fn get_bootstrap(&self) -> bool

Get whether bootstrap samples are used when building trees

Source

pub fn get_random_state(&self) -> Option<u64>

Get the random state

Source§

impl RandomForestMultiOutput<RandomForestMultiOutputTrained>

Source

pub fn feature_importances(&self) -> &Array1<Float>

Get the feature importances averaged across all trees

Source

pub fn n_estimators(&self) -> usize

Get the number of estimators (trees)

Source

pub fn n_features(&self) -> usize

Get the number of features

Source

pub fn n_targets(&self) -> usize

Get the number of targets

Source

pub fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<Float>>

Predict using the forest (average of all tree predictions)

Trait Implementations§

Source§

impl<S: Clone> Clone for RandomForestMultiOutput<S>

Source§

fn clone(&self) -> RandomForestMultiOutput<S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<S: Debug> Debug for RandomForestMultiOutput<S>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for RandomForestMultiOutput<Untrained>

Source§

fn default() -> Self

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

impl Estimator for RandomForestMultiOutput<Untrained>

Source§

type Config = ()

Configuration type for the estimator
Source§

type Error = SklearsError

Error type for the estimator
Source§

type Float = f64

The numeric type used by this estimator
Source§

fn config(&self) -> &Self::Config

Get estimator configuration
Source§

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>

Check if estimator is compatible with given data dimensions
Source§

fn metadata(&self) -> EstimatorMetadata

Get estimator metadata
Source§

impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for RandomForestMultiOutput<Untrained>

Source§

type Fitted = RandomForestMultiOutput<RandomForestMultiOutputTrained>

The fitted model type
Source§

fn fit( self, X: &ArrayView2<'_, Float>, y: &Array2<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,

Fit with custom validation and early stopping

Auto Trait Implementations§

§

impl<S> Freeze for RandomForestMultiOutput<S>
where S: Freeze,

§

impl<S> RefUnwindSafe for RandomForestMultiOutput<S>
where S: RefUnwindSafe,

§

impl<S> Send for RandomForestMultiOutput<S>
where S: Send,

§

impl<S> Sync for RandomForestMultiOutput<S>
where S: Sync,

§

impl<S> Unpin for RandomForestMultiOutput<S>
where S: Unpin,

§

impl<S> UnwindSafe for RandomForestMultiOutput<S>
where S: UnwindSafe,

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> StableApi for T
where T: Estimator,

Source§

const STABLE_SINCE: &'static str = "0.1.0"

API version this type was stabilized in
Source§

const HAS_EXPERIMENTAL_FEATURES: bool = false

Whether this API has any experimental features
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V