PLSRegression#
- class sklearn.cross_decomposition.PLSRegression(n_components=2, *, scale=True, max_iter=500, tol=1e-06, copy=True)[源码]#
PLS 回归。
PLSRegression 也被称为 PLS2 或 PLS1，具体取决于目标数量。
有关其他交叉分解算法的比较，请参见 比较交叉分解方法。
在 用户指南 中了解更多信息。
0.8 版本新增。
- 参数:
- n_components整型，默认值=2
要保留的组件数量。应在
[1, n_features]范围内。- scale布尔型，默认值=True
是否对
X和y进行缩放。- max_iter整型，默认值=500
当
algorithm='nipals'时，幂方法的最大迭代次数。否则忽略。- tol浮点型，默认值=1e-06
在幂方法中用作收敛准则的容差：当
u_i - u_{i-1}的平方范数小于tol时，算法停止，其中u对应于左奇异向量。- copy布尔型，默认值=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_整型
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)
有关 PLS 回归与
PCA的比较，请参见 主成分回归与偏最小二乘回归。- fit(X, y)[源码]#
将模型拟合到数据。
- 参数:
- X形状为 (n_samples, n_features) 的类数组对象
训练向量，其中
n_samples是样本数量，n_features是预测变量的数量。- y形状为 (n_samples,) 或 (n_samples, n_targets) 的类数组对象
目标向量，其中
n_samples是样本数量，n_targets是响应变量的数量。
- 返回:
- self对象
已拟合模型。
- fit_transform(X, y=None)[源码]#
学习并应用于训练数据的降维。
- 参数:
- 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)[源码]#
获取转换后的输出特征名称。
输出特征名称将以小写类名作为前缀。例如，如果转换器输出 3 个特征，则输出特征名称为：
["class_name0", "class_name1", "class_name2"]。- 参数:
- input_features字符串类数组对象或 None，默认值=None
仅用于与
fit中看到的名称验证特征名称。
- 返回:
- feature_names_out字符串对象 ndarray
转换后的特征名称。
- get_metadata_routing()[源码]#
获取此对象的元数据路由。
请查看 用户指南，了解路由机制的工作原理。
- 返回:
- routingMetadataRequest
一个封装路由信息的
MetadataRequest。
- get_params(deep=True)[源码]#
获取此估计器的参数。
- 参数:
- deep布尔型，默认值=True
如果为 True，将返回此估计器及其包含的作为估计器的子对象的参数。
- 返回:
- params字典
参数名称映射到其值。
- inverse_transform(X, y=None)[源码]#
将数据转换回其原始空间。
- 参数:
- X形状为 (n_samples, n_components) 的类数组对象
新数据，其中
n_samples是样本数量，n_components是 pls 组件的数量。- y形状为 (n_samples,) 或 (n_samples, n_components) 的类数组对象
新目标，其中
n_samples是样本数量，n_components是 pls 组件的数量。
- 返回:
- X_original形状为 (n_samples, n_features) 的 ndarray
返回重建的
X数据。- y_original形状为 (n_samples, n_targets) 的 ndarray
返回重建的
X目标。仅当给定y时返回。
注意
仅当
n_components=n_features时，此转换才是精确的。
- predict(X, copy=True)[源码]#
预测给定样本的目标。
- 参数:
- X形状为 (n_samples, n_features) 的类数组对象
样本。
- copy布尔型，默认值=True
是否复制
X或执行原地归一化。
- 返回:
- y_pred形状为 (n_samples,) 或 (n_samples, n_targets) 的 ndarray
返回预测值。
注意
此调用需要估计一个形状为
(n_features, n_targets)的矩阵，这在高维空间中可能会有问题。
- score(X, y, sample_weight=None)[源码]#
返回测试数据的 决定系数。
决定系数，\(R^2\)，定义为 \((1 - \frac{u}{v})\)，其中 \(u\) 是残差平方和
((y_true - y_pred)** 2).sum()，\(v\) 是总平方和((y_true - y_true.mean()) ** 2).sum()。最佳可能得分为 1.0，并且可能为负（因为模型可能任意差）。一个始终预测y期望值而不考虑输入特征的常数模型将得到 0.0 的 \(R^2\) 分数。- 参数:
- X形状为 (n_samples, n_features) 的类数组对象
测试样本。对于某些估计器，这可能是一个预计算的核矩阵或一个通用对象列表，形状为
(n_samples, n_samples_fitted)，其中n_samples_fitted是用于估计器拟合的样本数量。- y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象
X的真实值。- sample_weight形状为 (n_samples,) 的类数组对象，默认值=None
样本权重。
- 返回:
- score浮点型
self.predict(X)相对于y的 \(R^2\)。
注意
在调用回归器的
score方法时使用的 \(R^2\) 分数，从 0.23 版本开始使用multioutput='uniform_average'，以与r2_score的默认值保持一致。这影响了所有多输出回归器（除了MultiOutputRegressor）的score方法。
- set_output(*, transform=None)[源码]#
设置输出容器。
有关如何使用 API 的示例，请参见 set_output API 介绍。
- 参数:
- transform{"default", "pandas", "polars"} 之一，默认值=None
配置
transform和fit_transform的输出。"default": 变换器的默认输出格式"pandas": DataFrame 输出"polars": Polars 输出None: 转换配置未更改
1.4 版本新增: 添加了
"polars"选项。
- 返回:
- self估计器实例
估计器实例。
- set_params(**params)[源码]#
设置此估计器的参数。
此方法适用于简单估计器以及嵌套对象（例如
Pipeline）。后者具有<component>__<parameter>形式的参数，以便可以更新嵌套对象的每个组件。- 参数:
- **params字典
估计器参数。
- 返回:
- self估计器实例
估计器实例。
- set_predict_request(*, copy: bool | None | str = '$UNCHANGED$') → PLSRegression[源码]#
请求传递给
predict方法的元数据。请注意，此方法仅在
enable_metadata_routing=True时相关（参见sklearn.set_config）。请参见 用户指南 了解路由机制的工作原理。每个参数的选项为
True: 请求元数据，如果提供则传递给predict。如果未提供元数据，则请求被忽略。False: 不请求元数据，并且元估计器不会将其传递给predict。None: 不请求元数据，如果用户提供元数据，元估计器将引发错误。str: 元数据应使用此给定别名而非原始名称传递给元估计器。
默认值（
sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改某些参数的请求而不更改其他参数。1.3 版本新增。
注意
此方法仅在估计器用作元估计器的子估计器时相关，例如在
Pipeline内部使用时。否则它没有影响。- 参数:
- copy字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED
predict方法中copy参数的元数据路由。
- 返回:
- self对象
更新后的对象。
- set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → PLSRegression[源码]#
请求传递给
score方法的元数据。请注意，此方法仅在
enable_metadata_routing=True时相关（参见sklearn.set_config）。请参见 用户指南 了解路由机制的工作原理。每个参数的选项为
True: 请求元数据，如果提供则传递给score。如果未提供元数据，则请求被忽略。False: 不请求元数据，并且元估计器不会将其传递给score。None: 不请求元数据，如果用户提供元数据，元估计器将引发错误。str: 元数据应使用此给定别名而非原始名称传递给元估计器。
默认值（
sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改某些参数的请求而不更改其他参数。1.3 版本新增。
注意
此方法仅在估计器用作元估计器的子估计器时相关，例如在
Pipeline内部使用时。否则它没有影响。- 参数:
- sample_weight字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED
score方法中sample_weight参数的元数据路由。
- 返回:
- self对象
更新后的对象。
- set_transform_request(*, copy: bool | None | str = '$UNCHANGED$') → PLSRegression[源码]#
请求传递给
transform方法的元数据。请注意，此方法仅在
enable_metadata_routing=True时相关（参见sklearn.set_config）。请参见 用户指南 了解路由机制的工作原理。每个参数的选项为
True: 请求元数据，如果提供则传递给transform。如果未提供元数据，则请求被忽略。False: 不请求元数据，并且元估计器不会将其传递给transform。None: 不请求元数据，如果用户提供元数据，元估计器将引发错误。str: 元数据应使用此给定别名而非原始名称传递给元估计器。
默认值（
sklearn.utils.metadata_routing.UNCHANGED）保留现有请求。这允许您更改某些参数的请求而不更改其他参数。1.3 版本新增。
注意
此方法仅在估计器用作元估计器的子估计器时相关，例如在
Pipeline内部使用时。否则它没有影响。- 参数:
- copy字符串、True、False 或 None，默认值=sklearn.utils.metadata_routing.UNCHANGED
在
transform方法中copy参数的元数据路由。
- 返回:
- self对象
更新后的对象。
