管道

class sklearn.pipeline.Pipeline(steps, *, transform_input=None, memory=None, verbose=False)

一系列数据变换器，带有一个可选的最终预测器。

Pipeline 允许您顺序应用一系列变换器来预处理数据，并且如果需要，可以使用最终的 预测器 来进行预测建模。

流水线中的中间步骤必须是转换器，也就是说，它们必须实现fit和transform方法。最终的估计器只需要实现fit方法。流水线中的转换器可以使用memory参数进行缓存。

流水线的目的是组合几个步骤，以便在设置不同的参数时可以一起进行交叉验证。为此，它允许使用步骤名称和参数名称（用'__'分隔）来设置各个步骤的参数，如下例所示。可以通过将参数设置为另一个估计器来完全替换步骤的估计器，或者通过将其设置为'passthrough'或None来移除转换器。

有关Pipeline与GridSearchCV组合的示例用例，请参考使用Pipeline和GridSearchCV选择降维。示例流水线：链接PCA和逻辑回归展示了如何使用'__'作为参数名称分隔符在流水线上进行网格搜索。

更多信息请阅读用户指南。

0.5版本新增。

参数：

steps元组列表

按顺序链接的(步骤名称，估计器)元组列表。为了与scikit-learn API兼容，所有步骤都必须定义fit方法。所有非最后一步也必须定义transform方法。更多详情请见组合估计器。

transform_input字符串列表，默认为None

应在将其传递给使用它的步骤之前，由流水线转换的元数据参数的名称。

这使得可以将一些输入参数（除了X）传递给fit方法，这些参数将由流水线中的步骤（直到需要它们的步骤）进行转换。需求是通过元数据路由定义的。例如，这可以用于通过流水线传递验证集。

只有在启用元数据路由时才能设置此参数，可以使用sklearn.set_config(enable_metadata_routing=True)启用元数据路由。

1.6版本新增。

memory字符串或具有joblib.Memory接口的对象，默认为None

用于缓存流水线的已拟合转换器。即使是转换器，最后一步也不会被缓存。默认情况下，不执行缓存。如果给定一个字符串，则它是缓存目录的路径。启用缓存会在拟合之前触发转换器的克隆。因此，不能直接检查提供给流水线的转换器实例。使用属性named_steps或steps来检查流水线中的估计器。当拟合非常耗时时，缓存转换器是有利的。

verbose布尔值，默认为False

如果为True，则会在每个步骤拟合完成后打印所用时间。

属性：

named_stepsBunch

按名称访问步骤。

classes_形状为(n_classes,)的ndarray

类别标签。

n_features_in_整数

在第一步fit方法期间看到的特征数量。

feature_names_in_形状为(n_features_in_,)的ndarray

在第一步fit方法期间看到的特征名称。

另请参阅

创建管道

简化流水线构建的便捷函数。

示例

>>> from sklearn.svm import SVC
>>> from sklearn.preprocessing import StandardScaler
>>> from sklearn.datasets import make_classification
>>> from sklearn.model_selection import train_test_split
>>> from sklearn.pipeline import Pipeline
>>> X, y = make_classification(random_state=0)
>>> X_train, X_test, y_train, y_test = train_test_split(X, y,
...                                                     random_state=0)
>>> pipe = Pipeline([('scaler', StandardScaler()), ('svc', SVC())])
>>> # The pipeline can be used as any other estimator
>>> # and avoids leaking the test set into the train set
>>> pipe.fit(X_train, y_train).score(X_test, y_test)
0.88
>>> # An estimator's parameter can be set using '__' syntax
>>> pipe.set_params(svc__C=10).fit(X_train, y_train).score(X_test, y_test)
0.76

property classes_

类别标签。仅当最后一步是分类器时才存在。

decision_function(X, **params)

转换数据，并使用最终估计器应用decision_function。

调用流水线中每个转换器的transform方法。转换后的数据最终传递给调用decision_function方法的最终估计器。只有在最终估计器实现decision_function方法时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

**params字符串到对象的字典

步骤请求并接受的参数。每个步骤都必须请求某些元数据，才能将其转发给它们。

1.4版本新增： 仅当enable_metadata_routing=True时才可用。更多详情请见元数据路由用户指南。

返回值：

y_score形状为 (n_samples, n_classes) 的 ndarray

最终估计器调用decision_function的结果。

property feature_names_in_

在第一步fit方法期间看到的特征名称。

fit(X, y=None, **params)

拟合模型。

依次拟合所有转换器并依次转换数据。最后，使用最终估计器拟合转换后的数据。

参数：

X可迭代对象

训练数据。必须满足管道第一步的输入要求。

y可迭代对象，默认值=None

训练目标。必须满足管道所有步骤的标签要求。

**paramsstr 到对象的字典

• 如果 enable_metadata_routing=False（默认）：传递给每个步骤的 fit 方法的参数，其中每个参数名称都带有前缀，步骤 s 的参数 p 的键为 s__p。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

1.4 版本中的更改： 如果请求，并且通过 set_config 设置了 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

返回值：

self对象

具有已拟合步骤的管道。

fit_predict(X, y=None, **params)

转换数据，并使用最终估计器应用 fit_predict。

调用管道中每个转换器的 fit_transform。转换后的数据最终传递给调用 fit_predict 方法的最终估计器。只有最终估计器实现 fit_predict 时才有效。

参数：

X可迭代对象

训练数据。必须满足管道第一步的输入要求。

y可迭代对象，默认值=None

训练目标。必须满足管道所有步骤的标签要求。

**paramsstr 到对象的字典

• 如果 enable_metadata_routing=False（默认）：传递给在管道中所有转换结束后调用的 predict 的参数。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

0.20 版本中新增。

1.4 版本中的更改： 如果请求，并且 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

请注意，虽然这可用于使用 return_std 或 return_cov 从某些模型返回不确定性，但管道中转换生成的不确定性不会传播到最终估计器。

返回值：

y_predndarray

最终估计器调用 fit_predict 的结果。

fit_transform(X, y=None, **params)

拟合模型并使用最终估计器进行转换。

依次拟合所有转换器并依次转换数据。只有最终估计器实现 fit_transform 或 fit 和 transform 时才有效。

参数：

X可迭代对象

训练数据。必须满足管道第一步的输入要求。

y可迭代对象，默认值=None

训练目标。必须满足管道所有步骤的标签要求。

**paramsstr 到对象的字典

• 如果 enable_metadata_routing=False（默认）：传递给每个步骤的 fit 方法的参数，其中每个参数名称都带有前缀，步骤 s 的参数 p 的键为 s__p。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

1.4 版本中的更改： 如果请求，并且 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

返回值：

Xt形状为 (n_samples, n_transformed_features) 的 ndarray

转换后的样本。

get_feature_names_out(input_features=None)

获取转换的输出特征名称。

使用管道转换输入特征。

参数：

input_features字符串数组或 None，默认值=None

输入特征。

返回值：

feature_names_out字符串对象的 ndarray

转换后的特征名称。

get_metadata_routing()

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

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

返回值：

routingMetadataRouter

一个 MetadataRouter，封装了路由信息。

get_params(deep=True)

获取此估计器的参数。

返回构造函数中给定的参数以及Pipeline 的steps中包含的估计器。

参数：

deepbool, default=True

如果为 True，则将返回此估计器以及包含的作为估计器的子对象的参数。

返回值：

paramsstring 到 any 的映射

参数名称与其值的映射。

inverse_transform(X=None, *, Xt=None, **params)

反向应用每个步骤的inverse_transform。

管道中的所有估计器都必须支持inverse_transform。

参数：

X形状为 (n_samples, n_transformed_features) 的类数组

数据样本，其中n_samples是样本数，n_features是特征数。必须满足管道inverse_transform方法的最后一步的输入要求。

Xt形状为 (n_samples, n_transformed_features) 的类数组

数据样本，其中n_samples是样本数，n_features是特征数。必须满足管道inverse_transform方法的最后一步的输入要求。

自版本 1.5 起已弃用: Xt 在 1.5 中已弃用，并将在 1.7 中移除。请改用 X。

**paramsstr 到对象的字典

步骤请求并接受的参数。每个步骤都必须请求某些元数据，才能将其转发给它们。

1.4版本新增： 仅当enable_metadata_routing=True时才可用。更多详情请见元数据路由用户指南。

返回值：

Xt形状为 (n_samples, n_features) 的ndarray

逆变换后的数据，即原始特征空间中的数据。

property n_features_in_

在第一步fit方法期间看到的特征数量。

property named_steps

按名称访问步骤。

只读属性，用于通过给定名称访问任何步骤。键是步骤名称，值是步骤对象。

predict(X, **params)

转换数据，并使用最终估计器应用predict。

调用管道中每个转换器的transform。转换后的数据最终传递给调用predict方法的最终估计器。只有在最终估计器实现predict时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

**paramsstr 到对象的字典

• 如果 enable_metadata_routing=False（默认）：传递给在管道中所有转换结束后调用的 predict 的参数。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

0.20 版本中新增。

1.4 版本中的更改： 如果请求，并且通过 set_config 设置了 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

请注意，虽然这可用于使用 return_std 或 return_cov 从某些模型返回不确定性，但管道中转换生成的不确定性不会传播到最终估计器。

返回值：

y_predndarray

调用最终估计器的predict的结果。

predict_log_proba(X, **params)

转换数据，并使用最终估计器应用predict_log_proba。

调用管道中每个转换器的transform。转换后的数据最终传递给调用predict_log_proba方法的最终估计器。只有在最终估计器实现predict_log_proba时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

**paramsstr 到对象的字典

• 如果enable_metadata_routing=False（默认值）：参数传递给在管道中所有转换结束时调用的predict_log_proba。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

0.20 版本中新增。

1.4 版本中的更改： 如果请求，并且 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

返回值：

y_log_proba形状为 (n_samples, n_classes) 的ndarray

调用最终估计器的predict_log_proba的结果。

predict_proba(X, **params)

转换数据，并使用最终估计器应用predict_proba。

调用管道中每个转换器的transform。转换后的数据最终传递给调用predict_proba方法的最终估计器。只有在最终估计器实现predict_proba时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

**paramsstr 到对象的字典

• 如果enable_metadata_routing=False（默认值）：参数传递给在管道中所有转换结束时调用的predict_proba。

• 如果 enable_metadata_routing=True：步骤请求并接受的参数。每个步骤必须已请求某些元数据才能将这些参数转发给他们。

0.20 版本中新增。

1.4 版本中的更改： 如果请求，并且 enable_metadata_routing=True，则参数现在也会传递给中间步骤的 transform 方法。

更多详情请参见 元数据路由用户指南。

返回值：

y_proba形状为 (n_samples, n_classes) 的ndarray

调用最终估计器的predict_proba的结果。

score(X, y=None, sample_weight=None, **params)

转换数据，并使用最终估计器应用score。

调用管道中每个转换器的transform方法。转换后的数据最终传递给调用score方法的最终估计器。只有在最终估计器实现score方法时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

y可迭代对象，默认值=None

用于评分的目标值。必须满足管道所有步骤的标签要求。

sample_weight类数组，默认为None

如果非None，则此参数将作为sample_weight关键字参数传递给最终估计器的score方法。

**paramsstr 到对象的字典

步骤请求并接受的参数。每个步骤都必须请求某些元数据，才能将其转发给它们。

1.4版本新增： 仅当enable_metadata_routing=True时才可用。更多详情请见元数据路由用户指南。

返回值：

score浮点数

在最终估计器上调用score的结果。

score_samples(X)

转换数据，并使用最终估计器应用score_samples。

调用管道中每个转换器的transform方法。转换后的数据最终传递给调用score_samples方法的最终估计器。只有在最终估计器实现score_samples方法时才有效。

参数：

X可迭代对象

要预测的数据。必须满足流水线第一步的输入要求。

返回值：

y_score形状为(n_samples,)的ndarray

在最终估计器上调用score_samples的结果。

set_output(*, transform=None)

设置调用"transform"和"fit_transform"时的输出容器。

调用set_output将设置steps中所有估计器的输出。

参数：

transform{"default", "pandas", "polars"}，默认为None

配置transform和fit_transform的输出。

• "default"：转换器的默认输出格式

• "pandas"：DataFrame 输出

• "polars"：Polars 输出

• None：转换配置保持不变

1.4版本新增："polars"选项已添加。

返回值：

self估计器实例

估计器实例。

set_params(**kwargs)

设置此估计器的参数。

可以使用get_params()列出有效的参数键。请注意，您可以直接设置steps中包含的估计器的参数。

参数：

**kwargs字典

此估计器的参数或steps中包含的估计器的参数。步骤的参数可以使用其名称和参数名称（用“__”分隔）来设置。

返回值：

self对象

管道类实例。

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → Pipeline

请求传递给score方法的元数据。

请注意，只有在enable_metadata_routing=True时（参见sklearn.set_config）此方法才相关。请参阅用户指南，了解路由机制的工作原理。

每个参数的选项为

• True：请求元数据，如果提供则传递给score。如果未提供元数据，则忽略请求。

• False：不请求元数据，元估计器不会将其传递给score。

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

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

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

1.3版本中添加。

注意

只有当此估计器用作元估计器的子估计器时（例如，在Pipeline中使用），此方法才相关。否则，它无效。

参数：

sample_weightstr、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED

score中sample_weight参数的元数据路由。

返回值：

self对象

更新后的对象。

transform(X, **params)

转换数据，并使用最终估计器应用transform。

调用管道中每个转换器的transform。转换后的数据最终传递给调用transform方法的最终估计器。只有当最终估计器实现transform时才有效。

当最终估计器为None时，这也适用，在这种情况下，将应用所有先前的转换。

参数：

X可迭代对象

要转换的数据。必须满足管道第一步的输入要求。

**paramsstr 到对象的字典

步骤请求并接受的参数。每个步骤都必须请求某些元数据，才能将其转发给它们。

1.4版本新增： 仅当enable_metadata_routing=True时才可用。更多详情请见元数据路由用户指南。

返回值：

Xt形状为 (n_samples, n_transformed_features) 的 ndarray

转换后的数据。

图库示例

特征聚合与单变量选择

特征聚合与单变量选择

管道 ANOVA SVM

管道 ANOVA SVM

递归特征消除

递归特征消除

泊松回归和非正态损失

泊松回归和非正态损失

置换重要性与随机森林特征重要性 (MDI)

置换重要性与随机森林特征重要性 (MDI)

显示管道

显示管道

RBF 核的显式特征映射近似

RBF 核的显式特征映射近似

平衡模型复杂度和交叉验证得分

平衡模型复杂度和交叉验证得分

文本特征提取和评估的示例管道

文本特征提取和评估的示例管道

欠拟合与过拟合

欠拟合与过拟合

缓存最近邻

缓存最近邻

比较使用和不使用邻域成分分析的最近邻

比较使用和不使用邻域成分分析的最近邻

最近邻分类

最近邻分类

用于数字分类的受限玻尔兹曼机特征

用于数字分类的受限玻尔兹曼机特征

具有异构数据源的列转换器

具有异构数据源的列转换器

具有混合类型的列转换器

具有混合类型的列转换器

连接多个特征提取方法

连接多个特征提取方法

管道：连接 PCA 和逻辑回归

管道：连接 PCA 和逻辑回归

使用 Pipeline 和 GridSearchCV 选择降维

使用 Pipeline 和 GridSearchCV 选择降维

目标编码器的内部交叉拟合

目标编码器的内部交叉拟合

文本数据集上的半监督分类

文本数据集上的半监督分类

SVM-Anova：具有单变量特征选择的 SVM

SVM-Anova：具有单变量特征选择的 SVM