CosineEmbeddingLoss

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

创建一个标准，用于衡量给定输入张量的损失 $x_1$, $x_2$ 和一个 Tensor 标签 $y$ 其值为 1 或 -1。 使用 ($y=1$) 来最大化两个输入的余弦相似度，否则使用 ($y=-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}$$

Parameters

• margin (float, 可选) – 应为 $-1$ 到 $1$ 之间的数字，建议为 $0$ 到 $0.5$。如果缺少 margin，默认值为 $0$。

• size_average (布尔值, 可选) – 已弃用（参见 reduction）。默认情况下， 损失在批次中的每个损失元素上进行平均。请注意，对于某些损失，每个样本有多个元素。如果字段 size_average 设置为 False，则损失改为对每个小批次进行求和。当 reduce 为 False 时忽略。默认值：True

• reduce (bool, 可选) – 已弃用（参见 reduction）。默认情况下，损失会根据 size_average 的设置在每个小批次中对观测值进行平均或求和。当 reduce 为 False 时，返回每个批次元素的损失，并忽略 size_average。默认值：True

• reduction (str, 可选) – 指定应用于输出的reduction方式： 'none' | 'mean' | 'sum'。'none'：不进行reduction， 'mean'：输出的总和将除以输出中的元素数量，'sum'：输出将被求和。注意：size_average 和 reduce 正在被弃用，在此期间， 指定这两个参数中的任何一个都将覆盖 reduction。默认值：'mean'

Shape:

• 输入1: $(N, D)$ 或 $(D)$, 其中 N 是批次大小，D 是嵌入维度。

• 输入2: $(N, D)$ 或 $(D)$, 与输入1形状相同。

• 目标: $(N)$ 或 $()$。

• 输出：如果 reduction 是 'none'，那么 $(N)$，否则为标量。

示例：

>>> loss = nn.CosineEmbeddingLoss()
>>> input1 = torch.randn(3, 5, requires_grad=True)
>>> input2 = torch.randn(3, 5, requires_grad=True)
>>> target = torch.ones(3)
>>> output = loss(input1, input2, target)
>>> output.backward()