Skip to main content

RFECV

Struct RFECV 

Source
pub struct RFECV<F> { /* private fields */ }
Expand description

Recursive Feature Elimination with Cross-Validation.

Like RFE, but uses cross-validation scores to determine the optimal number of features. The user supplies a vector of per-feature-count CV scores (e.g., from running RFE with different n_features_to_select values), and RFECV picks the number that maximises the score.

§Examples

use ferrolearn_preprocess::rfe::RFECV;
use ferrolearn_core::traits::Transform;
use ndarray::array;

let importances = array![0.5, 0.3, 0.2];
// CV scores for selecting 1, 2, 3 features:
let cv_scores = vec![0.85, 0.95, 0.90];
let rfecv = RFECV::<f64>::new(&importances, &cv_scores, 1).unwrap();
// Best is 2 features (score 0.95)
assert_eq!(rfecv.n_features_selected(), 2);
let x = array![[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]];
let out = rfecv.transform(&x).unwrap();
assert_eq!(out.ncols(), 2);

Implementations§

Source§

impl<F: Float + Send + Sync + 'static> RFECV<F>

Source

pub fn new( importances: &Array1<F>, cv_scores: &[f64], step: usize, ) -> Result<Self, FerroError>

Create a new RFECV from pre-computed importances and CV scores.

§Parameters
  • importances — per-feature importance scores.
  • cv_scores — CV score for each possible number of features (index 0 = 1 feature, index 1 = 2 features, …).
  • step — features removed per iteration.
§Errors
Source

pub fn cv_scores(&self) -> &[f64]

Return the CV scores.

Source

pub fn optimal_n_features(&self) -> usize

Return the optimal number of features.

Source

pub fn n_features_selected(&self) -> usize

Return the number of selected features.

Source

pub fn ranking(&self) -> &[usize]

Return the feature ranking.

Source

pub fn support(&self) -> &[bool]

Return the boolean support mask.

Source

pub fn selected_indices(&self) -> &[usize]

Return the indices of the selected features.

Trait Implementations§

Source§

impl<F: Clone> Clone for RFECV<F>

Source§

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

Source§

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

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

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

Source§

fn transform(&self, x: &Array2<F>) -> Result<Array2<F>, FerroError>

Return a matrix containing only the optimally selected features.

§Errors

Returns FerroError::ShapeMismatch if column count does not match.

Source§

type Output = ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>

The transformed output type.
Source§

type Error = FerroError

The error type returned by transform.

Auto Trait Implementations§

§

impl<F> Freeze for RFECV<F>

§

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

§

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

§

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

§

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

§

impl<F> UnsafeUnpin for RFECV<F>

§

impl<F> UnwindSafe for RFECV<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, U> Imply<T> for U
where T: ?Sized, U: ?Sized,