RandomForestClassifier

Struct RandomForestClassifier 

Source
pub struct RandomForestClassifier { /* private fields */ }
Expand description

Random Forest classifier - an ensemble of decision trees.

Combines multiple decision trees trained on bootstrap samples with random feature selection to reduce overfitting and improve accuracy.

Implementations§

Source§

impl RandomForestClassifier

Source

pub fn new(n_estimators: usize) -> Self

Creates a new Random Forest classifier.

§Arguments
  • n_estimators - Number of trees in the forest
Source

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

Sets the maximum depth for each tree.

Source

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

Sets the random state for reproducibility.

Source

pub fn fit(&mut self, x: &Matrix<f32>, y: &[usize]) -> Result<()>

Fits the random forest to training data.

§Errors

Returns an error if fitting fails.

Source

pub fn predict(&self, x: &Matrix<f32>) -> Vec<usize>

Makes predictions for input data.

Source

pub fn score(&self, x: &Matrix<f32>, y: &[usize]) -> f32

Calculates accuracy score on test data.

Source

pub fn predict_proba(&self, x: &Matrix<f32>) -> Matrix<f32>

Predict class probabilities for input features.

Returns probability distribution over classes based on vote proportions across trees in the forest.

§Returns

Matrix<f32> with shape (n_samples, n_classes) where each row sums to 1.0.

Source

pub fn oob_prediction(&self) -> Option<Vec<usize>>

Returns Out-of-Bag (OOB) predictions for training samples.

For each training sample, predictions are made using only the trees where that sample was NOT in the bootstrap sample (out-of-bag).

§Returns

Some(Vec<usize>) if the model has been fitted, None otherwise. The vector has the same length as the training data.

Source

pub fn oob_score(&self) -> Option<f32>

Returns Out-of-Bag (OOB) accuracy score.

Computes accuracy using OOB predictions. This provides an unbiased estimate of the model’s performance without needing a validation set.

§Returns

Some(f32) with accuracy in [0, 1] if model has been fitted, None otherwise.

Source

pub fn feature_importances(&self) -> Option<Vec<f32>>

Returns feature importances based on mean decrease in impurity.

Feature importance is calculated as the total decrease in node impurity (weighted by the number of samples) averaged over all trees in the forest.

§Returns

Some(Vec<f32>) with importance for each feature (normalized to sum to 1.0) if model has been fitted, None otherwise.

§Example
let mut rf = RandomForestClassifier::new(50);
rf.fit(&x_train, &y_train).expect("fit should succeed");

if let Some(importances) = rf.feature_importances() {
    for (i, &importance) in importances.iter().enumerate() {
        println!("Feature {}: {:.4}", i, importance);
    }
}
Source

pub fn save_safetensors<P: AsRef<Path>>(&self, path: P) -> Result<(), String>

Saves the Random Forest model to a SafeTensors file.

§Arguments
  • path - Path where the SafeTensors file will be saved
§Errors

Returns an error if the model is unfitted or if saving fails.

Source

pub fn load_safetensors<P: AsRef<Path>>(path: P) -> Result<Self, String>

Loads a Random Forest model from a SafeTensors file.

§Arguments
  • path - Path to the SafeTensors file
§Errors

Returns an error if loading fails or if the file format is invalid.

Trait Implementations§

Source§

impl Clone for RandomForestClassifier

Source§

fn clone(&self) -> RandomForestClassifier

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 Debug for RandomForestClassifier

Source§

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

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

impl<'de> Deserialize<'de> for RandomForestClassifier

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 Serialize for RandomForestClassifier

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§

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> 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>,