StratifiedKFold#

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

分层 K-Fold 交叉验证器。

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

此交叉验证对象是 KFold 的变体，它返回分层（stratified）的折叠。在二分类或多分类设置中，通过保留 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: 重复分层 K 折交叉验证 n 次。

注意事项

该实现的目的是：

生成测试集，使得所有测试集都包含相同或尽可能接近的类别分布。
对类标签保持不变：将 y = ["Happy", "Sad"] 重新标注为 y = [1, 0] 不应改变生成的索引。
当 shuffle=False 时，保持数据集排序中的顺序依赖关系：某个测试集中来自类别 k 的所有样本在 y 中是连续的，或者在 y 中被非 k 类的样本分隔开。
生成测试集，其中最小和最大的测试集大小相差最多不超过一个样本。

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()[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 兼容性。

返回: