mindspore.ops.hinge_embedding_loss

mindspore.ops.hinge_embedding_loss(inputs, targets, margin=1.0, reduction='mean')

Hinge Embedding 损失函数。按输入元素计算输出。衡量输入x和标签y（包含1或-1）之间的损失值。通常被用来衡量两个输入之间的相似度。

mini-batch中的第n个样例的损失函数为：

\[\begin{split}l_n = \begin{cases} x_n, & \text{if}\; y_n = 1,\\ \max \{0, \Delta - x_n\}, & \text{if}\; y_n = -1, \end{cases}\end{split}\]

总损失值为：

\[\begin{split}\ell(x, y) = \begin{cases} \operatorname{mean}(L), & \text{if reduction} = \text{'mean';}\\ \operatorname{sum}(L), & \text{if reduction} = \text{'sum'.} \end{cases}\end{split}\]

其中 \(L = \{l_1,\dots,l_N\}^\top\)。

参数：

• inputs (Tensor) - 预测值，公式中表示为 \(x\)，shape为 \((*)\)。* 代表着任意数量的维度。

• targets (Tensor) - 标签值，公式中表示为 \(y\)，和 logits 具有相同shape，包含1或-1。

• margin (float) - Hinge Embedding Loss公式定义的阈值 \(margin\)。公式中表示为 \(\Delta\)。默认值：1.0。

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

返回：

Tensor或Tensor scalar，根据 \(reduction\) 计算的loss。

异常：

• TypeError - inputs 不是Tensor。

• TypeError - targets 不是Tensor。

• TypeError - margin 不是float。

• ValueError - inputs 和 targets shape不一致。

• ValueError - reduction 不是”none”、”mean”或者”sum”。

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> import mindspore.common.dtype as mstype
>>> import mindspore.ops as ops
>>> from mindspore import Tensor
>>> arr1 = np.array([0.9, -1.2, 2, 0.8, 3.9, 2, 1, 0, -1]).reshape((3, 3))
>>> arr2 = np.array([1, 1, -1, 1, -1, 1, -1, 1, 1]).reshape((3, 3))
>>> logits = Tensor(arr1, mstype.float32)
>>> labels = Tensor(arr2, mstype.float32)
>>> loss = ops.hinge_embedding_loss(logits, labels, margin=1.0, reduction='mean')
>>> print(loss)
0.16666666