Skip to main content

VotingRegressor

Struct VotingRegressor 

Source
pub struct VotingRegressor<F> {
    pub max_depths: Vec<Option<usize>>,
    pub min_samples_split: usize,
    pub min_samples_leaf: usize,
    /* private fields */
}
Expand description

Voting ensemble regressor.

Trains multiple decision tree regressors with different hyperparameter configurations on the full dataset. Final predictions are the average across all trees.

Diversity is introduced by varying max_depth across the ensemble members. If no explicit depths are provided, a default set of depths is used.

§Type Parameters

  • F: The floating-point type (f32 or f64).

§Examples

use ferrolearn_tree::VotingRegressor;
use ferrolearn_core::{Fit, Predict};
use ndarray::{array, Array1, Array2};

let x = Array2::from_shape_vec((6, 2), vec![
    1.0, 2.0,  2.0, 3.0,  3.0, 3.0,
    5.0, 6.0,  6.0, 7.0,  7.0, 8.0,
]).unwrap();
let y = array![1.0, 2.0, 3.0, 5.0, 6.0, 7.0];

let model = VotingRegressor::<f64>::new()
    .with_max_depths(vec![Some(2), Some(4), None]);
let fitted = model.fit(&x, &y).unwrap();
let preds = fitted.predict(&x).unwrap();
assert_eq!(preds.len(), 6);

Fields§

§max_depths: Vec<Option<usize>>

Maximum depth settings for each tree in the ensemble.

§min_samples_split: usize

Minimum number of samples required to split an internal node.

§min_samples_leaf: usize

Minimum number of samples required in a leaf node.

Implementations§

Source§

impl<F: Float> VotingRegressor<F>

Source

pub fn new() -> Self

Create a new VotingRegressor with default settings.

Defaults: max_depths = [Some(2), Some(4), Some(6), None], min_samples_split = 2, min_samples_leaf = 1.

Source

pub fn with_max_depths(self, max_depths: Vec<Option<usize>>) -> Self

Set the maximum depth settings for each ensemble member.

Source

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

Set the minimum number of samples required to split a node.

Source

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

Set the minimum number of samples required in a leaf node.

Trait Implementations§

Source§

impl<F: Clone> Clone for VotingRegressor<F>

Source§

fn clone(&self) -> VotingRegressor<F>

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<F: Debug> Debug for VotingRegressor<F>

Source§

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

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

impl<F: Float> Default for VotingRegressor<F>

Source§

fn default() -> Self

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

impl<'de, F> Deserialize<'de> for VotingRegressor<F>

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 1]>>> for VotingRegressor<F>

Source§

fn fit( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<FittedVotingRegressor<F>, FerroError>

Fit the voting regressor by training each decision tree on the full dataset.

§Errors

Returns FerroError::ShapeMismatch if x and y have different numbers of samples. Returns FerroError::InsufficientSamples if there are no samples. Returns FerroError::InvalidParameter if configuration is invalid.

Source§

type Fitted = FittedVotingRegressor<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl<F: Float + Send + Sync + 'static> PipelineEstimator<F> for VotingRegressor<F>

Source§

fn fit_pipeline( &self, x: &Array2<F>, y: &Array1<F>, ) -> Result<Box<dyn FittedPipelineEstimator<F>>, FerroError>

Fit this estimator on the given data. Read more
Source§

impl<F> Serialize for VotingRegressor<F>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<F> Freeze for VotingRegressor<F>

§

impl<F> RefUnwindSafe for VotingRegressor<F>
where F: RefUnwindSafe,

§

impl<F> Send for VotingRegressor<F>
where F: Send,

§

impl<F> Sync for VotingRegressor<F>
where F: Sync,

§

impl<F> Unpin for VotingRegressor<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for VotingRegressor<F>

§

impl<F> UnwindSafe for VotingRegressor<F>
where F: 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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,