CCA#

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

典型相关分析，也称为“B 模式”偏最小二乘。

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

在用户指南中阅读更多内容。

参数:
n_components整型，默认值为 2

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

scale布尔型，默认值为 True

是否缩放X和y。

max_iter整型，默认值为 500

幂方法的最大迭代次数。

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_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,) 的列表

每个组件的幂方法的迭代次数。

n_features_in_整型

fit期间看到的特征数量。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

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

版本 1.0 新增。

另请参见

PLSCanonical

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

PLSSVD

偏最小二乘奇异值分解。

示例

>>> from sklearn.cross_decomposition import CCA
>>> X = [[0., 0., 1.], [1.,0.,0.], [2.,2.,2.], [3.,5.,4.]]
>>> y = [[0.1, -0.2], [0.9, 1.1], [6.2, 5.9], [11.9, 12.3]]
>>> cca = CCA(n_components=1)
>>> cca.fit(X, y)
CCA(n_components=1)
>>> X_c, y_c = cca.transform(X, y)
fit(X, y)[source]#

将模型拟合到数据。

参数:
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)[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)[source]#

将数据逆变换回其原始空间。

参数:
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)[source]#

预测给定样本的目标。

参数:
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)[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的期望值而忽略输入特征的常数模型将获得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)[source]#

设置输出容器。

请参阅介绍 set_output API以获取如何使用该 API 的示例。

参数:
transform{"default", "pandas", "polars"}，默认值为 None

配置transform和fit_transform的输出。

  • "default": 变换器的默认输出格式

  • "pandas": DataFrame 输出

  • "polars": Polars 输出

  • None: 变换配置不变

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

返回:
self估计器实例

估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

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

参数:
**params字典

估计器参数。

返回:
self估计器实例

估计器实例。

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

请求传递给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$') → CCA[source]#

请求传递给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$') → CCA[source]#

请求传递给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对象

更新后的对象。

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

应用降维。

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

要转换的样本。

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

目标向量。

copy布尔型，默认值为 True

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

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

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