TransformedTargetRegressor#
- class sklearn.compose.TransformedTargetRegressor(regressor=None, *, transformer=None, func=None, inverse_func=None, check_inverse=True)[source]#
用于对转换后的目标进行回归的元估算器。
在回归问题中,用于对目标变量
y应用非线性转换非常有用。此转换可以作为 Transformer(例如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))
在 用户指南 中阅读更多内容。
0.20 版本新增。
- 参数:
- regressorobject, default=None
回归器对象,例如派生自
RegressorMixin。在拟合之前,此回归器每次都会自动克隆。如果regressor is None,则创建并使用LinearRegression。- transformerobject, default=None
估计器对象,例如派生自
TransformerMixin。不能与func和inverse_func同时设置。如果transformer is None,并且func和inverse_func也为None,则转换器将为恒等转换器。请注意,转换器将在拟合期间克隆。此外,转换器将限制y为 numpy 数组。- funcfunction, default=None
在传递给
fit之前应用于y的函数。不能与transformer同时设置。如果func is None,则使用的函数将是恒等函数。如果设置了func,则也需要提供inverse_func。该函数需要返回一个 2 维数组。- inverse_funcfunction, default=None
应用于回归器预测的函数。不能与
transformer同时设置。逆函数用于将预测返回到原始训练标签的相同空间。如果设置了inverse_func,则也需要提供func。逆函数需要返回一个 2 维数组。- check_inversebool, default=True
是否检查
transform后跟inverse_transform,或func后跟inverse_func是否会恢复到原始目标。
- 属性:
另请参阅
sklearn.preprocessing.FunctionTransformer从任意可调用对象构造一个转换器。
注意事项
在内部,目标
y总是被转换为 2 维数组以供 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]#
根据给定的训练数据拟合模型。
- 参数:
- Xshape 为 (n_samples, n_features) 的 {array-like, sparse matrix}
训练向量,其中
n_samples是样本数,n_features是特征数。- yarray-like of shape (n_samples,)
目标值。
- **fit_paramsdict
如果
enable_metadata_routing=False(默认):直接传递给底层回归器的fit方法的参数。如果
enable_metadata_routing=True:安全路由到底层回归器的fit方法的参数。
版本 1.6 中有更改: 有关更多详细信息,请参阅 元数据路由用户指南。
- 返回:
- selfobject
拟合的估计器。
- get_metadata_routing()[source]#
获取此对象的元数据路由。
请查阅 用户指南,了解路由机制如何工作。
版本 1.6 中新增。
- 返回:
- routingMetadataRouter
封装路由信息的
MetadataRouter。
- get_params(deep=True)[source]#
获取此估计器的参数。
- 参数:
- deepbool, default=True
如果为 True,将返回此估计器以及包含的子对象(如果它们是估计器)的参数。
- 返回:
- paramsdict
参数名称映射到其值。
- predict(X, **predict_params)[source]#
使用基本回归器进行预测,并应用逆转换。
使用回归器进行预测,并在返回预测之前应用
inverse_func或inverse_transform。- 参数:
- Xshape 为 (n_samples, n_features) 的 {array-like, sparse matrix}
样本。
- **predict_paramsdict of str -> object
如果
enable_metadata_routing=False(默认):直接传递给底层回归器的predict方法的参数。如果
enable_metadata_routing=True:安全路由到底层回归器的predict方法的参数。
版本 1.6 中有更改: 有关更多详细信息,请参阅 元数据路由用户指南。
- 返回:
- y_hatndarray of shape (n_samples,)
预测值。
- 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期望值而不考虑输入特征的常数模型将获得 \(R^2\) 分数 0.0。- 参数:
- Xshape 为 (n_samples, n_features) 的 array-like
测试样本。对于某些估计器,这可能是一个预先计算的核矩阵或一个通用对象列表,形状为
(n_samples, n_samples_fitted),其中n_samples_fitted是用于估计器拟合的样本数。- yshape 为 (n_samples,) 或 (n_samples, n_outputs) 的 array-like
X的真实值。- sample_weightshape 为 (n_samples,) 的 array-like, default=None
样本权重。
- 返回:
- scorefloat
self.predict(X)相对于y的 \(R^2\)。
注意事项
从版本 0.23 开始,在对回归器调用
score时使用的 \(R^2\) 分数使用multioutput='uniform_average',以与r2_score的默认值保持一致。这会影响所有多输出回归器(除了MultiOutputRegressor)的score方法。
- set_params(**params)[source]#
设置此估计器的参数。
此方法适用于简单的估计器以及嵌套对象(如
Pipeline)。后者具有<component>__<parameter>形式的参数,以便可以更新嵌套对象的每个组件。- 参数:
- **paramsdict
估计器参数。
- 返回:
- selfestimator instance
估计器实例。
- 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 中新增。
- 参数:
- sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED
score方法中sample_weight参数的元数据路由。
- 返回:
- selfobject
更新后的对象。