Classifier

Struct Classifier 

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

A random forest classifier.

§Training

The Trainer implements CommonTrainerBuilder and EnsembleTrainerBuilder. Default training parameters:

max_depth: usize::MAX,
max_features: NumFeatures::SQRT,
seed: 42,
min_samples_leaf: 1,
min_samples_split: 2,
sample_weights: empty (1.0 for each sample)
num_trees: 100,
num_threads: 1,

§Example

use rafor::rf;
let dataset = [0.7, 0.0, 0.8, 1.0, 0.7, 0.0];
let targets = [1, 5, 1];
let predictor = rf::Classifier::trainer().train(&dataset, &targets);
let predictions = predictor.predict(&dataset, 1);
assert_eq!(&predictions, &[1, 5, 1]);

Implementations§

Source§

impl Classifier

Source

pub fn predict(&self, dataset: &[f32], num_threads: usize) -> Vec<i64>

Predicts classes for a set of samples using num_threads threads. Dataset is a vector of floats with length multiple of num_features().

Source

pub fn predict_one(&self, sample: &[f32]) -> i64

Predicts class for a single sample given by a slice of length num_features().

Source

pub fn proba(&self, dataset: &[f32], num_threads: usize) -> Vec<f32>

Predicts classes probabilities for each sample using num_threads threads. The length of result vector is number_of_samples * num_classes().

Source

pub fn num_features(&self) -> usize

Returns a number of features for a trained tree.

Source

pub fn trainer() -> Trainer

Provides trainer for training a random forest classifier.

Trait Implementations§

Source§

impl ClassDecode for Classifier

Source§

fn get_decode_table(&self) -> &[i64]

Returns a decode table of length num_classes().
Source§

fn num_classes(&self) -> usize

Returns a number of classes stored int table.
Source§

fn decode(&self, class_enc: usize) -> i64

Decodes a usize value into i64 according to decode table.
Source§

impl Clone for Classifier

Source§

fn clone(&self) -> Classifier

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 Classifier

Source§

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

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

impl Default for Classifier

Source§

fn default() -> Classifier

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

impl<'de> Deserialize<'de> for Classifier

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 PartialEq for Classifier

Source§

fn eq(&self, other: &Classifier) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Classifier

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

impl StructuralPartialEq for Classifier

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