recall_score

sklearn.metrics.recall_score(y_true, y_pred, *, labels=None, pos_label=1, average='binary', sample_weight=None, zero_division='warn')[source]

Вычисление полноты.

Полнота — это отношение tp / (tp + fn) где tp — количество истинно положительных, а fn — количество ложноотрицательных. Полнота интуитивно характеризует способность классификатора находить все положительные образцы.

Наилучшее значение — 1, худшее — 0.

Поддержка для задач с несколькими классами/метками достигается путем рассмотрения данных multiclass и multilabel как набора бинарных задач, по одной на каждую метку. Для бинарного случая, установка average='binary' вернёт полноту для pos_label. Если average не 'binary', pos_label игнорируется, и вычисляется полнота для обоих классов, затем усредняется или возвращаются оба значения (когда average=None). Аналогично, для multiclass и multilabel задач, полнота для всех labels либо возвращается, либо усредняется, в зависимости от параметра average. Используйте labels для задания набора меток, для которых нужно вычислить полноту.

Дополнительная информация в Руководстве пользователя.

Параметры:

y_trueодномерный массив-подобный объект или массив индикаторов меток/разреженная матрица

Целевые значения истинного (правильного) результата.

y_predодномерный массив-подобный объект или массив индикаторов меток/разреженная матрица

Оценённые целевые значения, возвращаемые классификатором.

labelsмассив-подобный объект, по умолчанию=None

Набор меток для включения при average != 'binary', и их порядок, если average is None. Метки, присутствующие в данных, можно исключить, например, в многоклассовой классификации для исключения «отрицательного класса». Метки, отсутствующие в данных, можно включить, и им будет «присвоено» 0 образцов. Для многомерных целевых значений метки — это индексы столбцов. По умолчанию используются все метки в данных y_true и y_pred в отсортированном порядке.

Изменено в версии 0.17: Параметр labels улучшен для многоклассовой задачи.

pos_labelцелое число, число с плавающей точкой, булево значение или строка, по умолчанию=1

Класс для отчёта, если average='binary' и данные двоичные, в противном случае этот параметр игнорируется. Для многоклассовых или многомерных целевых значений задайте labels=[pos_label] и average != 'binary' для отчёта метрик только для одной метки.

average{'micro', 'macro', 'samples', 'weighted', 'binary'} или None, по умолчанию='binary'

Этот параметр необходим для многоклассовых/многомерных целевых значений. Если None, возвращаются метрики для каждого класса. В противном случае это определяет тип усреднения, выполняемого по данным:

'binary':

Отчёт только для класса, указанного в pos_label. Применимо только в случае, если целевые значения (y_{true,pred}) двоичные.

'micro':

Вычисление метрик глобально подсчётом общих истинных положительных, ложных отрицательных и ложных положительных значений.

'macro':

Вычисление метрик для каждой метки и нахождение их невзвешенного среднего значения. Не учитывает дисбаланс меток.

'weighted':

Вычисление метрик для каждой метки и нахождение их среднего взвешенного по поддержке (число истинно наблюдаемых значений для каждой метки). Это изменяет «macro», чтобы учесть дисбаланс меток; может привести к F-мере, которая не находится между точностью и полнотой. Взвешенная полнота равна точности.

'samples':

Вычисление метрик для каждого образца и нахождение их среднего (имеет смысл только для многомерной классификации, где это отличается от accuracy_score).

sample_weightмассив-подобный объект формы (n_samples,), по умолчанию=None

Веса образцов.

zero_division{“warn”, 0.0, 1.0, np.nan}, по умолчанию=”warn”

Устанавливает значение для возврата при делении на ноль.

Примечания:

• Если установлено «warn», это действует как 0, но также выводится предупреждение.
• Если установлено np.nan, такие значения будут исключены из среднего.

Добавлена в версии 1.3: np.nan вариант был добавлен.

Возвращаемое значение:

recallчисло с плавающей точкой (если average не None) или массив чисел с плавающей точкой формы (n_unique_labels,)

Полнота положительного класса в двоичной классификации или взвешенное среднее полноты каждого класса для многоклассовой задачи.

См. также

precision_recall_fscore_support

Вычисление точности, полноты, F-меры и поддержки для каждого класса.

precision_score

Вычисление отношения tp / (tp + fp), где tp — количество истинно положительных, а fp — количество ложноположительных.

balanced_accuracy_score

Вычисление сбалансированной точности для работы с несбалансированными наборами данных.

multilabel_confusion_matrix

Вычисление матрицы неточностей для каждого класса или образца.

PrecisionRecallDisplay.from_estimator

Построение кривой точности-полноты, используя оценщик и данные.

PrecisionRecallDisplay.from_predictions

Построение кривой точности-полноты, используя бинарные предсказания класса.

Примечания

Когда true positive + false negative == 0, полнота возвращает 0 и генерирует UndefinedMetricWarning. Это поведение можно изменить с помощью zero_division.

Примеры

>>> import numpy as np
>>> from sklearn.metrics import recall_score
>>> y_true = [0, 1, 2, 0, 1, 2]
>>> y_pred = [0, 2, 1, 0, 0, 1]
>>> recall_score(y_true, y_pred, average='macro')
0.33...
>>> recall_score(y_true, y_pred, average='micro')
0.33...
>>> recall_score(y_true, y_pred, average='weighted')
0.33...
>>> recall_score(y_true, y_pred, average=None)
array([1., 0., 0.])
>>> y_true = [0, 0, 0, 0, 0, 0]
>>> recall_score(y_true, y_pred, average=None)
array([0.5, 0. , 0. ])
>>> recall_score(y_true, y_pred, average=None, zero_division=1)
array([0.5, 1. , 1. ])
>>> recall_score(y_true, y_pred, average=None, zero_division=np.nan)
array([0.5, nan, nan])

>>> # multilabel classification
>>> y_true = [[0, 0, 0], [1, 1, 1], [0, 1, 1]]
>>> y_pred = [[0, 0, 0], [1, 1, 1], [1, 1, 0]]
>>> recall_score(y_true, y_pred, average=None)
array([1. , 1. , 0.5])

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

Кривые калибровки вероятностей

Настройка порога принятия решения для обучения с учётом стоимости

Точность-полнота