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.HuberLoss

class mindspore.nn.HuberLoss(reduction='mean', delta=1.0)

HuberLoss calculate the error between the predicted value and the target value. It has the advantages of both L1Loss and MSELoss.

Assuming that the $x$ and $y$ are 1-D Tensor, length $N$, then calculate the loss of $x$ and $y$ without dimensionality reduction (the reduction parameter is set to "none"). The formula is as follows:

$$\ell (x,y)=L=\{l_1,\dots ,l_N{\}}^{\mathrm{\top }}$$

with

$$\begin{array}{r}{l}_n=\{\begin{array}{ll}0.5\ast (x_n-y_n{)}^2,& \text{if }|x_n-y_n|<delta;\\ delta\ast (|x_n-y_n|-0.5\ast delta),& \text{otherwise. }\end{array}\end{array}$$

where $N$ is the batch size. If reduction is not "none", then:

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

Parameters

• 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.

• delta (Union[int, float]) – The threshold to change between two type of loss. The value must be positive. Default: 1.0 .

Inputs:

• logits (Tensor) - Predicted value, Tensor of any dimension. The data type must be float16 or float32.

• labels (Tensor) - Target value, same dtype and shape as the logits in common cases. However, it supports the shape of logits is different from the shape of labels and they should be broadcasted to each other.

Outputs:

Tensor or Scalar, if reduction is "none", return a Tensor with same shape and dtype as logits. Otherwise, a scalar value will be returned.

Raises

• TypeError – If data type of logits or labels is neither float16 nor float32.

• TypeError – If data type of logits or labels are not the same.

• TypeError – If dtype of delta is neither float nor int.

• ValueError – If delta is less than or equal to 0.

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

• ValueError – If logits and labels have different shapes and cannot be broadcasted to each other.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import mindspore as ms
>>> import mindspore.nn as nn
>>> import numpy as np
>>> # Case 1: logits.shape = labels.shape = (3,)
>>> loss = nn.HuberLoss()
>>> logits = ms.Tensor(np.array([1, 2, 3]), ms.float32)
>>> labels = ms.Tensor(np.array([1, 2, 2]), ms.float32)
>>> output = loss(logits, labels)
>>> print(output)
0.16666667
>>> # Case 2: logits.shape = (3,), labels.shape = (2, 3)
>>> loss = nn.HuberLoss(reduction="none")
>>> logits = ms.Tensor(np.array([1, 2, 3]), ms.float32)
>>> labels = ms.Tensor(np.array([[1, 1, 1], [1, 2, 2]]), ms.float32)
>>> output = loss(logits, labels)
>>> print(output)
[[0.  0.5 1.5]
 [0.  0.  0.5]]