LeavePGroupsOut

Leave P Group(s) Out cross-validator

Provides train/test indices to split data according to a third-party provided group. This group information can be used to encode arbitrary domain specific stratifications of the samples as integers.

For instance the groups could be the year of collection of the samples and thus allow for cross-validation against time-based splits.

The difference between LeavePGroupsOut and LeaveOneGroupOut is that the former builds the test sets with all the samples assigned to p different values of the groups while the latter uses samples all assigned the same groups.

Constructors

constructor()

Signature

new LeavePGroupsOut(opts?: object): LeavePGroupsOut;

Parameters

Name	Type	Description
`opts?`	`object`	-
`opts.n_groups?`	`number`	Number of groups (`p`) to leave out in the test split.

Returns

LeavePGroupsOut

Defined in: generated/model_selection/LeavePGroupsOut.ts:29 (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/LeavePGroupsOut.ts:92 (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/LeavePGroupsOut.ts:111 (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?`	`ArrayLike`	Group labels for the samples used while splitting the dataset into train/test set. This ‘groups’ parameter must always be specified to calculate the number of splits, though the other parameters can be omitted.
`opts.y?`	`any`	Always ignored, exists for compatibility.

Returns

Promise<number>

Defined in: generated/model_selection/LeavePGroupsOut.ts:146 (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/LeavePGroupsOut.ts:52 (opens in a new tab)

set_split_request()

Request metadata passed to the split method.

Note that this method is only relevant if enable\_metadata\_routing=True (see sklearn.set\_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

Signature

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

Parameters

Name	Type	Description
`opts`	`object`	-
`opts.groups?`	`string` \| `boolean`	Metadata routing for `groups` parameter in `split`.

Returns

Promise<any>

Defined in: generated/model_selection/LeavePGroupsOut.ts:195 (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?`	`ArrayLike`[]	Training data, where `n\_samples` is the number of samples and `n\_features` is the number of features.
`opts.groups?`	`ArrayLike`	Group labels for the samples used while splitting the dataset into train/test set.
`opts.y?`	`ArrayLike`	The target variable for supervised learning problems.