GroupKFold#

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

具有非重叠组的 K 折迭代器变体。

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

如果 shuffle 为 True，折叠在平衡性方面近似平衡，即每个测试折叠中的样本数量大致相同。

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

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

参数:

n_splitsint, default=5: 折叠数。必须至少为 2。

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

版本 1.6 中新增。
random_stateint, RandomState instance or None, default=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()
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]#

返回在实例化交叉验证器时使用 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$') → GroupKFold[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: 该拆分的测试集索引。

Gallery examples#

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

scikit-learn 1.4 发布亮点

GroupKFold#

Gallery examples#

本页