Document feedback

Question document fragment

When a question document fragment contains a formula, it is displayed as a space.

Submission type

issue

It's a little complicated...

I'd like to ask someone.

Please select the submission type

Problem type

Specifications and Common Mistakes

- Specifications and Common Mistakes:

- Misspellings or punctuation mistakes,incorrect formulas, abnormal display.

- Incorrect links, empty cells, or wrong formats.

- Chinese characters in English context.

- Minor inconsistencies between the UI and descriptions.

- Low writing fluency that does not affect understanding.

- Incorrect version numbers, including software package names and version numbers on the UI.

Usability

- Usability:

- Incorrect or missing key steps.

- Missing main function descriptions, keyword explanation, necessary prerequisites, or precautions.

- Ambiguous descriptions, unclear reference, or contradictory context.

- Unclear logic, such as missing classifications, items, and steps.

Correctness

- Correctness:

- Technical principles, function descriptions, supported platforms, parameter types, or exceptions inconsistent with that of software implementation.

- Incorrect schematic or architecture diagrams.

- Incorrect commands or command parameters.

- Incorrect code.

- Commands inconsistent with the functions.

- Wrong screenshots.

- Sample code running error, or running results inconsistent with the expectation.

Risk Warnings

- Risk Warnings:

- Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

- Content Compliance:

- Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions.

- Copyright infringement.

Please select the type of question

Problem description

Describe the bug so that we can quickly locate the problem.

Submit

Document feedback

mindspore.nn.HingeEmbeddingLoss

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

Calculate the Hinge Embedding Loss value based on the input ‘logits’ and’ labels’ (only including 1 or -1). Usually used to measure the similarity between two inputs.

The loss function for $n$-th sample in the mini-batch is

$$\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}$$

and the total loss functions is

$$\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}$$

where $L=\{l_1,\dots ,l_N{\}}^{\mathrm{\top }}$.

Parameters

• margin (float, int) – Threshold defined by Hinge Embedding Loss $margin$. Represented as $\mathrm{\Delta }$ in the formula. Default: 1.0.

• reduction (str) – Specify the computing method to be applied to the outputs: ‘none’, ‘mean’, or ‘sum’. Default: ‘mean’.

Inputs:

• logits (Tensor) - The predicted value, expressed as $x$ in the equation. Tensor of shape $(\ast )$ where $\ast$ means any number of dimensions.

• labels (Tensor) - Label value, represented as $y$ in the equation. Same shape as the logits, contains -1 or 1.

Returns

Tensor or Tensor scalar, the computed loss depending on $reduction$.

Raises

• TypeError – If logits is not a Tensor.

• TypeError – If labels is not a Tensor.

• TypeError – If margin is not a float or int.

• ValueError – If labels does not have the same shape as logits or they could not broadcast to each other.

• ValueError – If reduction is not one of ‘none’, ‘mean’, ‘sum’.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import numpy as np
>>> from mindspore import Tensor
>>> import mindspore.nn as nn
>>> import mindspore.common.dtype as mstype
>>> 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 = nn.HingeEmbeddingLoss(reduction='mean')
>>> output = loss(logits, labels)
>>> print(output)
0.16666667