PLSCanonical#

class sklearn.cross_decomposition.PLSCanonical(n_components=2, *, scale=True, algorithm='nipals', max_iter=500, tol=1e-06, copy=True)[源]#

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

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

更多信息请参见用户指南。

0.8 版本新增。

参数:
n_componentsint, 默认=2

要保留的成分数量。应在[1, min(n_samples, n_features, n_targets)]范围内。

scalebool, 默认=True

是否对 X 和 y 进行缩放。

algorithm{‘nipals’, ‘svd’}, 默认=’nipals’

用于估计交叉协方差矩阵的第一个奇异向量的算法。'nipals' 使用幂法，而 'svd' 将计算完整的 SVD。

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_rotations_形状为 (n_features, n_components) 的 ndarray

用于变换 X 的投影矩阵。

y_rotations_形状为 (n_targets, n_components) 的 ndarray

用于变换 y 的投影矩阵。

coef_形状为 (n_targets, 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,) 的列表

幂法对每个成分的迭代次数。如果 algorithm='svd'，则为空。

n_features_in_int

拟合期间看到的特征数量。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

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

1.0 版本新增。

另请参见

CCA

典型相关分析。

PLSSVD

偏最小二乘 SVD。

示例

>>> from sklearn.cross_decomposition import PLSCanonical
>>> 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]]
>>> plsca = PLSCanonical(n_components=2)
>>> plsca.fit(X, y)
PLSCanonical()
>>> X_c, y_c = plsca.transform(X, y)
fit(X, y)[源]#

将模型拟合到数据。

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

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

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

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

返回:
selfobject

已拟合的模型。

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_featuresstr 或 None 的类数组, 默认=None

仅用于根据 fit 中看到的名称验证特征名称。

返回:
feature_names_outstr 对象 的 ndarray

变换后的特征名称。

get_metadata_routing()[源]#

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

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

返回:
routingMetadataRequest

一个封装路由信息的MetadataRequest对象。

get_params(deep=True)[源]#

获取此估计器的参数。

参数:
deepbool, 默认=True

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

返回:
paramsdict

参数名称映射到其值。

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) 的类数组

样本。

copybool, 默认=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 期望值而不考虑输入特征的常数模型，其 \(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_weight形状为 (n_samples,) 的类数组, 默认=None

样本权重。

返回:
scorefloat

self.predict(X) 相对于 y 的 \(R^2\) 值。

备注

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

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> 形式的参数，以便可以更新嵌套对象的每个组件。

参数:
**paramsdict

估计器参数。

返回:
self估计器实例

估计器实例。

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

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

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

每个参数的选项为

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

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

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

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

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

1.3 版本新增。

注意

此方法仅当此估计器用作元估计器的子估计器时才相关，例如在Pipeline内部使用时。否则，它没有效果。

参数:
copystr, True, False 或 None, 默认=sklearn.utils.metadata_routing.UNCHANGED

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

返回:
selfobject

更新后的对象。

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

请求传递给 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 参数的元数据路由。

返回:
selfobject

更新后的对象。

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

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

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

每个参数的选项为

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

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

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

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

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

1.3 版本新增。

注意

此方法仅当此估计器用作元估计器的子估计器时才相关，例如在Pipeline内部使用时。否则，它没有效果。

参数:
copystr, True, False 或 None, 默认=sklearn.utils.metadata_routing.UNCHANGED

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

返回:
selfobject

更新后的对象。

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

应用降维。

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

要变换的样本。

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

目标向量。

copybool, 默认=True

是否复制 X 和 y，或执行原地归一化。

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

如果未给出 y，则返回 x_scores，否则返回 (x_scores, y_scores)。