偏最小二乘回归#

class sklearn.cross_decomposition.PLSRegression(n_components=2, *, scale=True, max_iter=500, tol=1e-06, copy=True)[source]#

偏最小二乘回归。

偏最小二乘回归也称为PLS2或PLS1，具体取决于目标变量的数量。

有关其他交叉分解算法的比较，请参阅 比较交叉分解方法。

在 用户指南 中了解更多信息。

版本 0.8 中新增。

参数：
n_componentsint，默认值=2

要保留的成分数量。应在 [1, n_features] 范围内。

scalebool，默认值=True

是否缩放 X 和 Y。

max_iterint，默认值=500

当 algorithm='nipals' 时，幂方法的最大迭代次数。否则忽略。

tolfloat，默认值=1e-06

用作幂方法收敛标准的容差：当 u_i - u_{i-1} 的平方范数小于 tol 时，算法停止，其中 u对应于左奇异向量。

copybool，默认值=True

是否在应用居中和潜在缩放之前复制 fit 中的 X 和 Y。如果为 False，则这些操作将就地进行，修改这两个数组。

属性：
x_weights_形状为 (n_features, n_components) 的ndarray

每次迭代的交叉协方差矩阵的左奇异向量。

y_weights_形状为 (n_targets, n_components) 的ndarray

每次迭代的交叉协方差矩阵的右奇异向量。

x_loadings_形状为 (n_features, n_components) 的ndarray

X 的载荷。

y_loadings_形状为 (n_targets, n_components) 的ndarray

Y 的载荷。

x_scores_形状为 (n_samples, n_components) 的ndarray

变换后的训练样本。

y_scores_形状为 (n_samples, n_components) 的ndarray

变换后的训练目标。

x_rotations_形状为 (n_features, n_components) 的ndarray

用于变换 X 的投影矩阵。

y_rotations_形状为 (n_targets, n_components) 的ndarray

用于变换 Y 的投影矩阵。

coef_形状为 (n_target, n_features) 的ndarray

线性模型的系数，使得 Y 近似为 Y = X @ coef_.T + intercept_。

intercept_形状为 (n_targets,) 的ndarray

线性模型的截距，使得 Y 近似为 Y = X @ coef_.T + intercept_。

版本 1.1 中新增。

n_iter_形状为 (n_components,) 的列表

每个成分的幂方法迭代次数。

n_features_in_int

在 fit 期间看到的特征数量。

feature_names_in_形状为 (n_features_in_,) 的ndarray

在 fit 期间看到的特征名称。仅当 X 的特征名称全部为字符串时才定义。

版本 1.0 中新增。

另请参见

PLSCanonical

偏最小二乘变换器和回归器。

示例

>>> from sklearn.cross_decomposition import PLSRegression
>>> X = [[0., 0., 1.], [1.,0.,0.], [2.,2.,2.], [2.,5.,4.]]
>>> y = [[0.1, -0.2], [0.9, 1.1], [6.2, 5.9], [11.9, 12.3]]
>>> pls2 = PLSRegression(n_components=2)
>>> pls2.fit(X, y)
PLSRegression()
>>> Y_pred = pls2.predict(X)

有关偏最小二乘回归和 PCA 的比较，请参阅 主成分回归与偏最小二乘回归。

fit(X, y=None, Y=None)[source]#

将模型拟合到数据。

参数：
X形状为 (n_samples, n_features) 的类数组

训练向量，其中 n_samples 是样本数，n_features 是预测变量的数量。

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

目标向量，其中 n_samples 是样本数，n_targets 是响应变量的数量。

Y形状为 (n_samples,) 或 (n_samples, n_targets) 的类数组

目标向量，其中 n_samples 是样本数，n_targets 是响应变量的数量。

自版本 1.5 起已弃用： Y 在 1.5 中已弃用，并将在 1.7 中移除。请改用 y。

返回：
self对象

拟合后的模型。

fit_transform(X, y=None)[source]#

学习并在训练数据上应用降维。

参数：
X形状为 (n_samples, n_features) 的类数组

训练向量，其中 n_samples 是样本数，n_features 是预测变量的数量。

y形状为 (n_samples, n_targets) 的类数组，默认值为 None

目标向量，其中 n_samples 是样本数，n_targets 是响应变量的数量。

返回：
self形状为 (n_samples, n_components) 的ndarray

如果未提供Y，则返回x_scores；否则返回(x_scores, y_scores)。

get_feature_names_out(input_features=None)[source]#

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

输出特征名称将以小写的类名作为前缀。例如，如果转换器输出3个特征，则输出的特征名称为：["class_name0", "class_name1", "class_name2"]。

参数：
input_features类数组的字符串或None，默认为None

仅用于使用在fit中看到的名称验证特征名称。

返回：
feature_names_out字符串对象的ndarray

转换后的特征名称。

get_metadata_routing()[source]#

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

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

返回：
routingMetadataRequest

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

get_params(deep=True)[source]#

获取此估计器的参数。

参数：
deep布尔值，默认为True

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

返回：
params字典

参数名称与其值的映射。

inverse_transform(X, y=None, Y=None)[source]#

将数据转换回其原始空间。

参数：
X形状为(n_samples, n_components)的类数组

新数据，其中n_samples是样本数，n_components是PLS成分的数量。

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

新的目标，其中n_samples是样本数，n_components是PLS成分的数量。

Y形状为(n_samples, n_components)的类数组

新的目标，其中n_samples是样本数，n_components是PLS成分的数量。

自版本 1.5 起已弃用： Y 在 1.5 中已弃用，并将在 1.7 中移除。请改用 y。

返回：
X_reconstructed形状为(n_samples, n_features)的ndarray

返回重建的X数据。

y_reconstructed形状为(n_samples, n_targets)的ndarray

返回重建的X目标。仅当提供y时返回。

备注

只有当n_components=n_features时，此转换才是精确的。

predict(X, copy=True)[source]#

预测给定样本的目标值。

参数：
X形状为 (n_samples, n_features) 的类数组

样本。

copybool，默认值=True

是否复制X和Y，或者执行就地归一化。

返回：
y_pred形状为(n_samples,)或(n_samples, n_targets)的ndarray

返回预测值。

备注

此调用需要估计形状为(n_features, n_targets)的矩阵，这在高维空间中可能是一个问题。

score(X, y, sample_weight=None)[source]#

返回预测的决定系数。

决定系数\(R^2\)定义为\((1 - \frac{u}{v})\)，其中\(u\)是残差平方和((y_true - y_pred)** 2).sum()，\(v\)是总平方和((y_true - y_true.mean()) ** 2).sum()。最佳分数为1.0，它可以为负数（因为模型可以任意差）。一个始终预测y期望值的常数模型，忽略输入特征，其\(R^2\)分数为0.0。

参数：
X形状为 (n_samples, n_features) 的类数组

测试样本。对于某些估计器，这可能是预先计算的核矩阵或形状为(n_samples, n_samples_fitted)的泛型对象列表，其中n_samples_fitted是估计器拟合中使用的样本数。

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

X 的真值。

sample_weightarray-like of shape (n_samples,), default=None

样本权重。

返回：
scorefloat

self.predict(X) 关于 y 的 \(R^2\)。

备注

从 0.23 版本开始，调用回归器的 score 方法时使用的 \(R^2\) 分数使用 multioutput='uniform_average'，以保持与 r2_score 的默认值一致。这会影响所有多输出回归器的 score 方法（MultiOutputRegressor 除外）。

set_output(*, transform=None)[source]#

设置输出容器。

参见 Introducing the set_output API，了解如何使用此 API 的示例。

参数：
transform{“default”, “pandas”, “polars”}, default=None

配置 transform 和 fit_transform 的输出。

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

  • "pandas"：DataFrame 输出

  • "polars"：Polars 输出

  • None：转换配置保持不变

Added in version 1.4: 添加了 "polars" 选项。

返回：
selfestimator instance

估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

此方法适用于简单的估计器以及嵌套对象（例如 Pipeline）。后者具有 <component>__<parameter> 形式的参数，因此可以更新嵌套对象的每个组件。

参数：
**paramsdict

估计器参数。

返回：
selfestimator instance

估计器实例。

set_predict_request(*, copy: bool | None | str = '$UNCHANGED$') → PLSRegression[source]#

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

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

每个参数的选项为

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

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

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

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

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

1.3 版中新增。

注意

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

参数：
copystr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

predict 中 copy 参数的元数据路由。

返回：
self对象

更新后的对象。

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → PLSRegression[source]#

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

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

每个参数的选项为

  • 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对象

更新后的对象。

set_transform_request(*, copy: bool | None | str = '$UNCHANGED$') → PLSRegression[source]#

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

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

每个参数的选项为

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

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

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

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

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

1.3 版中新增。

注意

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

参数：
copystr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

transform 方法中 copy 参数的元数据路由。

返回：
self对象

更新后的对象。

transform(X, y=None, Y=None, copy=True)[source]#

应用降维。

参数：
X形状为 (n_samples, n_features) 的类数组

要转换的样本。

y形状为 (n_samples, n_targets) 的类数组，默认值为 None

目标向量。

Y形状为 (n_samples, n_targets) 的类数组，默认值=None

目标向量。

自版本 1.5 起已弃用： Y 在 1.5 中已弃用，并将在 1.7 中移除。请改用 y。

copybool，默认值=True

是否复制X和Y，或者执行就地归一化。

返回：
x_scores, y_scores类数组或类数组元组

如果未提供Y，则返回x_scores；否则返回(x_scores, y_scores)。