StratifiedGroupKFold#

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

带有非重叠组的按类别分层的 K-Fold 迭代器变体。

此交叉验证对象是 StratifiedKFold 的变体,它尝试返回具有非重叠组的分层折叠。这些折叠通过在二元或多类别分类设置中保持 y 中每个类别的样本百分比来创建。

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

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

用户指南中阅读更多信息。

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

注意

对类别标签进行分层解决的是工程问题而非统计问题。有关更多详细信息,请参阅基于类别标签分层的交叉验证迭代器

参数:
n_splitsint, 默认=5

折叠数量。必须至少为2。

shufflebool, 默认=False

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

random_stateint 或 RandomState 实例, 默认=None

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

另请参阅

StratifiedKFold

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

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

split 方法中 groups 参数的元数据路由。

返回:
self对象

更新后的对象。

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

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

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

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

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

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

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

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

生成:
trainndarray

该分割的训练集索引。

testndarray

该分割的测试集索引。