Documentation
Classes
GroupKFold

GroupKFold

K-fold iterator variant with non-overlapping groups.

Each group will appear exactly once in the test set across all folds (the number of distinct groups has to be at least equal to the number of folds).

The folds are approximately balanced in the sense that the number of distinct groups is approximately the same in each fold.

Read more in the User Guide.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new GroupKFold(opts?: object): GroupKFold;

Parameters

NameTypeDescription
opts?object-
opts.n_splits?numberNumber of folds. Must be at least 2. Default Value 5

Returns

GroupKFold

Defined in: generated/model_selection/GroupKFold.ts:27 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/model_selection/GroupKFold.ts:25 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/model_selection/GroupKFold.ts:24 (opens in a new tab)

_py

PythonBridge

Defined in: generated/model_selection/GroupKFold.ts:23 (opens in a new tab)

id

string

Defined in: generated/model_selection/GroupKFold.ts:20 (opens in a new tab)

opts

any

Defined in: generated/model_selection/GroupKFold.ts:21 (opens in a new tab)

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/model_selection/GroupKFold.ts:39 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/model_selection/GroupKFold.ts:43 (opens in a new tab)

Methods

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/model_selection/GroupKFold.ts:92 (opens in a new tab)

get_n_splits()

Returns the number of splitting iterations in the cross-validator

Signature

get_n_splits(opts: object): Promise<number>;

Parameters

NameTypeDescription
optsobject-
opts.X?anyAlways ignored, exists for compatibility.
opts.groups?anyAlways ignored, exists for compatibility.
opts.y?anyAlways ignored, exists for compatibility.

Returns

Promise<number>

Defined in: generated/model_selection/GroupKFold.ts:109 (opens in a new tab)

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

NameType
pyPythonBridge

Returns

Promise<void>

Defined in: generated/model_selection/GroupKFold.ts:52 (opens in a new tab)

split()

Generate indices to split data into training and test set.

Signature

split(opts: object): Promise<ArrayLike>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Training data, where n\_samples is the number of samples and n\_features is the number of features.
opts.groups?ArrayLikeGroup labels for the samples used while splitting the dataset into train/test set.
opts.y?ArrayLikeThe target variable for supervised learning problems.

Returns

Promise<ArrayLike>

Defined in: generated/model_selection/GroupKFold.ts:152 (opens in a new tab)