Ctrl+K

StratifiedGroupKFold#

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

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

这个交叉验证对象是StratifiedKFold的变体，试图返回具有非重叠组的分层褶皱。折叠是通过保留每个类别的样本百分比来制成的。

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

的区别 GroupKFold 和 StratifiedGroupKFold 前者试图创建平衡的褶皱，以便每个褶皱中不同群体的数量大致相同，而 StratifiedGroupKFold 考虑到拆分之间非重叠组的限制，尝试创建折叠，尽可能保留每个类别的样本百分比。

阅读更多的 User Guide .

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

参数:
n_splitsint，默认=5

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

shuffle布尔，默认=假

在分成批次之前是否对每个类别的样本进行洗牌。请注意，每个拆分中的样本不会被打乱。此实现只能对y分布大致相同的组进行洗牌，不会执行全局洗牌。

random_stateint或RandomState实例，默认=无

当 shuffle 是真的， random_state 影响索引的排序，这控制每个类的每个折叠的随机性。否则，离开 random_state 作为 None .传递int以获得跨多个函数调用的可重复输出。看到 Glossary .

参见

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()[源代码]#

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

请检查 User Guide 关于路由机制如何工作。

返回:
routingMetadataRequest

A MetadataRequest 封装路由信息。

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

返回交叉验证器中分裂迭代的数量。

参数:
X对象

总是被忽略，存在是为了兼容性。

y对象

总是被忽略，存在是为了兼容性。

groups对象

总是被忽略，存在是为了兼容性。

返回:
n_splitsint

返回交叉验证器中分裂迭代的数量。

set_split_request(*, groups: bool | None | str = '$UNCHANGED$') → StratifiedGroupKFold[源代码]#

请求元数据传递给 split 法

请注意，此方法仅适用于以下情况 enable_metadata_routing=True （见 sklearn.set_config ).请参阅 User Guide 关于路由机制如何工作。

The options for each parameter are:

  • True ：元数据被请求并传递给 split 如果提供的话。如果未提供元数据，则会忽略请求。

  • False ：未请求元数据，元估计器不会将其传递给 split .

  • None ：不请求元数据，如果用户提供元估计器，则元估计器将引发错误。

  • str ：元数据应通过此给定别名而不是原始名称传递给元估计器。

默认 (sklearn.utils.metadata_routing.UNCHANGED ）保留现有请求。这允许您更改某些参数的请求，而不是其他参数。

Added in version 1.3.

备注

只有当该估计器用作元估计器的子估计器时，该方法才相关，例如在 Pipeline .否则就没有效果了。

参数:
groups字符串、真、假或无， 默认=sklearn.utils. metalics_Routing.UNChanged

元数据路由 groups 参数 split .

返回:
self对象

更新的对象。

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

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

参数:
X形状类似阵列（n_samples，n_features）

训练数据，在哪里 n_samples 是样本数量和 n_features 是功能的数量。

y形状类似数组（n_samples，），默认=无

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

groups形状类似数组（n_samples，），默认=无

Group labels for the samples used while splitting the dataset into train/test set.

收益率:
trainndarray

训练为该分裂设置了指数。

testndarray

测试为该分裂设置了指数。

On this page