mindspore.nn.CosineEmbeddingLoss

class mindspore.nn.CosineEmbeddingLoss(margin=0.0, reduction='mean')[源代码]

余弦相似度损失函数，用于测量两个Tensor之间的相似性。

给定两个Tensor \(x1\) 和 \(x2\) ，以及一个Tensor标签 \(y\) ，值为1或-1，公式如下：

\[\begin{split}loss(x_1, x_2, y) = \begin{cases} 1-cos(x_1, x_2), & \text{if } y = 1\\ \max(0, cos(x_1, x_2)-margin), & \text{if } y = -1\\ \end{cases}\end{split}\]
参数：

  • margin (float) - 指定运算的调节因子，取值范围[-1.0, 1.0]。默认值： 0.0 。

  • reduction (str，可选) - 指定应用于输出结果的规约计算方式，可选 "none" 、 "mean" 、 "sum" ，默认值： "mean" 。

    • "none"：不应用规约方法。

    • "mean"：计算输出元素的平均值。

    • "sum"：计算输出元素的总和。

输入：

  • logits_x1 (Tensor) - 输入Tensor，shape \((N, *)\) ，其中 \(*\) 代表任意数量的附加维度。

  • logits_x2 (Tensor) - 输入Tensor，shape \((N, *)\) 。shape和数据类型与 logits_x1 相同。

  • labels (Tensor) - 输入值为1或-1。假设 logits_x1 的shape是 \((x_1, x_2, x_3, ..., x_R)\) ，那么 labels 的shape必须是 \((x_1, x_3, x_4, ..., x_R)\) 。

输出：

Tensor或Scalar，如果 reduction 为”none”，其shape与 labels 相同。否则，将返回为Scalar。

异常：

  • TypeError - margin 不是float。

  • ValueError - reduction 不为 "none" 、 "mean" 或 "sum" 。

  • ValueError - margin 的值不在范围[-1.0, 1.0]内。

支持平台：

Ascend GPU CPU

样例：

>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> import numpy as np
>>> logits_x1 = ms.Tensor(np.array([[0.3, 0.8], [0.4, 0.3]]), ms.float32)
>>> logits_x2 = ms.Tensor(np.array([[0.4, 1.2], [-0.4, -0.9]]), ms.float32)
>>> labels = ms.Tensor(np.array([1, -1]), ms.int32)
>>> cosine_embedding_loss = nn.CosineEmbeddingLoss()
>>> output = cosine_embedding_loss(logits_x1, logits_x2, labels)
>>> print(output)
0.0003425479