IsotonicRegression#

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

回归模型。

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

Added in version 0.13.

Parameters:
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 。

Attributes:
X_min_float

输入数组 X_ 的最小值，用于左边界。

X_max_float

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

X_thresholds_ndarray of shape (n_thresholds,)

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

Added in version 0.24.

y_thresholds_ndarray of shape (n_thresholds,)

去重后的 y 值，适用于插值 y = f(X) 单调函数。

Added in version 0.24.

f_function

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

increasing_bool

推断的 increasing 值。

See also

sklearn.linear_model.LinearRegression

普通最小二乘线性回归。

sklearn.ensemble.HistGradientBoostingRegressor

接受单调性约束的非参数梯度提升模型。

isotonic_regression

解决保序回归模型的函数。

Notes

使用 de Leeuw, 1977 的次要方法打破平局。

References

保序中位数回归：一种线性规划方法 Nilotpal Chakravarti 运筹学数学 第 14 卷，第 2 期（1989 年 5 月），第 303-308 页

R 中的保序优化：Pool-Adjacent-Violators 算法 (PAVA) 和活动集方法 de Leeuw, Hornik, Mair 统计软件杂志 2009

关于带平局的单调回归的 Kruskal 算法的正确性 de Leeuw, Psychometrica, 1977

Examples

>>> 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)#

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

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

训练数据。

Changed in version 0.24: 也接受带有 1 个特征的二维数组。

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

训练目标。

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

权重。如果设置为 None，所有权重将设置为 1（相等权重）。

Returns:
selfobject

返回 self 的一个实例。

fit_transform(X, y=None, **fit_params)#

拟合数据，然后进行转换。

将转换器拟合到 X 和 y ，并带有可选参数 fit_params ， 并返回 X 的转换版本。

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

输入样本。

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

目标值（无监督转换为 None）。

**fit_paramsdict

其他拟合参数。

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

转换后的数组。

get_feature_names_out(input_features=None)#

获取变换后的输出特征名称。

Parameters:
input_features字符串数组或None，默认=None

忽略。

Returns:
feature_names_out字符串对象的ndarray

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

get_metadata_routing()#

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

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

Returns:
routingMetadataRequest

MetadataRequest 封装的 路由信息。

get_params(deep=True)#

获取此估计器的参数。

Parameters:
deepbool, 默认=True

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

Returns:
paramsdict

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

predict(T)#

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

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

要转换的数据。

Returns:
y_pred形状为 (n_samples,) 的 ndarray

转换后的数据。

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_fit_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → IsotonicRegression#

Request metadata passed to the fit 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 fit 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 fit .

  • 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 fit .

Returns:
selfobject

The updated object.

set_output(*, transform=None)#

设置输出容器。

请参阅 介绍 set_output API 以了解如何使用API的示例。

Parameters:
transform{“default”, “pandas”, “polars”}, 默认=None

配置 transform 和 fit_transform 的输出。

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

  • "pandas" : DataFrame 输出

  • "polars" : Polars 输出

  • None : 转换配置不变

Added in version 1.4: "polars" 选项已添加。

Returns:
self估计器实例

估计器实例。

set_params(**params)#

设置此估计器的参数。

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

Parameters:
**paramsdict

估计器参数。

Returns:
selfestimator instance

估计器实例。

set_predict_request(*, T: bool | None | str = '$UNCHANGED$') → IsotonicRegression#

Request metadata passed to the predict 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 predict 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 predict .

  • 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:
Tstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for T parameter in predict .

Returns:
selfobject

The updated object.

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

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.

set_transform_request(*, T: bool | None | str = '$UNCHANGED$') → IsotonicRegression#

Request metadata passed to the transform 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 transform 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 transform .

  • 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:
Tstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for T parameter in transform .

Returns:
selfobject

The updated object.

transform(T)#

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

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

要转换的数据。

Changed in version 0.24: 也接受具有1个特征的二维数组。

Returns:
y_pred形状为 (n_samples,) 的 ndarray

转换后的数据。

On this page
Show Source