mindspore.ops.hinge_embedding_loss

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

Hinge Embedding 损失函数，衡量输入 inputs 和标签 targets （包含1或-1）之间的损失值。

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

$$\begin{array}{r}{l}_n=\{\begin{array}{ll}{x}_n,& \text{if}{y}_n=1,\\ max\{0,\mathrm{\Delta }-x_n\},& \text{if}{y}_n=-1,\end{array}\end{array}$$

总损失值为：

$$\begin{array}{r}\ell (x,y)=\{\begin{array}{ll}\mathrm{mean}(L),& \text{if reduction}=\text{'mean';}\\ \mathrm{sum}(L),& \text{if reduction}=\text{'sum'.}\end{array}\end{array}$$

其中 $L=\{l_1,\dots ,l_N{\}}^{\mathrm{\top }}$。

参数：

• inputs (Tensor) - 预测值，公式中表示为 $x$。

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

• margin (float, int) - Hinge Embedding Loss公式定义的阈值 margin。公式中表示为 $\mathrm{\Delta }$。默认 1.0 。

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

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

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

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

返回：

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

异常：

• TypeError - inputs 不是Tensor。

• TypeError - targets 不是Tensor。

• TypeError - margin 不是float或者int。

• ValueError - inputs 和 targets shape不一致且不能广播。

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

支持平台：

Ascend GPU CPU

样例：

>>> import numpy as np
>>> import mindspore.common.dtype as mstype
>>> from mindspore import 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