Skip to main content

EnsembleLearner

Struct EnsembleLearner 

Source
pub struct EnsembleLearner<M> {
    pub models: Vec<M>,
    pub model_features: Vec<Vec<usize>>,
}
Expand description

A fitted ensemble of learners for classification.

§Structure

An Ensemble Learner is composed of a collection of fitted models of type M.

§Fitting Algorithm

Given a DatasetBase denoted as D,

  1. Create as many distinct bootstrapped subset of the original dataset D as number of distinct model to fit.
  2. Fit each distinct model on a distinct bootstrapped subset of D.

Note that the subset size, as well as the subset of feature to use in each training subset can be specified in the parameters.

§Prediction Algorithm

The prediction result is the result of majority voting across the fitted learners.

§Example

This example shows how to train a bagging model using 100 decision trees, each trained on 70% of the training data (bootstrap sampling).

use linfa::prelude::{Fit, Predict};
use linfa_ensemble::EnsembleLearnerParams;
use linfa_trees::DecisionTree;
use ndarray_rand::rand::SeedableRng;
use rand::rngs::SmallRng;

// Load Iris dataset
let mut rng = SmallRng::seed_from_u64(42);
let (train, test) = linfa_datasets::iris()
    .shuffle(&mut rng)
    .split_with_ratio(0.8);

// Train the model on the iris dataset
let bagging_model = EnsembleLearnerParams::new(DecisionTree::params())
    .ensemble_size(100)        // Number of Decision Tree to fit
    .bootstrap_proportion(0.7) // Select only 70% of the data via bootstrap
    .fit(&train)
    .unwrap();

// Make predictions on the test set
let predictions = bagging_model.predict(&test);

§References

Fields§

§models: Vec<M>§model_features: Vec<Vec<usize>>

Implementations§

Source§

impl<M> EnsembleLearner<M>

Source

pub fn generate_predictions<'b, R: Records, T>( &'b self, x: &'b [R], ) -> impl Iterator<Item = T> + 'b
where M: Predict<&'b R, T>,

Trait Implementations§

Source§

impl<F: Clone, T, M> PredictInplace<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, T> for EnsembleLearner<M>
where M: PredictInplace<Array2<F>, T>, <T as AsTargets>::Elem: Copy + Eq + Hash + Debug, T: AsTargets + AsTargetsMut<Elem = <T as AsTargets>::Elem>,

Source§

fn predict_inplace(&self, x: &Array2<F>, y: &mut T)

Predict something in place
Source§

fn default_target(&self, x: &Array2<F>) -> T

Create targets that predict_inplace works with.

Auto Trait Implementations§

§

impl<M> Freeze for EnsembleLearner<M>

§

impl<M> RefUnwindSafe for EnsembleLearner<M>
where M: RefUnwindSafe,

§

impl<M> Send for EnsembleLearner<M>
where M: Send,

§

impl<M> Sync for EnsembleLearner<M>
where M: Sync,

§

impl<M> Unpin for EnsembleLearner<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for EnsembleLearner<M>

§

impl<M> UnwindSafe for EnsembleLearner<M>
where M: 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> 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<'a, F, D, DM, T, O> Predict<&'a ArrayBase<D, DM>, T> for O
where D: Data<Elem = F>, DM: Dimension, O: PredictInplace<ArrayBase<D, DM>, T>,

Source§

fn predict(&self, records: &'a ArrayBase<D, DM>) -> T

Source§

impl<'a, F, R, T, S, O> Predict<&'a DatasetBase<R, T>, S> for O
where R: Records<Elem = F>, O: PredictInplace<R, S>,

Source§

fn predict(&self, ds: &'a DatasetBase<R, T>) -> S

Source§

impl<F, D, E, T, O> Predict<ArrayBase<D, Dim<[usize; 2]>>, DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>> for O
where D: Data<Elem = F>, T: AsTargets<Elem = E>, O: PredictInplace<ArrayBase<D, Dim<[usize; 2]>>, T>,

Source§

fn predict( &self, records: ArrayBase<D, Dim<[usize; 2]>>, ) -> DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>

Source§

impl<F, R, T, E, S, O> Predict<DatasetBase<R, T>, DatasetBase<R, S>> for O
where R: Records<Elem = F>, S: AsTargets<Elem = E>, O: PredictInplace<R, S>,

Source§

fn predict(&self, ds: DatasetBase<R, T>) -> DatasetBase<R, S>

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