CosineEmbeddingLoss

class torch.nn.CosineEmbeddingLoss(margin=0.0, size_average=None, reduce=None, reduction='mean') [source]

Создаёт критерий, измеряющий потерю, заданную входными тензорами $x_1$, $x_2$ и Tensor меткой $y$ со значениями 1 или -1. Используется для измерения схожести или несхожести двух входов с помощью косинусного сходства, и обычно используется для обучения нелинейных вложений или полусупервизированного обучения.

Функция потерь для каждого примера:

$$\text{loss}(x, y) = \begin{cases} 1 - \cos(x_1, x_2), & \text{if } y = 1 \\ \max(0, \cos(x_1, x_2) - \text{margin}), & \text{if } y = -1 \end{cases}$$

Параметры:

• margin (float, необязательно) – Должно быть число от $-1$ до $1$, $0$ до $0.5$ рекомендуется. Если margin отсутствует, значение по умолчанию $0$.
• size_average (bool, необязательно) – Устарело (см. reduction). По умолчанию потери усредняются по каждому элементу потерь в пакете. Обратите внимание, что для некоторых потерь есть несколько элементов на образец. Если поле size_average установлено в False, потери вместо этого суммируются для каждого мини-пакета. Игнорируется, когда reduce равно False. По умолчанию: True
• reduce (bool, необязательно) – Устарело (см. reduction). По умолчанию потери усредняются или суммируются по наблюдениям для каждого мини-пакета в зависимости от size_average. Когда reduce равно False, возвращает потерю на элемент пакета и игнорирует size_average. По умолчанию: True
• reduction (str, необязательно) – Указывает способ применения редукции к выводу: 'none' | 'mean' | 'sum'. 'none': редукция не будет применена, 'mean': сумма вывода будет разделена на количество элементов в выводе, 'sum': вывод будет суммирован. Примечание: size_average и reduce в процессе устаревания, и пока указание любого из этих двух аргументов переопределит reduction. По умолчанию: 'mean'

Форма:

• Вход 1: $(N, D)$ или $(D)$, где N — размер пакета, а D — размерность вложения.
• Вход 2: $(N, D)$ или $(D)$, такая же форма, как у Входа 1.
• Цель: $(N)$ или $()$.
• Вывод: Если reduction равно 'none', то $(N)$, в противном случае скаляр.