PLSCanonical

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

偏最小平方Transformer和回归器。

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

阅读更多的 User Guide .

Added in version 0.8.

参数:

n_componentsint，默认=2

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

scale布尔，默认=True

是否扩大规模 X 和 Y .

algorithm请输入'nipals'，'svd'}，default ='nipals'

该算法用于估计互协方差矩阵的第一奇异载体。“nipals”使用乘方法，而“svd”将计算整个MVD。

max_iterint，默认=500

当时，乘方法的最大迭代次数 algorithm='nipals' .否则被忽视了。

tol浮点数，默认值= 1 e-06

在乘方法中用作收敛标准的容差：每当的平方模达到时，算法就会停止 u_i - u_{i-1} 小于 tol ，在哪里 u 对应于左奇异载体。

copy布尔，默认=True

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

属性:

x_weights_形状的nd数组（n_features，n_components）

每次迭代的互协方差矩阵的左奇异载体。

y_weights_形状的nd数组（n_目标，n_组件）

每次迭代的互协方差矩阵的右奇异载体。

x_loadings_形状的nd数组（n_features，n_components）

的装载量 X .

y_loadings_形状的nd数组（n_目标，n_组件）

的装载量 Y .

x_rotations_形状的nd数组（n_features，n_components）

用于变换的投影矩阵 X .

y_rotations_形状的nd数组（n_目标，n_组件）

用于变换的投影矩阵 Y .

coef_形状的nd数组（n_targets，n_features）

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

intercept_ndarray of shape (n_targets,)

线性模型的截取， Y 近似为 Y = X @ coef_.T + intercept_ .

Added in version 1.1.

n_iter_形状列表（n_components，）

每个组件的乘势方法迭代次数。空如果 algorithm='svd' .

n_features_in_int

期间看到的功能数量 fit .

feature_names_in_ ：nd形状数组 (n_features_in_ ,)nd数组形状（

Names of features seen during fit. Defined only when X has feature names that are all strings.

Added in version 1.0.

参见

CCA

典型相关分析。

PLSSVD

部分最小平方奇异值。

示例

>>> 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=None, Y=None)

将模型与数据匹配。

参数:

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)

学习并应用火车数据的降维。

参数:

X形状类似阵列（n_samples，n_features）

训练载体，在哪里 n_samples 是样本数量和 n_features 是预测因子的数量。

y形状类似阵列（n_samples，n_targets），默认=无

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

返回:

self形状的nd数组（n_samples，n_components）

返回 x_scores 如果 Y 没有给出， (x_scores, y_scores) 否则。

get_feature_names_out(input_features=None)

获取用于转换的输出要素名称。

输出的功能名称将以大写的类别名称为开头。例如，如果Transformer输出3个特征，则输出的特征名称为： ["class_name0", "class_name1", "class_name2"] .

参数:

input_features字符串或无的类数组，默认=无

仅用于通过中看到的名称验证要素名称 fit .

返回:

feature_names_out字符串对象的nd数组

转换的功能名称。

get_metadata_routing()

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

请检查 User Guide 关于路由机制如何工作。

返回:

routingMetadataRequest

A MetadataRequest 封装路由信息。

get_params(deep=True)

获取此估计器的参数。

参数:

deep布尔，默认=True

如果为True，将返回此估计量和包含的作为估计量的子对象的参数。

返回:

paramsdict

参数名称映射到其值。

inverse_transform(X, y=None, Y=None)

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

参数:

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形状的nd数组（n_samples，n_features）

归还重建的 X 数据

y_reconstructed形状的nd数组（n_samples，n_targets）

归还重建的 X 目标只有当 y 给出了

注意到

只有在以下情况下，这种转换才是准确的 n_components=n_features .

predict(X, copy=True)

预测给定样本的目标。

参数:

X形状类似阵列（n_samples，n_features）

样品

copy布尔，默认=True

是否复制 X 和 Y ，或执行就地规范化。

返回:

y_pred形状的nd数组（n_samples，）或（n_samples，n_targets）

返回预测值。

注意到

这个调用需要估计一个形状矩阵 (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）

Test samples. For some estimators this may be a precomputed kernel matrix or a list of generic objects instead with shape (n_samples, n_samples_fitted), where n_samples_fitted is the number of samples used in the fitting for the estimator.

y形状的类似阵列（n_samples，）或（n_samples，n_outputs）

真正的价值观 X .

sample_weight形状类似数组（n_samples，），默认=无

样本重量。

返回:

score浮子

\(R^2\) 的 self.predict(X) w.r.t. y .

注意到

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

set_output(*, transform=None)

设置输出容器。

看到 介绍 set_output API 了解如何使用API的示例。

参数:

transform{“默认”，“pandas”，“polars”}，默认=无

配置输出 transform 和 fit_transform .

• "default" ：Transformer的默认输出格式

• "pandas" ：DataFrame输出

• "polars" ：两极输出

• None ：转换配置不变

Added in version 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 ).请参阅 User Guide 关于路由机制如何工作。

The options for each parameter are:

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

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

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

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

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

Added in version 1.3.

备注

只有当该估计器用作元估计器的子估计器时，该方法才相关，例如在 Pipeline .否则就没有效果了。

参数:

copy字符串、真、假或无， 默认=sklearn.utils. metalics_Routing.UNChanged

元数据路由 copy 参数 predict .

返回:

self对象

更新的对象。

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

请求元数据传递给 score 法

请注意，此方法仅适用于以下情况 enable_metadata_routing=True （见 sklearn.set_config ).请参阅 User Guide 关于路由机制如何工作。

The options for each parameter are:

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

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

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

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

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

Added in version 1.3.

备注

只有当该估计器用作元估计器的子估计器时，该方法才相关，例如在 Pipeline .否则就没有效果了。

参数:

sample_weight字符串、真、假或无， 默认=sklearn.utils. metalics_Routing.UNChanged

元数据路由 sample_weight 参数 score .

返回:

self对象

更新的对象。

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

请求元数据传递给 transform 法

请注意，此方法仅适用于以下情况 enable_metadata_routing=True （见 sklearn.set_config ).请参阅 User Guide 关于路由机制如何工作。

The options for each parameter are:

• True ：元数据被请求并传递给 transform 如果提供的话。如果未提供元数据，则会忽略请求。

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

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

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

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

Added in version 1.3.

备注

只有当该估计器用作元估计器的子估计器时，该方法才相关，例如在 Pipeline .否则就没有效果了。

参数:

copy字符串、真、假或无， 默认=sklearn.utils. metalics_Routing.UNChanged

元数据路由 copy 参数 transform .

返回:

self对象

更新的对象。

transform(X, y=None, Y=None, copy=True)

应用降维。

参数:

X形状类似阵列（n_samples，n_features）

要转化的样本。

y形状类似阵列（n_samples，n_targets），默认=无

目标载体。

Y形状类似阵列（n_samples，n_targets），默认=无

目标载体。

自 1.5 版本弃用: Y 在1.5中已废弃，并将在1.7中删除。使用 y 而不是.

copy布尔，默认=True

是否复制 X 和 Y ，或执行就地规范化。

返回:

x_scores, y_scores类数组或类数组元组

返回 x_scores 如果 Y 没有给出， (x_scores, y_scores) 否则。