r2_score#

sklearn.metrics.r2_score(y_true, y_pred, *, sample_weight=None, multioutput='uniform_average', force_finite=True)[source]#

\(R^2\)（决定系数）回归分数函数。

可能的最佳分数是 1.0，它也可以是负数（因为模型可能任意地差）。在真实的 y 不恒定的情况下，一个始终预测平均 y 而不考虑输入特征的常数模型将获得 0.0 的 \(R^2\) 分数。

在 y_true 恒定的特殊情况下，\(R^2\) 分数不是有限的：它要么是 NaN（完美预测），要么是 -Inf（不完美预测）。为了防止此类非有限数污染网格搜索交叉验证等更高级别的实验，默认情况下，这些情况分别替换为 1.0（完美预测）或 0.0（不完美预测）。您可以将 force_finite 设置为 False 以防止此修复发生。

注意：当预测残差的均值为零时，\(R^2\) 分数与 Explained Variance score 相同。

请在 User Guide 中阅读更多内容。

参数:

y_true形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象

真实（正确）的目标值。

y_pred形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象

估计的目标值。

sample_weightshape 为 (n_samples,) 的 array-like, default=None

样本权重。

multioutput{‘raw_values’, ‘uniform_average’, ‘variance_weighted’}, array-like of shape (n_outputs,) or None, default=’uniform_average’

定义多个输出分数的聚合方式。类似数组的值定义用于平均分数的权重。默认值为 “uniform_average”。

‘raw_values’: 在多输出输入的情况下返回一组完整的分数。
‘uniform_average’: 所有输出的分数以均匀权重平均。
‘variance_weighted’: 所有输出的分数都按每个单独输出的方差加权平均。

Changed in version 0.19: multioutput 的默认值是 ‘uniform_average’。

force_finitebool, default=True

标志，指示是否应将由恒定数据导致的 NaN 和 -Inf 分数替换为实数（如果预测完美则为 1.0，否则为 0.0）。默认值为 True，这是用于超参数搜索程序（例如网格搜索交叉验证）的便捷设置。

版本 1.1 中新增。

返回:

zfloat or ndarray of floats: \(R^2\) 分数或分数的 ndarray（如果 ‘multioutput’ 为 ‘raw_values’）。

注意事项

这不是一个对称函数。

与大多数其他分数不同，\(R^2\) 分数可能为负（它不一定真的是量 R 的平方）。

此度量对于单个样本未明确定义，如果 n_samples 小于两个，将返回 NaN 值。

References

[1]

决定系数的维基百科条目

示例

>>> from sklearn.metrics import r2_score
>>> y_true = [3, -0.5, 2, 7]
>>> y_pred = [2.5, 0.0, 2, 8]
>>> r2_score(y_true, y_pred)
0.948...
>>> y_true = [[0.5, 1], [-1, 1], [7, -6]]
>>> y_pred = [[0, 2], [-1, 2], [8, -5]]
>>> r2_score(y_true, y_pred,
...          multioutput='variance_weighted')
0.938...
>>> y_true = [1, 2, 3]
>>> y_pred = [1, 2, 3]
>>> r2_score(y_true, y_pred)
1.0
>>> y_true = [1, 2, 3]
>>> y_pred = [2, 2, 2]
>>> r2_score(y_true, y_pred)
0.0
>>> y_true = [1, 2, 3]
>>> y_pred = [3, 2, 1]
>>> r2_score(y_true, y_pred)
-3.0
>>> y_true = [-2, -2, -2]
>>> y_pred = [-2, -2, -2]
>>> r2_score(y_true, y_pred)
1.0
>>> r2_score(y_true, y_pred, force_finite=False)
nan
>>> y_true = [-2, -2, -2]
>>> y_pred = [-2, -2, -2 + 1e-8]
>>> r2_score(y_true, y_pred)
0.0
>>> r2_score(y_true, y_pred, force_finite=False)
-inf