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.

Constructors

constructor()

Signature

new PredefinedSplit(opts?: object): PredefinedSplit;

Parameters

Name	Type	Description
`opts?`	`object`	-
`opts.test_fold?`	`ArrayLike`	The 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)

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_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Signature

get_metadata_routing(opts: object): Promise<any>;

Parameters

Name	Type	Description
`opts`	`object`	-
`opts.routing?`	`any`	A `MetadataRequest` encapsulating routing information.

Returns

Promise<any>

Defined in: generated/model_selection/PredefinedSplit.ts:107 (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

Name	Type	Description
`opts`	`object`	-
`opts.X?`	`any`	Always ignored, exists for compatibility.
`opts.groups?`	`any`	Always ignored, exists for compatibility.
`opts.y?`	`any`	Always ignored, exists for compatibility.

Returns

Promise<number>

Defined in: generated/model_selection/PredefinedSplit.ts:142 (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

Name	Type
`py`	`PythonBridge`

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

Name	Type	Description
`opts`	`object`	-
`opts.X?`	`any`	Always ignored, exists for compatibility.
`opts.groups?`	`any`	Always ignored, exists for compatibility.
`opts.y?`	`any`	Always ignored, exists for compatibility.