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 и игнорирующая входные признаки, получит оценку \(R^2\), равную 0.0.

В частном случае, когда y_true является константой, оценка \(R^2\) не является конечной: она равна либо NaN (идеальные предсказания), либо -Inf (неидеальные предсказания). Чтобы такие бесконечные значения не влияли на результаты экспериментов более высокого уровня, например перекрёстной проверки при поиске по сетке, по умолчанию в этих случаях они заменяются соответственно на 1.0 (идеальные предсказания) или 0.0 (неидеальные предсказания). Чтобы отключить это исправление, задайте force_finite равным False.

Примечание: если остатки предсказаний имеют нулевое среднее, оценка \(R^2\) совпадает с Explained Variance score.

Подробнее см. в руководстве пользователя.

Параметры:

y_truearray-like of shape (n_samples,) or (n_samples, n_outputs)

Истинные (корректные) целевые значения.

y_predarray-like of shape (n_samples,) or (n_samples, n_outputs)

Оценённые целевые значения.

sample_weightarray-like of shape (n_samples,), default=None

Веса объектов.

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

Определяет способ агрегирования оценок для нескольких выходов. Значение array-like задаёт веса, используемые для усреднения оценок. По умолчанию используется “uniform_average”.

‘raw_values’ :

Возвращает полный набор оценок для входных данных с несколькими выходами.

‘uniform_average’ :

Оценки всех выходов усредняются с равными весами.

‘variance_weighted’ :

Оценки всех выходов усредняются с весами, пропорциональными дисперсиям каждого отдельного выхода.

Изменено в версии 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\) или массив оценок, если ‘multioutput’ равно ‘raw_values’.

Примечания

Эта функция не является симметричной.

В отличие от большинства других оценок, оценка \(R^2\) может быть отрицательной (она не обязательно является квадратом некоторой величины R).

Эта метрика не определена для одного объекта и возвращает значение NaN, если n_samples меньше двух.

Ссылки

[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

Примеры из галереи

Влияние преобразования целевых значений в модели регрессии

Неспособность машинного обучения выявлять причинно-следственные эффекты

Модели на основе L1 для разреженных сигналов

Метод наименьших квадратов с неотрицательными ограничениями

Метод наименьших квадратов и регрессия Ridge