StratifiedGroupKFold#

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

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

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

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

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

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

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

注意

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

参数:

n_splitsint, default=5: 折叠数。必须至少为 2。
shufflebool, default=False: 在分割成批次之前是否打乱每个类别的样本。请注意，每个分割内的样本不会被打乱。此实现只能打乱具有大致相同 y 类别分布的组，不会执行全局打乱。
random_stateint or RandomState instance, default=None: 当 shuffle 为 True 时，random_state 会影响索引的顺序，从而控制每个类别中每个折叠的随机性。否则，将 random_state 保留为 None。传入一个 int 以在多次函数调用中获得可重现的输出。请参阅词汇表。

另请参阅

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()
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]#

返回在实例化交叉验证器时使用 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$') → StratifiedGroupKFold[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: 用于监督学习问题的目标变量。
groups形状为 (n_samples,) 的类数组对象，默认=None: 用于将数据集拆分为训练/测试集时样本的组标签。

生成:

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

Gallery examples#

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

StratifiedGroupKFold#

Gallery examples#

本页