Skip to main content

ExtraTreesClassifier

Struct ExtraTreesClassifier 

Source
pub struct ExtraTreesClassifier<F> {
    pub n_estimators: usize,
    pub max_depth: Option<usize>,
    pub min_samples_split: usize,
    pub min_samples_leaf: usize,
    pub max_features: MaxFeatures,
    pub bootstrap: bool,
    pub criterion: ClassificationCriterion,
    pub random_state: Option<u64>,
    pub n_jobs: Option<usize>,
    /* private fields */
}
Expand description

Extremely randomized trees classifier (ensemble).

Builds an ensemble of ExtraTreeClassifier base estimators, each using random split thresholds and random feature subsets at every node. Final predictions are made by majority vote.

Unlike RandomForestClassifier, bootstrap sampling is disabled by default. Randomness comes from the random thresholds and random feature subsets at each split.

§Type Parameters

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

Fields§

§n_estimators: usize

Number of trees in the ensemble.

§max_depth: Option<usize>

Maximum depth of each tree. None means unlimited.

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

§max_features: MaxFeatures

Strategy for the number of features considered at each split.

§bootstrap: bool

Whether to use bootstrap sampling. Default is false.

§criterion: ClassificationCriterion

Splitting criterion.

§random_state: Option<u64>

Random seed for reproducibility. None means non-deterministic.

§n_jobs: Option<usize>

Number of parallel jobs. None means use all available cores.

Implementations§

Source§

impl<F: Float> ExtraTreesClassifier<F>

Source

pub fn new() -> Self

Create a new ExtraTreesClassifier with default settings.

Defaults: n_estimators = 100, max_depth = None, max_features = Sqrt, min_samples_split = 2, min_samples_leaf = 1, bootstrap = false, criterion = Gini, random_state = None, n_jobs = None.

Source

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

Set the number of trees.

Source

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

Set the maximum tree depth.

Source

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

Set the minimum number of samples to split a node.

Source

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

Set the minimum number of samples in a leaf.

Source

pub fn with_max_features(self, max_features: MaxFeatures) -> Self

Set the maximum features strategy.

Source

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

Set whether to use bootstrap sampling.

Source

pub fn with_criterion(self, criterion: ClassificationCriterion) -> Self

Set the splitting criterion.

Source

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

Set the random seed for reproducibility.

Source

pub fn with_n_jobs(self, n_jobs: usize) -> Self

Set the number of parallel jobs.

Trait Implementations§

Source§

impl<F: Clone> Clone for ExtraTreesClassifier<F>

Source§

fn clone(&self) -> ExtraTreesClassifier<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 ExtraTreesClassifier<F>

Source§

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

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

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

Source§

fn default() -> Self

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

impl<'de, F> Deserialize<'de> for ExtraTreesClassifier<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<usize>, Dim<[usize; 1]>>> for ExtraTreesClassifier<F>

Source§

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

Fit the ensemble by building n_estimators extra-trees in parallel.

Each tree uses random split thresholds and random feature subsets at every node. If bootstrap is true, each tree is trained on a bootstrap sample; otherwise all samples are used.

§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 n_estimators is 0.

Source§

type Fitted = FittedExtraTreesClassifier<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl<F: Float + ToPrimitive + FromPrimitive + Send + Sync + 'static> PipelineEstimator<F> for ExtraTreesClassifier<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 ExtraTreesClassifier<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 ExtraTreesClassifier<F>

§

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

§

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

§

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

§

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

§

impl<F> UnsafeUnpin for ExtraTreesClassifier<F>

§

impl<F> UnwindSafe for ExtraTreesClassifier<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,