等距回归#

class sklearn.isotonic.IsotonicRegression(*, y_min=None, y_max=None, increasing=True, out_of_bounds='nan')[source]#

等距回归模型。

更多信息请参见用户指南

版本0.13中新增。

参数:
y_minfloat, default=None

预测值的最小下界(最小值可能更高)。如果未设置,则默认为-inf。

y_maxfloat, default=None

预测值的最大上界(最大值可能更低)。如果未设置,则默认为+inf。

increasingbool or ‘auto’, default=True

确定预测值是否应受限于随着X的增加或减少而变化。“auto”将根据Spearman相关系数估计的符号决定。

out_of_bounds{‘nan’, ‘clip’, ‘raise’}, default=’nan’

处理在预测过程中如何处理训练域之外的X值。

  • ‘nan’,预测值为NaN。

  • ‘clip’,预测值将设置为对应于最近训练区间端点的值。

  • ‘raise’,将引发ValueError

属性:
X_min_float

输入数组X_的最小值,作为左边界。

X_max_float

输入数组X_的右边界最大值。

X_thresholds_形状为 (n_thresholds,) 的 ndarray

用于插值 y = f(X) 单调函数的唯一递增X值。

在 0.24 版本中添加。

y_thresholds_形状为 (n_thresholds,) 的 ndarray

适合插值 y = f(X) 单调函数的去重y值。

在 0.24 版本中添加。

f_函数

覆盖输入域X的分段线性插值函数。

increasing_布尔值

推断出的increasing值。

另请参见

sklearn.linear_model.LinearRegression

普通最小二乘线性回归。

sklearn.ensemble.HistGradientBoostingRegressor

梯度提升,这是一个接受单调性约束的非参数模型。

isotonic_regression

求解等调回归模型的函数。

备注

使用 de Leeuw, 1977 中的次要方法解决平局。

参考文献

等调中位数回归:一种线性规划方法 Nilotpal Chakravarti 数学运筹学 14 卷,第 2 期 (1989 年 5 月),第 303-308 页

R 中的等调优化:相邻违规者算法 (PAVA) 和活动集方法 de Leeuw, Hornik, Mair 统计软件杂志 2009

Kruskal 单调回归算法在存在平局情况下的正确性 de Leeuw, Psychometrica, 1977

示例

>>> from sklearn.datasets import make_regression
>>> from sklearn.isotonic import IsotonicRegression
>>> X, y = make_regression(n_samples=10, n_features=1, random_state=41)
>>> iso_reg = IsotonicRegression().fit(X, y)
>>> iso_reg.predict([.1, .2])
array([1.8628..., 3.7256...])
fit(X, y, sample_weight=None)[source]#

使用 X、y 作为训练数据拟合模型。

参数:
X形状为 (n_samples,) 或 (n_samples, 1) 的类数组

训练数据。

0.24 版本中的变更: 也接受具有 1 个特征的二维数组。

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

训练目标。

sample_weight形状为 (n_samples,) 的类数组,默认为 None

权重。如果设置为 None,则所有权重都将设置为 1(相等权重)。

返回:
self对象

返回 self 的实例。

备注

X 存储以备将来使用,因为transform 需要 X 来插值新的输入数据。

fit_transform(X, y=None, **fit_params)[source]#

拟合数据,然后转换它。

使用可选参数fit_params将转换器拟合到Xy,并返回X的转换版本。

参数:
X形状为 (n_samples, n_features) 的类数组

输入样本。

y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组,默认为 None

目标值(无监督转换则为 None)。

**fit_params字典

其他拟合参数。

返回:
X_new形状为 (n_samples, n_features_new) 的 ndarray 数组

转换后的数组。

get_feature_names_out(input_features=None)[source]#

获取转换的输出特征名称。

参数:
input_featuresstr 类型的类数组或 None,默认为 None

忽略。

返回:
feature_names_outstr 对象的 ndarray

一个包含一个字符串的 ndarray,即 [“isotonicregression0”]。

get_metadata_routing()[source]#

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

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

返回:
routingMetadataRequest

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

get_params(deep=True)[source]#

获取此估计器的参数。

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

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

返回:
params字典

参数名称映射到其值。

predict(T)[source]#

通过线性插值预测新数据。

参数:
T形状为 (n_samples,) 或 (n_samples, 1) 的类数组

要转换的数据。

返回:
y_pred形状为 (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 期望值的常数模型,忽略输入特征,其 \(R^2\) 分数为 0.0。

参数:
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浮点数

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

备注

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

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

传递到 fit 方法的请求元数据。

请注意,只有在 enable_metadata_routing=True 时(参见 sklearn.set_config)此方法才相关。请参阅 用户指南,了解路由机制的工作原理。

每个参数的选项为

  • True:请求元数据,如果提供则传递给 fit。如果未提供元数据,则忽略请求。

  • False:不请求元数据,元估计器不会将其传递给 fit

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

  • str:元数据应使用此给定的别名而不是原始名称传递给元估计器。

默认值(sklearn.utils.metadata_routing.UNCHANGED)保留现有的请求。这允许您更改某些参数的请求,而无需更改其他参数。

1.3 版本中新增。

注意

仅当将此估计器用作元估计器的子估计器时(例如,在 Pipeline 中使用)此方法才相关。否则,它无效。

参数:
sample_weightstr、True、False 或 None,默认为 sklearn.utils.metadata_routing.UNCHANGED

fitsample_weight 参数的元数据路由。

返回:
self对象

更新后的对象。

set_output(*, transform=None)[source]#

设置输出容器。

有关如何使用 API 的示例,请参见 介绍 set_output API

参数:
transform{"default", "pandas", "polars"},默认为 None

配置 transformfit_transform 的输出。

  • "default":转换器的默认输出格式

  • "pandas":DataFrame 输出

  • "polars":Polars 输出

  • None:变换配置不变

版本 1.4 中新增: "polars" 选项已添加。

返回:
self估计器实例

估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

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

参数:
**params字典

估计器参数。

返回:
self估计器实例

估计器实例。

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') IsotonicRegression[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对象

更新后的对象。

transform(T)[source]#

通过线性插值变换新数据。

参数:
T形状为 (n_samples,) 或 (n_samples, 1) 的类数组

要转换的数据。

0.24 版本中的变更: 也接受具有 1 个特征的二维数组。

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

变换后的数据。