分层分组 K 折交叉验证#

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

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

此交叉验证对象是 StratifiedKFold 的一个变体,它尝试返回具有非重叠分组的分层折叠。这些折叠是通过保留每个类别的样本百分比来创建的。

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

GroupKFoldStratifiedGroupKFold 的区别在于,前者试图创建平衡的折数,使得每个折数中不同组的数量大致相同,而后者则试图创建折数,在分组之间不重叠的约束下,尽可能多地保留每个类别的样本百分比。

更多信息请阅读 用户指南

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

参数:
n_splitsint,默认为 5

折数。必须至少为 2。

shufflebool,默认为 False

是否在将每个类别的样本分成批次之前进行混洗。请注意,每个分割中的样本不会被混洗。此实现只能混洗具有大致相同 y 分布的组,不会执行全局混洗。

random_stateint 或 RandomState 实例,默认为 None

shuffle 为 True 时,random_state 会影响索引的顺序,这控制着每个类别每个折数的随机性。否则,将 random_state 保留为 None。传递一个整数,以便在多次函数调用中获得可重复的输出。请参见 词汇表

另请参见

分层 K 折交叉验证 (StratifiedKFold)

考虑类别信息来构建保留类别分布的折数(用于二元或多类别分类任务)。

分组 K 折交叉验证 (GroupKFold)

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

注释

该实现旨在

  • 尽可能多地模仿 StratifiedKFold 的行为,用于简单的组(例如,当每个组只包含一个样本时)。

  • 对类标签不变:将 y = ["Happy", "Sad"] 重命名为 y = [1, 0] 不应该改变生成的索引。

  • 尽可能基于样本进行分层,同时保持不重叠的组约束。这意味着在某些情况下,当少量组包含大量样本时,分层将无法进行,其行为将接近于 GroupKFold。

示例

>>> import numpy as np
>>> from sklearn.model_selection import StratifiedGroupKFold
>>> X = np.ones((17, 2))
>>> y = np.array([0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0])
>>> groups = np.array([1, 1, 2, 2, 3, 3, 3, 4, 5, 5, 5, 5, 6, 6, 7, 8, 8])
>>> sgkf = StratifiedGroupKFold(n_splits=3)
>>> sgkf.get_n_splits(X, y)
3
>>> print(sgkf)
StratifiedGroupKFold(n_splits=3, random_state=None, shuffle=False)
>>> for i, (train_index, test_index) in enumerate(sgkf.split(X, y, groups)):
...     print(f"Fold {i}:")
...     print(f"  Train: index={train_index}")
...     print(f"         group={groups[train_index]}")
...     print(f"  Test:  index={test_index}")
...     print(f"         group={groups[test_index]}")
Fold 0:
  Train: index=[ 0  1  2  3  7  8  9 10 11 15 16]
         group=[1 1 2 2 4 5 5 5 5 8 8]
  Test:  index=[ 4  5  6 12 13 14]
         group=[3 3 3 6 6 7]
Fold 1:
  Train: index=[ 4  5  6  7  8  9 10 11 12 13 14]
         group=[3 3 3 4 5 5 5 5 6 6 7]
  Test:  index=[ 0  1  2  3 15 16]
         group=[1 1 2 2 8 8]
Fold 2:
  Train: index=[ 0  1  2  3  4  5  6 12 13 14 15 16]
         group=[1 1 2 2 3 3 3 6 6 7 8 8]
  Test:  index=[ 7  8  9 10 11]
         group=[4 5 5 5 5]
get_metadata_routing()[source]#

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

请查看 用户指南,了解路由机制的工作原理。

返回:
routingMetadataRequest

一个 MetadataRequest 封装路由信息。

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

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

参数:
X对象

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

y对象

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

groups对象

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

返回:
n_splitsint

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

set_split_request(*, groups: bool | None | str = '$UNCHANGED$') StratifiedGroupKFold[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 参数的元数据路由。

返回:
self对象

更新后的对象。

split(X, y=None, groups=None)[源代码]#

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

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

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

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

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

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

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

产量:
trainndarray

该拆分的训练集索引。

testndarray

该拆分的测试集索引。