Struct KFold

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

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

impl KFold

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

Number of folds. Must be at least 2.

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

Whether to shuffle the data before splitting into batches

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

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

Trait Implementations

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.

fn n_splits(&self) -> usize

Returns the number of splits

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.

impl Default for KFold

fn default() -> KFold

Returns the “default value” for a type.