tf.keras.metrics.Recall

Вычисляет полноту предсказаний относительно меток.

Наследуется от: Metric

tf.keras.metrics.Recall(
    thresholds=None, top_k=None, class_id=None, name=None, dtype=None
)

Используется в блокнотах

Используется в руководствах
Классификация на несбалансированных данных Эффективное с точки зрения клиента федеративное обучение больших моделей с помощью `federated_select` и разреженной агрегации

Эта метрика создает две локальные переменные, true_positives и false_negatives, которые используются для вычисления полноты. В конечном счете это значение возвращается как recall — идемпотентная операция, которая просто делит true_positives на сумму true_positives и false_negatives.

Если sample_weight равно None, веса по умолчанию равны 1. Используйте значение sample_weight, равное 0, чтобы маскировать значения.

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

Если задано class_id, полнота вычисляется только для тех элементов пакета, для которых class_id присутствует в метке, и определяется доля этих элементов, для которых class_id превышает порог и/или входит в топ-k предсказаний.

Аргументы
`thresholds`	(Необязательно) Значение с плавающей точкой или список/кортеж Python со значениями порогов с плавающей точкой в `[0, 1]`. Порог сравнивается со значениями предсказаний, чтобы определить истинностное значение предсказаний (то есть значения выше порога — это `True`, а ниже — `False`). При использовании с функцией потерь, для которой задано `from_logits=True` (то есть сигмоида не применяется к предсказаниям), значение `thresholds` должно быть равно 0. Для каждого значения порога формируется одно значение метрики. Если не заданы ни `thresholds`, ни `top_k`, по умолчанию полнота вычисляется с `thresholds=0.5`.
`top_k`	(Необязательно) По умолчанию не задано. Целочисленное значение, указывающее количество предсказаний top-k, учитываемых при вычислении полноты.
`class_id`	(Необязательно) Целочисленный идентификатор класса, для которого нужны бинарные метрики. Он должен находиться в полуоткрытом интервале `[0, num_classes)`, где `num_classes` — последняя размерность предсказаний.
`name`	(Необязательно) Строковое имя экземпляра метрики.
`dtype`	(Необязательно) Тип данных результата метрики.

Пример:

m = keras.metrics.Recall()
m.update_state([0, 1, 1, 1], [1, 0, 1, 1])
m.result()
0.6666667

m.reset_state()
m.update_state([0, 1, 1, 1], [1, 0, 1, 1], sample_weight=[0, 0, 1, 0])
m.result()
1.0

Использование с API compile():

model.compile(optimizer='sgd',
              loss='binary_crossentropy',
              metrics=[keras.metrics.Recall()])

Использование с функцией потерь с from_logits=True:

model.compile(optimizer='adam',
              loss=keras.losses.BinaryCrossentropy(from_logits=True),
              metrics=[keras.metrics.Recall(thresholds=0)])

Атрибуты
`dtype`
`variables`

Методы

`add_variable`

Посмотреть исходный код

add_variable(
    shape, initializer, dtype=None, aggregation='sum', name=None
)

`add_weight`

Посмотреть исходный код

add_weight(
    shape=(), initializer=None, dtype=None, name=None
)

`from_config`

Посмотреть исходный код

@classmethod
from_config(
    config
)

`get_config`

Посмотреть исходный код

get_config()

Возвращает сериализуемую конфигурацию метрики.

`reset_state`

Посмотреть исходный код

reset_state()

Сбрасывает все переменные состояния метрики.

Эта функция вызывается между эпохами/шагами, когда метрика вычисляется во время обучения.

`result`

Посмотреть исходный код

result()

Вычисляет текущее значение метрики.

Возвращает
Скалярый тензор или словарь скалярных тензоров.

`stateless_reset_state`

Посмотреть исходный код

stateless_reset_state()

`stateless_result`

Посмотреть исходный код

stateless_result(
    metric_variables
)

`stateless_update_state`

Посмотреть исходный код

stateless_update_state(
    metric_variables, *args, **kwargs
)

`update_state`

Посмотреть исходный код

update_state(
    y_true, y_pred, sample_weight=None
)

Накапливает статистику истинно положительных и ложно отрицательных результатов.

Аргументы
`y_true`	Эталонные значения с теми же размерностями, что и у `y_pred`. Будут приведены к типу `bool`.
`y_pred`	Предсказанные значения. Каждый элемент должен находиться в диапазоне `[0, 1]`.
`sample_weight`	Необязательный вес каждого примера. По умолчанию равен `1`. Может быть тензором с рангом 0 или таким же рангом, как у `y_true`, и должен допускать трансляцию к `y_true`.

`call`

Посмотреть исходный код

__call__(
    *args, **kwargs
)

Вызывает self как функцию.

© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tf/keras/metrics/Recall