StratifiedKFold#

class sklearn.model_selection.StratifiedKFold(n_splits=5, *, shuffle=False, random_state=None)#

分层K折交叉验证器。

提供训练/测试索引来将数据分割为训练/测试集。

这种交叉验证对象是KFold的一种变体,返回分层折叠。折叠是通过保留每个类别的样本百分比来制作的。

更多信息请参阅 用户指南

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

Parameters:
n_splitsint, default=5

折叠数。必须至少为2。

Changed in version 0.22: n_splits 默认值从3改为5。

shufflebool, default=False

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

random_stateint, RandomState instance or None, default=None

shuffle 为 True 时, random_state 影响索引的顺序,这控制每个类别每个折叠的随机性。 否则,将 random_state 保留为 None 。 传递一个 int 以在多次函数调用中获得可重复的输出。请参阅 Glossary

See also

RepeatedStratifiedKFold

重复分层K折n次。

Notes

该实现旨在:

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

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

  • shuffle=False 时,保留数据排序中的顺序依赖关系:某些测试集中类别 k 的所有样本在 y 中是连续的,或在 y 中由其他类别的样本分隔。

  • 生成测试集,其中最小和最大的测试集最多相差一个样本。

Changed in version 0.22: 之前的实现不遵循最后一个约束。

Examples

>>> 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(X, y)
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()#

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

请查看 用户指南 以了解路由机制的工作原理。

Returns:
routingMetadataRequest

MetadataRequest 封装的 路由信息。

get_n_splits(X=None, y=None, groups=None)#

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

Parameters:
Xobject

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

yobject

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

groupsobject

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

Returns:
n_splitsint

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

split(X, y, groups=None)#

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

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

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

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

y形状为 (n_samples,) 的类数组

监督学习问题的目标变量。 分层是基于 y 标签进行的。

groups对象

始终被忽略,存在以兼容。

Yields:
trainndarray

该拆分的训练集索引。

testndarray

该拆分的测试集索引。

Notes

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