GroupShuffleSplit#

class sklearn.model_selection.GroupShuffleSplit(n_splits=5, *, test_size=None, train_size=None, random_state=None)[source]#

Shuffle-Group(s)-Out 交叉验证迭代器。

提供随机的训练/测试索引，以便根据第三方提供的组对数据进行拆分。此组信息可用于将样本的任意特定领域分层编码为整数。

例如，组可以是样本的采集年份，从而允许针对基于时间的拆分进行交叉验证。

LeavePGroupsOut 和 GroupShuffleSplit 之间的区别在于，前者使用大小为 p 的唯一组的所有子集生成拆分，而 GroupShuffleSplit 生成由用户确定的随机测试拆分次数，每个拆分包含用户确定的唯一组的比例。

例如，LeavePGroupsOut(p=10) 的计算密集度较低的替代方法是 GroupShuffleSplit(test_size=10, n_splits=100)。

与其他交叉验证策略相反，随机拆分不保证所有折叠中的测试集将互斥，并且可能包含重叠样本。然而，对于大型数据集来说，这种情况仍然极有可能发生。

注意：参数 test_size 和 train_size 指的是组，而不是像 ShuffleSplit 中那样指样本。

在用户指南中阅读更多内容。

有关交叉验证行为的可视化以及常见 scikit-learn 拆分方法的比较，请参阅scikit-learn 中的交叉验证行为可视化

参数:

n_splitsint, default=5: 重新打乱和拆分迭代的次数。
test_sizefloat, int, default=None: 如果为浮点数，应在 0.0 和 1.0 之间，表示要包含在测试拆分中的组的比例（向上取整）。如果为整数，则表示测试组的绝对数量。如果为 None，则该值设置为训练大小的补集。如果 train_size 也为 None，则将其设置为 0.2。
train_sizefloat or int, default=None: 如果为浮点数，应在 0.0 和 1.0 之间，表示要包含在训练拆分中的组的比例。如果为整数，则表示训练组的绝对数量。如果为 None，则该值自动设置为测试大小的补集。
random_stateint, RandomState instance or None, default=None: 控制生成的训练和测试索引的随机性。传入一个整数可在多次函数调用中获得可重现的输出。请参阅词汇表。

另请参阅

ShuffleSplit: 打乱样本以创建独立的测试/训练集。
LeavePGroupsOut: 训练集排除所有可能的 p 组子集。

示例

>>> import numpy as np
>>> from sklearn.model_selection import GroupShuffleSplit
>>> X = np.ones(shape=(8, 2))
>>> y = np.ones(shape=(8, 1))
>>> groups = np.array([1, 1, 2, 2, 2, 3, 3, 3])
>>> print(groups.shape)
(8,)
>>> gss = GroupShuffleSplit(n_splits=2, train_size=.7, random_state=42)
>>> gss.get_n_splits()
2
>>> print(gss)
GroupShuffleSplit(n_splits=2, random_state=42, test_size=None, train_size=0.7)
>>> for i, (train_index, test_index) in enumerate(gss.split(X, y, groups)):
...     print(f"Fold {i}:")
...     print(f"  Train: index={train_index}, group={groups[train_index]}")
...     print(f"  Test:  index={test_index}, group={groups[test_index]}")
Fold 0:
  Train: index=[2 3 4 5 6 7], group=[2 2 2 3 3 3]
  Test:  index=[0 1], group=[1 1]
Fold 1:
  Train: index=[0 1 5 6 7], group=[1 1 3 3 3]
  Test:  index=[2 3 4], group=[2 2 2]

get_metadata_routing()[source]#

获取此对象的元数据路由。

请查阅用户指南，了解路由机制如何工作。

返回:

routingMetadataRequest: 封装路由信息的 MetadataRequest。

get_n_splits(X=None, y=None, groups=None)[source]#

返回在实例化交叉验证器时使用 n_splits 参数设置的拆分迭代次数。

参数:

Xarray-like of shape (n_samples, n_features), default=None: 始终忽略，存在是为了保持 API 兼容性。
yshape 为 (n_samples,), default=None 的 array-like: 始终忽略，存在是为了保持 API 兼容性。
groups形状为 (n_samples,) 的类数组对象，默认=None: 始终忽略，存在是为了保持 API 兼容性。

返回:

n_splitsint: 返回交叉验证器中的拆分迭代次数。

set_split_request(*, groups: bool | None | str = '$UNCHANGED$') → GroupShuffleSplit[source]#

配置是否应请求元数据传递给 split 方法。

请注意，此方法仅在以下情况下相关：此估计器用作元估计器中的子估计器，并且通过 enable_metadata_routing=True 启用了元数据路由（请参阅 sklearn.set_config）。请查看用户指南以了解路由机制的工作原理。

每个参数的选项如下：

True：请求元数据，如果提供则传递给 split。如果未提供元数据，则忽略该请求。
False：不请求元数据，元估计器不会将其传递给 split。
None：不请求元数据，如果用户提供元数据，元估计器将引发错误。
str：应将元数据以给定别名而不是原始名称传递给元估计器。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有请求。这允许您更改某些参数的请求而不更改其他参数。

在版本 1.3 中新增。

参数:

groupsstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED: split 中 groups 参数的元数据路由。

返回:

selfobject: 更新后的对象。

split(X, y=None, groups=None)[source]#

生成索引以将数据拆分为训练集和测试集。

参数:

Xshape 为 (n_samples, n_features) 的 array-like: 训练数据，其中 n_samples 是样本数，n_features 是特征数。
yshape 为 (n_samples,), default=None 的 array-like: 用于监督学习问题的目标变量。
groupsarray-like of shape (n_samples,): 用于将数据集拆分为训练/测试集时样本的组标签。

生成:

trainndarray: 该拆分的训练集索引。
testndarray: 该拆分的测试集索引。

注意事项

随机 CV 拆分器在每次调用 split 时可能会返回不同的结果。您可以通过将 random_state 设置为整数来使结果相同。

Gallery examples#

可视化 scikit-learn 中的交叉验证行为

GroupShuffleSplit#

Gallery examples#

本页