pub struct KFold {
    pub n_splits: usize,
    pub shuffle: bool,
    pub seed: Option<u64>,
}
Expand description

K-Folds cross-validator

Fields§

§n_splits: usize

Number of folds. Must be at least 2.

§shuffle: bool

Whether to shuffle the data before splitting into batches

§seed: Option<u64>

When shuffle is True, seed affects the ordering of the indices. Which controls the randomness of each fold

Implementations§

source§

impl KFold

source

pub fn with_n_splits(self, n_splits: usize) -> Self

Number of folds. Must be at least 2.

source

pub fn with_shuffle(self, shuffle: bool) -> Self

Whether to shuffle the data before splitting into batches

source

pub fn with_seed(self, seed: Option<u64>) -> Self

When shuffle is True, random_state affects the ordering of the indices.

Trait Implementations§

source§

impl BaseKFold for KFold

Abstract class for all KFold functionalities

§

type Output = KFoldIter

An iterator over indices that split data into training and test set.
source§

fn n_splits(&self) -> usize

Returns the number of splits
source§

fn split<T: Debug + Display + Copy + Sized, M: Array2<T>>( &self, x: &M ) -> Self::Output

Return a tuple containing the the training set indices for that split and the testing set indices for that split.
source§

impl Default for KFold

source§

fn default() -> KFold

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

Auto Trait Implementations§

§

impl RefUnwindSafe for KFold

§

impl Send for KFold

§

impl Sync for KFold

§

impl Unpin for KFold

§

impl UnwindSafe for KFold

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. 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 Twhere 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, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.