Documentation
Classes
PredefinedSplit

PredefinedSplit

Predefined split cross-validator

Provides train/test indices to split data into train/test sets using a predefined scheme specified by the user with the test\_fold parameter.

Read more in the User Guide.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new PredefinedSplit(opts?: object): PredefinedSplit;

Parameters

NameTypeDescription
opts?object-
opts.test_fold?ArrayLikeThe entry test\_fold\[i\] represents the index of the test set that sample i belongs to. It is possible to exclude sample i from any test set (i.e. include sample i in every training set) by setting test\_fold\[i\] equal to -1.

Returns

PredefinedSplit

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

Properties

_isDisposed

boolean = false

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

_isInitialized

boolean = false

Defined in: generated/model_selection/PredefinedSplit.ts:22 (opens in a new tab)

_py

PythonBridge

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

id

string

Defined in: generated/model_selection/PredefinedSplit.ts:18 (opens in a new tab)

opts

any

Defined in: generated/model_selection/PredefinedSplit.ts:19 (opens in a new tab)

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/model_selection/PredefinedSplit.ts:35 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/model_selection/PredefinedSplit.ts:39 (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/PredefinedSplit.ts:88 (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/PredefinedSplit.ts:105 (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/PredefinedSplit.ts:48 (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?anyAlways ignored, exists for compatibility.
opts.groups?anyAlways ignored, exists for compatibility.
opts.y?anyAlways ignored, exists for compatibility.

Returns

Promise<ArrayLike>

Defined in: generated/model_selection/PredefinedSplit.ts:148 (opens in a new tab)