TransformedTargetRegressor#

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

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

适用于在回归问题中对目标 y 应用非线性变换。此变换可以作为 Transformer(例如 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 None,则创建并使用 LinearRegression

transformer对象, 默认=None

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

func函数, 默认=None

在传递给 fit 之前应用于 y 的函数。不能与 transformer 同时设置。如果 func 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]#

获取此估计器的参数。

参数:
deep布尔值, 默认=True

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

返回:
params字典

参数名称及其对应的值。

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

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

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

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

样本。

**predict_paramsstr -> 对象字典
  • 如果 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

样本权重。

返回:
score浮点数

相对于 yself.predict(X)\(R^2\) 值。

备注

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

set_params(**params)[source]#

设置此估计器的参数。

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

参数:
**params字典

估计器参数。

返回:
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_weight字符串、True、False 或 None, 默认=sklearn.utils.metadata_routing.UNCHANGED

score 方法中 sample_weight 参数的元数据路由。

返回:
self对象

已更新的对象。