tf.keras.metrics.CosineSimilarity

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

Наследуется от: MeanMetricWrapper, Mean, Metric, Layer, Module

tf.keras.metrics.CosineSimilarity(
    name='cosine_similarity', dtype=None, axis=-1
)

cosine similarity = (a . b) / ||a|| ||b||

См.: Косинусное сходство.

Эта метрика сохраняет среднее косинусное сходство между predictions и labels по потоку данных.

Использование автономно:

# l2_norm(y_true) = [[0., 1.], [1./1.414, 1./1.414]]
# l2_norm(y_pred) = [[1., 0.], [1./1.414, 1./1.414]]
# l2_norm(y_true) . l2_norm(y_pred) = [[0., 0.], [0.5, 0.5]]
# result = mean(sum(l2_norm(y_true) . l2_norm(y_pred), axis=1))
#        = ((0. + 0.) +  (0.5 + 0.5)) / 2
m = tf.keras.metrics.CosineSimilarity(axis=1)
m.update_state([[0., 1.], [1., 1.]], [[1., 0.], [1., 1.]])
m.result().numpy()
0.49999997

m.reset_state()
m.update_state([[0., 1.], [1., 1.]], [[1., 0.], [1., 1.]],
               sample_weight=[0.3, 0.7])
m.result().numpy()
0.6999999

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

model.compile(
    optimizer='sgd',
    loss='mse',
    metrics=[tf.keras.metrics.CosineSimilarity(axis=1)])

Методы

merge_state

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

merge_state(
    metrics
)

Объединяет состояние из одной или нескольких метрик.

Этот метод может использоваться распределенными системами для объединения состояния, вычисленного различными экземплярами метрик. Обычно состояние хранится в виде весов метрики. Например, метрика tf.keras.metrics.Mean содержит список двух значений весов: суммы и счётчика. Если было два экземпляра tf.keras.metrics.Accuracy, которые независимо агрегировали частичное состояние для расчёта общей точности, состояния этих двух метрик можно объединить следующим образом:

m1 = tf.keras.metrics.Accuracy()
_ = m1.update_state([[1], [2]], [[0], [2]])

m2 = tf.keras.metrics.Accuracy()
_ = m2.update_state([[3], [4]], [[3], [4]])

m2.merge_state([m1])
m2.result().numpy()
0.75

reset_state

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

reset_state()

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

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

result

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

result()

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

Вычисление результата — это идемпотентная операция, которая просто вычисляет значение метрики с использованием переменных состояния.

update_state

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

update_state(
    y_true, y_pred, sample_weight=None
)

Накапливает статистические данные метрики.

Для метрик с разреженной категориальной классификацией формы y_true и y_pred различаются.