PredictionErrorDisplay#

class sklearn.metrics.PredictionErrorDisplay(*, y_true, y_pred)#

预测回归模型的误差可视化。

该工具可以使用散点图显示“残差 vs 预测”或“实际 vs 预测”,以定性地评估回归器的行为,最好是在保留的数据点上进行。

有关详细信息,请参阅 from_estimatorfrom_predictions 的文档字符串, 以创建可视化工具。所有参数都存储为属性。

有关 scikit-learn 可视化工具的一般信息,请阅读 Visualization Guide 。 有关解释这些图表的详细信息,请参阅 Model Evaluation Guide

Added in version 1.2.

Parameters:
y_truendarray of shape (n_samples,)

真实值。

y_predndarray of shape (n_samples,)

预测值。

Attributes:
line_matplotlib Artist

表示 y_true == y_pred 的最佳线条。因此,对于 kind="predictions" 是 对角线,对于 kind="residuals" 是水平线。

errors_lines_matplotlib Artist or None

残差线。如果 with_errors=False ,则设置为 None

scatter_matplotlib Artist

散点数据点。

ax_matplotlib Axes

包含不同 matplotlib 轴的轴。

figure_matplotlib Figure

包含散点和线条的图形。

See also

PredictionErrorDisplay.from_estimator

给定估计器和数据的预测误差可视化。

PredictionErrorDisplay.from_predictions

给定真实目标和预测目标的预测误差可视化。

Examples

>>> import matplotlib.pyplot as plt
>>> from sklearn.datasets import load_diabetes
>>> from sklearn.linear_model import Ridge
>>> from sklearn.metrics import PredictionErrorDisplay
>>> X, y = load_diabetes(return_X_y=True)
>>> ridge = Ridge().fit(X, y)
>>> y_pred = ridge.predict(X)
>>> display = PredictionErrorDisplay(y_true=y, y_pred=y_pred)
>>> display.plot()
<...>
>>> plt.show()
../../_images/sklearn-metrics-PredictionErrorDisplay-1.png
classmethod from_estimator(estimator, X, y, *, kind='residual_vs_predicted', subsample=1000, random_state=None, ax=None, scatter_kwargs=None, line_kwargs=None)#

绘制给定回归器和数据集的预测误差图。

有关 scikit-learn 可视化工具的一般信息,请阅读更多内容在 可视化指南 中。 有关解释这些图表的详细信息,请参阅 模型评估指南

Added in version 1.2.

Parameters:
estimatorestimator instance

拟合的回归器或拟合的 Pipeline ,其中最后一个估计器是回归器。

X{array-like, sparse matrix} of shape (n_samples, n_features)

输入值。

yarray-like of shape (n_samples,)

目标值。

kind{“actual_vs_predicted”, “residual_vs_predicted”}, 默认=”residual_vs_predicted”

要绘制的图表类型:

  • “actual_vs_predicted” 绘制观测值(y轴)与预测值(x轴)。

  • “residual_vs_predicted” 绘制残差,即观测值与预测值之间的差异(y轴)与预测值(x轴)。

subsamplefloat, int or None, 默认=1_000

对要在散点图上显示的样本进行采样。如果是 float ,应在 0 和 1 之间,表示原始数据集的比例。如果是 int ,表示散点图上显示的样本数量。如果是 None ,则不应用子采样。默认情况下,显示 1000 个样本或更少。

random_stateint or RandomState, 默认=None

subsample 不是 None 时控制随机性。有关详细信息,请参阅 Glossary

axmatplotlib axes, 默认=None

要在其上绘制的轴对象。如果为 None ,则创建一个新的图形和轴。

scatter_kwargsdict, 默认=None

传递给 matplotlib.pyplot.scatter 调用的关键字字典。

line_kwargsdict, 默认=None

传递给 matplotlib.pyplot.plot 调用以绘制最佳线的关键字字典。

Returns:
displayPredictionErrorDisplay

存储计算值的对象。

See also

PredictionErrorDisplay

回归预测误差可视化。

PredictionErrorDisplay.from_predictions

给定真实目标和预测目标的预测误差可视化。

Examples

>>> import matplotlib.pyplot as plt
>>> from sklearn.datasets import load_diabetes
>>> from sklearn.linear_model import Ridge
>>> from sklearn.metrics import PredictionErrorDisplay
>>> X, y = load_diabetes(return_X_y=True)
>>> ridge = Ridge().fit(X, y)
>>> disp = PredictionErrorDisplay.from_estimator(ridge, X, y)
>>> plt.show()
../../_images/sklearn-metrics-PredictionErrorDisplay-2.png
classmethod from_predictions(y_true, y_pred, *, kind='residual_vs_predicted', subsample=1000, random_state=None, ax=None, scatter_kwargs=None, line_kwargs=None)#

绘制给定真实目标值和预测目标值的预测误差图。

有关 scikit-learn 可视化工具的一般信息,请阅读 可视化指南 。 有关解释这些图表的详细信息,请参阅 模型评估指南

Added in version 1.2.

Parameters:
y_truearray-like of shape (n_samples,)

真实目标值。

y_predarray-like of shape (n_samples,)

预测目标值。

kind{“actual_vs_predicted”, “residual_vs_predicted”}, 默认=”residual_vs_predicted”

要绘制的图表类型:

  • “actual_vs_predicted” 绘制观测值(y轴)与预测值(x轴)。

  • “residual_vs_predicted” 绘制残差,即观测值与预测值之间的差异(y轴)与预测值(x轴)。

subsamplefloat, int or None, 默认=1_000

对要在散点图上显示的样本进行采样。如果是 float ,应在 0 和 1 之间,表示原始数据集的比例。如果是 int ,表示散点图上显示的样本数量。如果是 None ,则不进行子采样。默认情况下,显示 1000 个样本或更少。

random_stateint or RandomState, 默认=None

subsample 不是 None 时控制随机性。有关详细信息,请参阅 Glossary

axmatplotlib axes, 默认=None

要在其上绘图的 Axes 对象。如果为 None ,则创建一个新的图形和 Axes。

scatter_kwargsdict, 默认=None

传递给 matplotlib.pyplot.scatter 调用的关键字字典。

line_kwargsdict, 默认=None

传递给 matplotlib.pyplot.plot 调用以绘制最佳线的关键字字典。

Returns:
displayPredictionErrorDisplay

存储计算值的对象。

See also

PredictionErrorDisplay

回归预测误差可视化。

PredictionErrorDisplay.from_estimator

给定估计器和数据的可视化预测误差。

Examples

>>> import matplotlib.pyplot as plt
>>> from sklearn.datasets import load_diabetes
>>> from sklearn.linear_model import Ridge
>>> from sklearn.metrics import PredictionErrorDisplay
>>> X, y = load_diabetes(return_X_y=True)
>>> ridge = Ridge().fit(X, y)
>>> y_pred = ridge.predict(X)
>>> disp = PredictionErrorDisplay.from_predictions(y_true=y, y_pred=y_pred)
>>> plt.show()
../../_images/sklearn-metrics-PredictionErrorDisplay-3.png
plot(ax=None, *, kind='residual_vs_predicted', scatter_kwargs=None, line_kwargs=None)#

绘图可视化。

额外的关键字参数将被传递给matplotlib的 plot

Parameters:
axmatplotlib axes, default=None

要在其上绘制的Axes对象。如果为 None ,则创建一个新的图形和轴。

kind{“actual_vs_predicted”, “residual_vs_predicted”}, default=”residual_vs_predicted”

要绘制的图的类型:

  • “actual_vs_predicted”绘制观测值(y轴)与预测值(x轴)。

  • “residual_vs_predicted”绘制残差,即观测值与预测值之间的差异(y轴)与预测值(x轴)。

scatter_kwargsdict, default=None

带有传递给 matplotlib.pyplot.scatter 调用关键字的字典。

line_kwargsdict, default=None

带有传递给 matplotlib.pyplot.plot 调用关键字的字典,以绘制最佳线。

Returns:
displayPredictionErrorDisplay

存储计算值的对象。