Struct PyKFold 

pub struct PyKFold { /* private fields */ }

K-Fold cross-validator.

Splits data into n_splits consecutive (or shuffled) folds; each fold is used once as the validation set while the remaining folds form the training set.

Implementations

impl PyKFold

pub fn split_core( &self, n_samples: usize, ) -> PyResult<Vec<(Vec<usize>, Vec<usize>)>>

Core split logic, directly unit-testable without a live Python interpreter (see train_test_split_core for why) and pub (exposed for benchmarking from benches/, not part of the stable Python-facing API).

impl PyKFold

pub fn new( n_splits: usize, shuffle: bool, random_state: Option<u64>, ) -> PyResult<Self>

pub in addition to being reachable from Python via #[new], so benches/core_helpers_benchmarks.rs (a separate crate) can construct instances to call split_core on; not part of the stable Python-facing API surface.

Trait Implementations

impl DerefToPyAny for PyKFold

impl ExtractPyClassWithClone for PyKFold

impl<'py> IntoPyObject<'py> for PyKFold

type Target = PyKFold

The Python output type

type Output = Bound<'py, <PyKFold as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyKFold

const NAME: &str = "KFold"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyKFold

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// K-Fold cross-validator. /// /// Splits data into `n_splits` consecutive (or shuffled) folds; each fold /// is used once as the validation set while the remaining folds form the /// training set.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PyKFold as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyKFold>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyKFold

const TEXT_SIGNATURE: &'static str = "(n_splits=5, shuffle=False, random_state=None)"

impl PyMethods<PyKFold> for PyClassImplCollector<PyKFold>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyKFold

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.