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.ops.multilabel_margin_loss

mindspore.ops.multilabel_margin_loss(input, target, reduction='mean')

Hinge loss for optimizing a multi-label classification.

Creates a criterion that optimizes a multi-label multi-classification hinge loss (margin-based loss) between input $x$ (a 2D mini-batch Tensor) and output $y$ (which is a 2D Tensor of target class indices). For each sample in the mini-batch:

$$\text{loss}(x,y)=\sum _{ij}\frac{max(0,1-(x[y[j]]-x[i]))}{\text{x.size}(0)}$$

where $x\in \{0,\cdots ,\text{x.size}(0)-1\}$, $y\in \{0,\cdots ,\text{y.size}(0)-1\}$, $0\le y[j]\le \text{x.size}(0)-1$, and $i\ne y[j]$ for all $i$ and $j$. $y$ and $x$ must have the same size. The criterion only considers a contiguous block of non-negative targets that starts at the front. This allows for different samples to have variable amounts of target classes.

Parameters

• input (Tensor) – Predict data, $x$ in the formula above. Tensor of shape $(C)$ or $(N,C)$, where $N$ is the batch size and $C$ is the number of classes. Data type must be float16 or float32.

• target (Tensor) – Ground truth data, $y$ in the formula above, with the same shape as input, data type must be int32 and label targets padded by -1.

• reduction (str, optional) –

  Apply specific reduction method to the output: 'none' , 'mean' , 'sum' . Default: 'mean' .

  • 'none': no reduction will be applied.

  • 'mean': compute and return the mean of elements in the output.

  • 'sum': the output elements will be summed.

Returns

• outputs (Union[Tensor, Scalar]) - The loss of MultilabelMarginLoss. If reduction is "none", its shape is $(N)$. Otherwise, a scalar value will be returned.

Raises

• TypeError – If input or target is not a Tensor.

• TypeError – If dtype of input is neither float16 nor float32.

• TypeError – If dtype of target is not int32.

• ValueError – If length of shape of input is neither 1 nor 2.

• ValueError – If shape of input is not the same as target.

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

Supported Platforms:

Ascend GPU

Examples

>>> import mindspore
>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> inputs = Tensor(np.array([[0.1, 0.2, 0.4, 0.8], [0.2, 0.3, 0.5, 0.7]]), mindspore.float32)
>>> target = Tensor(np.array([[1, 2, 0, 3], [2, 3, -1, 1]]), mindspore.int32)
>>> output = ops.multilabel_margin_loss(inputs, target)
>>> print(output)
0.325