CosineEmbeddingLoss

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

创建一个损失函数，用于计算输入张量 $x_1$, $x_2$ and a 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}$$

参数

• margin (float, optional) – 应该是一个介于 $-1$ 和 $1$ 之间的数字，建议使用 $0$ 到 $0.5$。如果 margin 未提供，则默认值为 $0$。

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

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

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

形状

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

• Input2: $(N, D)$ 或 $(D)$，形状与 Input1 相同。

• Target: $(N)$ 或 $()$。

• Output: 如果 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()

forward(input1, input2, target)

执行前向传播。

返回类型

张量