Class: LeavePOut

Leave-P-Out cross-validator.

Provides train/test indices to split data in train/test sets. This results in testing on all distinct samples of size p, while the remaining n - p samples form the training set in each iteration.

Note: LeavePOut(p) is NOT equivalent to KFold(n_splits=n_samples // p) which creates non-overlapping test sets.

Due to the high number of iterations which grows combinatorically with the number of samples this cross-validation method can be very costly. For large datasets one should favor KFold, StratifiedKFold or ShuffleSplit.

Read more in the User Guide.

Python Reference

Constructors

new LeavePOut()

new LeavePOut(opts?): LeavePOut

Parameters

ParameterTypeDescription
opts?object-
opts.p?numberSize of the test sets. Must be strictly less than the number of samples.

Returns LeavePOut

Defined in generated/model_selection/LeavePOut.ts:29

Properties

PropertyTypeDefault valueDefined in
_isDisposedbooleanfalsegenerated/model_selection/LeavePOut.ts:27
_isInitializedbooleanfalsegenerated/model_selection/LeavePOut.ts:26
_pyPythonBridgeundefinedgenerated/model_selection/LeavePOut.ts:25
idstringundefinedgenerated/model_selection/LeavePOut.ts:22
optsanyundefinedgenerated/model_selection/LeavePOut.ts:23

Accessors

py

Get Signature

get py(): PythonBridge

Returns PythonBridge

Set Signature

set py(pythonBridge): void

Parameters

ParameterType
pythonBridgePythonBridge

Returns void

Defined in generated/model_selection/LeavePOut.ts:39

Methods

dispose()

dispose(): Promise<void>

Disposes of the underlying Python resources.

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

Returns Promise<void>

Defined in generated/model_selection/LeavePOut.ts:89


get_metadata_routing()

get_metadata_routing(opts): Promise<any>

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Parameters

ParameterTypeDescription
optsobject-
opts.routing?anyA MetadataRequest encapsulating routing information.

Returns Promise<any>

Defined in generated/model_selection/LeavePOut.ts:108


get_n_splits()

get_n_splits(opts): Promise<any>

Returns the number of splitting iterations in the cross-validator.

Parameters

ParameterTypeDescription
optsobject-
opts.groups?anyAlways ignored, exists for compatibility.
opts.X?ArrayLike[]Training data, where n_samples is the number of samples and n_features is the number of features.
opts.y?anyAlways ignored, exists for compatibility.

Returns Promise<any>

Defined in generated/model_selection/LeavePOut.ts:142


init()

init(py): Promise<void>

Initializes the underlying Python resources.

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

Parameters

ParameterType
pyPythonBridge

Returns Promise<void>

Defined in generated/model_selection/LeavePOut.ts:52


split()

split(opts): Promise<ArrayLike>

Generate indices to split data into training and test set.

Parameters

ParameterTypeDescription
optsobject-
opts.groups?anyAlways ignored, exists for compatibility.
opts.X?ArrayLike[]Training data, where n_samples is the number of samples and n_features is the number of features.
opts.y?ArrayLikeThe target variable for supervised learning problems.

Returns Promise<ArrayLike>

Defined in generated/model_selection/LeavePOut.ts:184