mindspore.nn.HingeEmbeddingLoss

class mindspore.nn.HingeEmbeddingLoss(margin=1.0, reduction='mean')

Hinge Embedding 损失函数。按输入元素计算输出。衡量输入张量x和标签y（包含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 }}$。

参数：

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

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

输入：

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

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

返回：

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

异常：

• TypeError - logits 不是Tensor。

• TypeError - labels 不是Tensor。

• TypeError - margin 不是float。

• ValueError - labels 和 logits shape不一致。

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

支持平台：

Ascend GPU CPU