r2_score#

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

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

最佳得分是1.0,它可能是负的(因为模型可能任意糟糕)。在一般情况下,当真实的y是非恒定的,一个总是预测平均y的常数模型,忽略输入特征,将得到一个0.0的:math:R^2 得分。

y_true 是常数的特殊情况下,\(R^2\) 得分不是有限的:它要么是 NaN (完美预测),要么是 -Inf (不完美预测)。为了防止这种非有限的数字污染更高层次的实验,例如网格搜索交叉验证,默认情况下这些情况会被替换为1.0(完美预测)或0.0(不完美预测)。你可以将 force_finite 设置为 False 来阻止这种修复发生。

注意:当预测残差的均值为零时,\(R^2\) 得分与:func:解释方差得分 <explained_variance_score> 相同。

更多信息请参阅:ref:用户指南 <r2_score>

Parameters:
y_true形状为(n_samples,)或(n_samples, n_outputs)的类数组

真实(正确)的目标值。

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

估计的目标值。

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

样本权重。

multioutput{‘raw_values’, ‘uniform_average’, ‘variance_weighted’}, 形状为(n_outputs,)或None的类数组,默认=’uniform_average’

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

‘raw_values’ :

在多输出输入的情况下返回完整的一组得分。

‘uniform_average’ :

所有输出的得分以均匀权重平均。

‘variance_weighted’ :

所有输出的得分平均,按每个单独输出的方差加权。

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

force_finitebool, 默认=True

标志指示是否应将由常数数据产生的 NaN-Inf 得分替换为实数(如果预测完美则为 1.0 ,否则为 0.0 )。默认是 True ,这是超参数搜索过程(例如网格搜索交叉验证)的便捷设置。

Added in version 1.1.

Returns:
zfloat或float的ndarray

\(R^2\) 得分,如果’multioutput’是’raw_values’,则为得分的ndarray。

Notes

这不是一个对称函数。

与大多数其他得分不同,\(R^2\) 得分可能是负的(它不一定是一个量R的平方)。

此度量对于单个样本未定义良好,如果n_samples小于两个,将返回NaN值。

References

Examples

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