Spec-Zone.ru › TensorFlow 2.3

tf.keras.losses.CosineSimilarity

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

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

Просмотр псевдонимов

Основные псевдонимы

tf.losses.CosineSimilarity

Псевдонимы для миграции

См. Руководство по миграции для получения дополнительной информации.

tf.compat.v1.keras.losses.CosineSimilarity

tf.keras.losses.CosineSimilarity(
    axis=-1, reduction=losses_utils.ReductionV2.AUTO, name='cosine_similarity'
)

Обратите внимание, что это отрицательное значение между -1 и 0, где 0 указывает на ортогональность, а значения, более близкие к -1, указывают на большее сходство. Это делает его пригодным для использования в качестве функции потерь в сценарии, где вы пытаетесь максимизировать близость между прогнозами и целевыми значениями. Если либо y_true, либо y_pred является нулевым вектором, косинусное сходство будет равно 0 независимо от близости между прогнозами и целевыми значениями.

loss = -sum(l2_norm(y_true) * l2_norm(y_pred))

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

y_true = [[0., 1.], [1., 1.]]
y_pred = [[1., 0.], [1., 1.]]
# Using 'auto'/'sum_over_batch_size' reduction type.
cosine_loss = tf.keras.losses.CosineSimilarity(axis=1)
# 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]]
# loss = mean(sum(l2_norm(y_true) . l2_norm(y_pred), axis=1))
#       = -((0. + 0.) +  (0.5 + 0.5)) / 2
cosine_loss(y_true, y_pred).numpy()
-0.5
# Calling with 'sample_weight'.
cosine_loss(y_true, y_pred, sample_weight=[0.8, 0.2]).numpy()
-0.0999
# Using 'sum' reduction type.
cosine_loss = tf.keras.losses.CosineSimilarity(axis=1,
    reduction=tf.keras.losses.Reduction.SUM)
cosine_loss(y_true, y_pred).numpy()
-0.999
# Using 'none' reduction type.
cosine_loss = tf.keras.losses.CosineSimilarity(axis=1,
    reduction=tf.keras.losses.Reduction.NONE)
cosine_loss(y_true, y_pred).numpy()
array([-0., -0.999], dtype=float32)

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

model.compile(optimizer='sgd', loss=tf.keras.losses.CosineSimilarity(axis=1))
Аргументы
axis (Необязательно) По умолчанию -1. Измерение, по которому вычисляется косинусное сходство.
reduction (Необязательно) Тип tf.keras.losses.Reduction для применения к функциям потерь. Значение по умолчанию - AUTO. AUTO указывает, что параметр сведения будет определяться контекстом использования. Почти во всех случаях значение по умолчанию - SUM_OVER_BATCH_SIZE. При использовании с tf.distribute.Strategy за пределами встроенных циклов обучения, таких как tf.keras compile и fit, использование AUTO или SUM_OVER_BATCH_SIZE приведет к ошибке. Подробнее см. этот учебник по настройке обучения по ссылке.
name Необязательное имя для операции.
Аргументы
fn Функция потерь для обертывания, с сигнатурой fn(y_true, y_pred, **kwargs).
reduction (Необязательно) Тип tf.keras.losses.Reduction для применения к функциям потерь. Значение по умолчанию - AUTO. AUTO указывает, что параметр сведения будет определяться контекстом использования. Почти во всех случаях значение по умолчанию - SUM_OVER_BATCH_SIZE. При использовании с tf.distribute.Strategy за пределами встроенных циклов обучения, таких как tf.keras compile и fit, использование AUTO или SUM_OVER_BATCH_SIZE приведет к ошибке. Подробнее см. этот учебник по настройке обучения по ссылке.
name (Необязательно) имя для функции потерь.
**kwargs Параметры ключевых слов, передаваемые в fn.

Методы

from_config

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

@classmethod
from_config(
    config
)

Инициализирует Loss из его конфигурации (результат get_config()).

Аргументы
config Результат get_config().
Возвращаемое значение
Экземпляр класса Loss.

get_config

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

get_config()

Возвращает словарь конфигурации для экземпляра класса Loss.

__call__

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

__call__(
    y_true, y_pred, sample_weight=None
)

Вызывает экземпляр класса Loss.

Аргументы
y_true Значения целевого объекта. форма = [batch_size, d0, .. dN], за исключением функций потерь со значениями типа sparse, таких как sparse categorical crossentropy, где форма = [batch_size, d0, .. dN-1]
y_pred Значения прогнозов. форма = [batch_size, d0, .. dN]
sample_weight Необязательные sample_weight действуют как коэффициент для потерь. Если задано скалярное значение, то функция потерь просто масштабируется заданным значением. Если sample_weight является тензором размером [batch_size], то общая функция потерь для каждого образца пакета масштабируется соответствующим элементом в векторе sample_weight. Если форма sample_weight равна [batch_size, d0, .. dN-1] (или может быть расширена до этой формы), то каждый элемент функции потерь y_pred масштабируется соответствующим значением sample_weight. (Примечание по dN-1: все функции потерь уменьшают размерность на 1, обычно осью -1.)
Возвращаемое значение
Весовая функция потерь float Tensor. Если reduction равно NONE, эта величина имеет форму [batch_size, d0, .. dN-1]; в противном случае это скаляр. (Примечание dN-1, так как все функции потерь уменьшают размерность на 1, обычно осью -1.)
Исключения
ValueError Если форма sample_weight неверна.

© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.3/api_docs/python/tf/keras/losses/CosineSimilarity

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API