KFoldSplitter

class KFoldSplitter(*args)

K-fold splitter.

Generates train/test indices to split samples in train/test sets. The sample is split into k folds. Each fold is then used once as test while the k - 1 other folds form the training set.

Parameters

Nint

Size of the set of indices in which the indices are chosen

kint

Number of folds

Examples

>>> import openturns as ot
>>> X = ot.Normal().getSample(10)
>>> k = 5
>>> splitter = ot.KFoldSplitter(X.getSize(), k)
>>> for indices1, indices2 in splitter:
...     X_train, X_test = X[indices1], X[indices2]

Methods

getClassName()	Accessor to the object’s name.
getId()	Accessor to the object’s id.
getN()	Set size accessor.
getName()	Accessor to the object’s name.
getShadowedId()	Accessor to the object’s shadowed id.
getSize()	Number of sets generated.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setName(name)	Accessor to the object’s name.
setRandomize(randomize)	Set the value of the randomize flag.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

generate
next
reset

__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName()

Accessor to the object’s name.

Returns

class_namestr

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getN()

Set size accessor.

Returns

Nint

Size of the set of indices in which the indices are chosen

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getShadowedId()

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getSize()

Number of sets generated.

Returns

lengthint

Number of sets of indices generated.

getVisibility()

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

True if the name is not empty and not the default one.

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setRandomize(randomize)

Set the value of the randomize flag.

Note that the default value is set via the ResourceMap entry KFoldSplitter-Randomize.

Parameters

randomizebool

Scramble the folds.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.