目标变换回归器#

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

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

用于对回归问题中的目标变量y应用非线性变换。此变换可以作为转换器给出,例如QuantileTransformer,也可以作为函数及其逆函数给出,例如np.lognp.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))

更多信息请阅读用户指南

0.20 版本新增。

参数:
regressor对象,默认为 None

回归器对象,例如派生自RegressorMixin。此回归器在每次拟合之前都会自动克隆。如果regressor is None,则创建并使用LinearRegression

transformer对象,默认为 None

估计器对象,例如派生自TransformerMixin。不能与funcinverse_func同时设置。如果transformer is None以及funcinverse_func,则转换器将是恒等转换器。请注意,转换器将在拟合期间被克隆。此外,转换器将y限制为NumPy数组。

func函数,默认为 None

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

inverse_func函数,默认为 None

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

check_inverse布尔值,默认为 True

是否检查transform后跟inverse_transformfunc后跟inverse_func是否导致原始目标值。

属性:
regressor_对象

拟合后的回归器。

transformer_对象

fitpredict中使用的转换器。

n_features_in_整数

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

feature_names_in_形状为 (n_features_in_,) 的 ndarray

拟合期间看到的特征名称。仅当X具有全是字符串的特征名称时才定义。

1.0 版本新增。

另请参见

sklearn.preprocessing.FunctionTransformer

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

注释

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

示例

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

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

参数:
X形状为 (n_samples, n_features) 的 {数组型、稀疏矩阵}

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

y形状为 (n_samples,) 的数组型

目标值。

**fit_params字典
  • 如果enable_metadata_routing=False(默认):直接传递给底层回归器的fit方法的参数。

  • 如果enable_metadata_routing=True:安全地路由到底层回归器的fit方法的参数。

1.6 版本中已更改:有关更多详细信息,请参阅元数据路由用户指南

返回值:
self对象

拟合后的估计器。

get_metadata_routing()[source]#

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

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

1.6 版本新增。

返回值:
routingMetadataRouter

一个MetadataRouter,封装了路由信息。

get_params(deep=True)[source]#

获取此估计器的参数。

参数:
deepbool,默认为 True

如果为 True,则将返回此估计器和包含的子对象(这些子对象是估计器)的参数。

返回值:
paramsdict

参数名称与其值的映射。

property n_features_in_#

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

predict(X, **predict_params)[source]#

使用基础回归器进行预测,并应用反向变换。

使用回归器进行预测,并在返回预测结果之前应用inverse_funcinverse_transform

参数:
X形状为 (n_samples, n_features) 的 {数组型、稀疏矩阵}

样本。

**predict_paramsdict of str -> object
  • 如果enable_metadata_routing=False(默认):参数直接传递到基础回归器的predict方法。

  • 如果enable_metadata_routing=True:参数安全地路由到基础回归器的predict方法。

1.6 版本中已更改:有关更多详细信息,请参阅元数据路由用户指南

返回值:
y_hat形状为 (n_samples,) 的 ndarray

预测值。

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

样本权重。

返回值:
scorefloat

self.predict(X)关于y\(R^2\)

注释

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

set_params(**params)[source]#

设置此估计器的参数。

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

参数:
**paramsdict

估计器参数。

返回值:
self估计器实例

估计器实例。

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

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

scoresample_weight参数的元数据路由。

返回值:
self对象

更新后的对象。