GroupKFold#

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

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

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

折叠大致平衡,因为当 shuffle 是真的

阅读更多的 User Guide .

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

参数:
n_splitsint,默认=5

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

在 0.22 版本发生变更: n_splits 默认值从3更改为5。

shuffle布尔,默认=假

是否在拆分成批之前打乱组。请注意,每个拆分中的样本不会被打乱。

Added in version 1.6.

random_stateint,RandomState实例或无,默认=无

shuffle 是真的, random_state 影响指数的顺序,从而控制每个折叠的随机性。否则,该参数没有任何作用。传递int以获得跨多个函数调用的可重复输出。看到 Glossary .

Added in version 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(X, y, groups)
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()[源代码]#

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

请检查 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$') GroupKFold[源代码]#

请求元数据传递给 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

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