GroupKFold#

class sklearn.model_selection.GroupKFold(n_splits=5, *, shuffle=False, random_state=None)[source]#

K折迭代器变体，具有不重叠的分组。

每个分组在所有折叠的测试集中只会出现一次（不同分组的数量必须至少等于折叠的数量）。

当 shuffle 为 True 时，每个测试折叠中的样本数量大致相同，从而使折叠近似平衡。

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

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

参数:

n_splitsint, 默认值=5: 折叠数量。必须至少为2。

版本 0.22 中的变化: n_splits 的默认值从 3 更改为 5。
shufflebool, 默认值=False: 在将分组拆分为批次之前是否打乱分组。请注意，每个分割内的样本不会被打乱。

版本 1.6 中新增。
random_stateint, RandomState 实例或 None, 默认值=None: 当 shuffle 为 True 时，random_state 会影响索引的顺序，从而控制每个折叠的随机性。否则，此参数无效。传入一个整数可在多次函数调用中获得可复现的输出。请参阅术语表。

版本 1.6 中新增。

另请参阅

LeaveOneGroupOut: 用于根据数据集的显式领域特定分层来分割数据。
StratifiedKFold: 考虑类别信息以避免构建类别比例不平衡的折叠（适用于二元或多类别分类任务）。

注意

分组在所有折叠中以任意顺序出现。

示例

>>> import numpy as np
>>> from sklearn.model_selection import GroupKFold
>>> X = np.array([[1, 2], [3, 4], [5, 6], [7, 8], [9, 10], [11, 12]])
>>> y = np.array([1, 2, 3, 4, 5, 6])
>>> groups = np.array([0, 0, 2, 2, 3, 3])
>>> group_kfold = GroupKFold(n_splits=2)
>>> group_kfold.get_n_splits(X, y, groups)
2
>>> print(group_kfold)
GroupKFold(n_splits=2, random_state=None, shuffle=False)
>>> for i, (train_index, test_index) in enumerate(group_kfold.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], group=[2 2]
  Test:  index=[0 1 4 5], group=[0 0 3 3]
Fold 1:
  Train: index=[0 1 4 5], group=[0 0 3 3]
  Test:  index=[2 3], group=[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$') → GroupKFold[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: split 方法中 groups 参数的元数据路由。

返回:

selfobject: 更新后的对象。

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

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

参数:

Xarray-like, 形状为 (n_samples, n_features): 训练数据，其中 n_samples 是样本数量，n_features 是特征数量。
yarray-like, 形状为 (n_samples,), 默认值=None: 用于监督学习问题的目标变量。
groupsarray-like, 形状为 (n_samples,): 在将数据集分割为训练/测试集时使用的样本分组标签。

返回:

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

图库示例#

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

scikit-learn 1.4 发布亮点

GroupKFold#

图库示例#

本页