StratifiedKFold#

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

分层 K-Fold 交叉验证器。

提供用于将数据拆分为训练集/测试集的训练/测试索引。

此交叉验证对象是 KFold 的一个变体,它返回分层的折叠。这些折叠是通过在二元或多类分类设置中保留 y 中每个类别的样本百分比来创建的。

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

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

注意

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

参数:
n_splitsint, default=5

折叠数。必须至少为 2。

版本 0.22 中已更改: n_splits 的默认值从 3 更改为 5。

shufflebool, default=False

是否在分割成批次之前对每个类别的样本进行洗牌。请注意,每个折叠内的样本将不会被洗牌。

random_stateint, RandomState instance or None, default=None

shuffle 为 True 时,random_state 会影响索引的顺序,从而控制每个类别中每个折叠的随机性。否则,将 random_state 留空 None。传入一个整数以实现跨多次函数调用的可重现输出。请参阅 术语表

另请参阅

RepeatedStratifiedKFold

重复 Stratified K-Fold n 次。

注意事项

该实现旨在

  • 生成测试集,使所有测试集具有相同的类别分布,或尽可能接近。

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

  • shuffle=False 时,保留数据集中顺序依赖性:某个测试集中的类别 k 的所有样本在 y 中是连续的,或者在 y 中被非 k 类别的样本隔开。

  • 生成测试集,其中最小和最大的样本数差异最多为 1。

版本 0.22 中已更改: 之前的实现不遵循最后一条约束。

示例

>>> import numpy as np
>>> from sklearn.model_selection import StratifiedKFold
>>> X = np.array([[1, 2], [3, 4], [1, 2], [3, 4]])
>>> y = np.array([0, 0, 1, 1])
>>> skf = StratifiedKFold(n_splits=2)
>>> skf.get_n_splits()
2
>>> print(skf)
StratifiedKFold(n_splits=2, random_state=None, shuffle=False)
>>> for i, (train_index, test_index) in enumerate(skf.split(X, y)):
...     print(f"Fold {i}:")
...     print(f"  Train: index={train_index}")
...     print(f"  Test:  index={test_index}")
Fold 0:
  Train: index=[1 3]
  Test:  index=[0 2]
Fold 1:
  Train: index=[0 2]
  Test:  index=[1 3]
get_metadata_routing()[源代码]#

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

请查阅 用户指南,了解路由机制如何工作。

返回:
routingMetadataRequest

封装路由信息的 MetadataRequest

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

返回在实例化交叉验证器时使用 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

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

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

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

参数:
Xshape 为 (n_samples, n_features) 的 array-like

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

请注意,提供 y 足以生成拆分,因此可以使用 np.zeros(n_samples) 作为 X 的占位符,而不是实际的训练数据。

yarray-like of shape (n_samples,)

用于监督学习问题的目标变量。分层是基于 y 标签完成的。

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

始终忽略,存在是为了保持 API 兼容性。

生成:
trainndarray

该拆分的训练集索引。

testndarray

该拆分的测试集索引。

注意事项

随机 CV 拆分器在每次调用 split 时可能会返回不同的结果。您可以通过将 random_state 设置为整数来使结果相同。