GroupShuffleSplit#

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

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

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

例如,组可以是样本的收集年份,从而允许基于时间的划分进行交叉验证。

LeavePGroupsOutGroupShuffleSplit 的区别在于,前者使用大小为 p 的所有唯一组子集生成划分,而 GroupShuffleSplit 生成由用户确定的随机测试划分数量,每个划分具有用户确定的唯一组比例。

例如,LeavePGroupsOut(p=10) 的一个计算量较小的替代方案是 GroupShuffleSplit(test_size=10, n_splits=100)

与其他交叉验证策略不同,随机划分不能保证所有折叠中的测试集都是互斥的,并且可能包含重叠样本。然而,对于大型数据集,这种情况仍然很可能发生。

注意:参数 test_sizetrain_size 指的是组,而不是像 ShuffleSplit 中那样指的是样本。

用户指南中了解更多信息。

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

参数:
n_splitsint, 默认值=5

重新打乱和划分的迭代次数。

test_sizefloat, int, 默认值=None

如果为浮点数,应介于 0.0 和 1.0 之间,表示测试划分中包含的组的比例(向上取整)。如果为整数,表示测试组的绝对数量。如果为 None,则该值设置为训练大小的补数。如果 train_size 也为 None,则将其设置为 0.2。

train_sizefloat 或 int, 默认值=None

如果为浮点数,应介于 0.0 和 1.0 之间,表示训练划分中包含的组的比例。如果为整数,表示训练组的绝对数量。如果为 None,则该值会自动设置为测试大小的补数。

random_stateint, RandomState 实例或 None, 默认值=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]#

返回交叉验证器中的划分迭代次数。

参数:
Xobject

始终被忽略,存在是为了兼容性。

yobject

始终被忽略,存在是为了兼容性。

groupsobject

始终被忽略,存在是为了兼容性。

返回:
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 中添加。

注意

此方法仅在此估计器用作元估计器的子估计器时(例如在 Pipeline 内部使用时)才相关。否则,它没有效果。

参数:
groupsstr, True, False, 或 None, 默认值=sklearn.utils.metadata_routing.UNCHANGED

splitgroups 参数的元数据路由。

返回:
selfobject

更新后的对象。

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

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

参数:
X形状为 (n_samples, n_features) 的类数组

训练数据,其中 n_samples 是样本数量,n_features 是特征数量。

y形状为 (n_samples,) 的类数组,默认值=None

用于监督学习问题的目标变量。

groups形状为 (n_samples,) 的类数组

将数据集划分为训练/测试集时使用的样本的组标签。

生成:
trainndarray

该划分的训练集索引。

testndarray

该划分的测试集索引。

备注

随机化的交叉验证划分器每次调用 split 可能会返回不同的结果。通过将 random_state 设置为整数,可以使结果相同。