mindspore.ops.cosine_embedding_loss

mindspore.ops.cosine_embedding_loss(input1, input2, target, margin=0.0, reduction='mean')[源代码]

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

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

\[\begin{split}loss(input1, input2, target) = \begin{cases} 1-cos(input1, input2), & \text{if } target = 1\\ max(0, cos(input1, input2)-margin), & \text{if } target = -1\\ \end{cases}\end{split}\]

参数：

input1 (Tensor) - 输入Tensor，shape \((N, *)\) ，其中 \(*\) 代表任意数量的附加维度。
input2 (Tensor) - 输入Tensor，shape \((N, *)\) 。shape和数据类型与 input1 相同。
target (Tensor) - 输入值为1或-1。假设 input1 的shape是 \((x_1, x_2, x_3, ..., x_R)\) ，那么 target 的shape必须是 \((x_1, x_3, x_4, ..., x_R)\) 。
margin (float，可选) - 指定运算的调节因子，取值范围[-1.0, 1.0]。默认值：0.0。
reduction (str，可选) - 指定输出结果的计算方式。可选值为”none”、”mean”或”sum”，分别表示不指定计算方式、使用均值计算和使用求和计算。默认值：”mean”。

返回：

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

异常：

TypeError - margin 不是float。
ValueError - reduction 不为”none”、”mean”或”sum”。
ValueError - margin 的值不在范围[-1.0, 1.0]内。

支持平台：

Ascend GPU CPU

样例：

>>> intput1 = Tensor(np.array([[0.3, 0.8], [0.4, 0.3]]), mindspore.float32)
>>> intput2 = Tensor(np.array([[0.4, 1.2], [-0.4, -0.9]]), mindspore.float32)
>>> target = Tensor(np.array([1, -1]), mindspore.int32)
>>> output = ops.cosine_embedding_loss(intput1, intput2, target)
>>> print(output)
0.0003425479