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.
Read more in the User Guide.
Python Reference (opens in a new tab)
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
Defined in: generated/model_selection/LeavePGroupsOut.ts:29 (opens in a new tab)
Properties
_isDisposed
boolean=false
Defined in: generated/model_selection/LeavePGroupsOut.ts:27 (opens in a new tab)
_isInitialized
boolean=false
Defined in: generated/model_selection/LeavePGroupsOut.ts:26 (opens in a new tab)
_py
PythonBridge
Defined in: generated/model_selection/LeavePGroupsOut.ts:25 (opens in a new tab)
id
string
Defined in: generated/model_selection/LeavePGroupsOut.ts:22 (opens in a new tab)
opts
any
Defined in: generated/model_selection/LeavePGroupsOut.ts:23 (opens in a new tab)
Accessors
py
Signature
py(): PythonBridge;Returns
PythonBridge
Defined in: generated/model_selection/LeavePGroupsOut.ts:39 (opens in a new tab)
Signature
py(pythonBridge: PythonBridge): void;Parameters
| Name | Type |
|---|---|
pythonBridge | PythonBridge |
Returns
void
Defined in: generated/model_selection/LeavePGroupsOut.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/LeavePGroupsOut.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
| 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: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
| Name | Type |
|---|---|
py | PythonBridge |
Returns
Promise<void>
Defined in: generated/model_selection/LeavePGroupsOut.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
| 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. |
Returns
Promise<ArrayLike>
Defined in: generated/model_selection/LeavePGroupsOut.ts:154 (opens in a new tab)