KFold

class KFold(*args)

K-fold.

Parameters
kpositive integer

Number of folds in which the sample is splitted. If not provided, default is k = 10.

Notes

KFold inherits from FittingAlgorithm.

This class is not usable on its own because it has sense only within the FunctionalChaosAlgorithm.

Methods

getClassName()

Accessor to the object’s name.

getId()

Accessor to the object’s id.

getK()

Accessor to the number of folds.

getName()

Accessor to the object’s name.

getShadowedId()

Accessor to the object’s shadowed id.

getVisibility()

Accessor to the object’s visibility state.

hasName()

Test if the object is named.

hasVisibleName()

Test if the object has a distinguishable name.

run(x, y, weight, basis, indices)

Run the algorithm.

setK(p)

Accessor to the number of folds.

setName(name)

Accessor to the object’s name.

setShadowedId(id)

Accessor to the object’s shadowed id.

setVisibility(visible)

Accessor to the object’s visibility state.

__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.

getK()

Accessor to the number of folds.

Returns
kinteger

Number of folds in which the sample is splitted.

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.

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.

run(x, y, weight, basis, indices)

Run the algorithm.

Parameters
x2-d sequence of float

Input sample

y2-d sequence of float

Output sample

weightsequence of float

Weights associated to the outputs

psisequence of Function

Basis

indicessequence of int

Indices of the basis

Returns
measurefloat

Fitting measure

setK(p)

Accessor to the number of folds.

Parameters
kinteger

Number of folds in which the sample is splitted.

setName(name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

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.