TransformedTargetRegressor#

class sklearn.compose.TransformedTargetRegressor(regressor=None, *, transformer=None, func=None, inverse_func=None, check_inverse=True)#

元估计器用于对变换后的目标进行回归。

在回归问题中，对目标 y 应用非线性变换非常有用。这种变换可以是一个转换器，例如 QuantileTransformer ，或者是一个函数及其逆函数，例如 np.log 和 np.exp 。

在 fit 期间的计算如下:

regressor.fit(X, func(y))

或者:

regressor.fit(X, transformer.transform(y))

在 predict 期间的计算如下:

inverse_func(regressor.predict(X))

或者:

transformer.inverse_transform(regressor.predict(X))

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

Added in version 0.20.

Parameters:
regressorobject, default=None

回归器对象，例如继承自 RegressorMixin 。该回归器在每次拟合之前会自动克隆。如果 regressor 为 None ，则创建并使用 LinearRegression 。

transformerobject, default=None

估计器对象，例如继承自 TransformerMixin 。不能与 func 和 inverse_func 同时设置。如果 transformer 为 None 以及 func 和 inverse_func ，则转换器将是一个恒等转换器。注意，转换器将在拟合期间被克隆。此外，转换器限制 y 为 numpy 数组。

funcfunction, default=None

在传递给 fit 之前应用于 y 的函数。不能与 transformer 同时设置。如果 func 为 None ，则使用的函数将是恒等函数。如果设置了 func ，则还需要提供 inverse_func 。该函数需要返回一个二维数组。

inverse_funcfunction, default=None

应用于回归器预测结果的函数。不能与 transformer 同时设置。逆函数用于将预测结果返回到原始训练标签的同一空间。如果设置了 inverse_func ，则还需要提供 func 。逆函数需要返回一个二维数组。

check_inversebool, default=True

是否检查 transform 后跟 inverse_transform 或 func 后跟 inverse_func 是否会导致原始目标。

Attributes:
regressor_object

拟合的回归器。

transformer_object

在 fit 和 predict 中使用的转换器。

n_features_in_int

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

feature_names_in_ndarray of shape ( n_features_in_ ,)

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

Added in version 1.0.

See also

sklearn.preprocessing.FunctionTransformer

从任意可调用对象构造转换器。

Notes

在内部，目标 y 总是被转换为二维数组以供 scikit-learn 转换器使用。在预测时，输出将被重塑为与 y 具有相同数量的维度。

Examples

>>> import numpy as np
>>> from sklearn.linear_model import LinearRegression
>>> from sklearn.compose import TransformedTargetRegressor
>>> tt = TransformedTargetRegressor(regressor=LinearRegression(),
...                                 func=np.log, inverse_func=np.exp)
>>> X = np.arange(4).reshape(-1, 1)
>>> y = np.exp(2 * X).ravel()
>>> tt.fit(X, y)
TransformedTargetRegressor(...)
>>> tt.score(X, y)
1.0
>>> tt.regressor_.coef_
array([2.])

有关更详细的示例用例，请参阅 转换回归模型中的目标变量的效果 。

fit(X, y, **fit_params)#

拟合模型根据给定的训练数据。

Parameters:
X{array-like, sparse matrix} 形状为 (n_samples, n_features)

训练向量，其中 n_samples 是样本的数量， n_features 是特征的数量。

y形状为 (n_samples,) 的 array-like

目标值。

**fit_paramsdict

  • 如果 enable_metadata_routing=False （默认）：

    直接传递给底层回归器 fit 方法的参数。

  • 如果 enable_metadata_routing=True ：

    安全路由到底层回归器 fit 方法的参数。

    Changed in version 1.6: 更多详情请参见 Metadata Routing User Guide 。

Returns:
selfobject

拟合的估计器。

get_metadata_routing()#

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

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

Added in version 1.6.

Returns:
routingMetadataRouter

MetadataRouter 封装的 路由信息。

get_params(deep=True)#

获取此估计器的参数。

Parameters:
deepbool, 默认=True

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

Returns:
paramsdict

参数名称映射到它们的值。

property n_features_in_#

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

predict(X, **predict_params)#

预测使用基础回归器，应用逆变换。

回归器用于预测，并且在返回预测结果之前应用 inverse_func 或 inverse_transform 。

Parameters:
X{array-like, sparse matrix}，形状为 (n_samples, n_features)

样本。

**predict_paramsdict of str -> object

  • 如果 enable_metadata_routing=False （默认）：

    直接传递给底层回归器 predict 方法的参数。

  • 如果 enable_metadata_routing=True ：

    安全路由到底层回归器 predict 方法的参数。

    Changed in version 1.6: 有关更多详细信息，请参阅 Metadata Routing User Guide 。

Returns:
y_hatndarray，形状为 (n_samples,)

预测值。

score(X, y, sample_weight=None)#

返回预测的决定系数。

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

Parameters:
Xarray-like of shape (n_samples, n_features)

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

yarray-like of shape (n_samples,) or (n_samples, n_outputs)

X 的真实值。

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

样本权重。

Returns:
scorefloat

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

Notes

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

set_params(**params)#

设置此估计器的参数。

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

Parameters:
**paramsdict

估计器参数。

Returns:
selfestimator instance

估计器实例。

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

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config ). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

  • True : metadata is requested, and passed to score if provided. The request is ignored if metadata is not provided.

  • False : metadata is not requested and the meta-estimator will not pass it to score .

  • None : metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str : metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default ( sklearn.utils.metadata_routing.UNCHANGED ) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline . Otherwise it has no effect.

Parameters:
sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for sample_weight parameter in score .

Returns:
selfobject

The updated object.

On this page
Show Source