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

class mindspore.nn.PoissonNLLLoss(log_input=True, full=False, eps=1e-08, reduction='mean')

Poisson negative log likelihood loss.

The loss is:

$${\mathcal{L}}_D=\sum _{i=0}^{|D|}(x_i-y_i\ln x_i+\ln y_i!)$$

where ${\mathcal{L}}_D$ is the loss, $y_i$ is the target, $x_i$ is the input.

If log_input is True, use $e^{x_i}-y_i{x}_i$ instead of $x_i-y_i\ln x_i$. When calculating logarithms, the lower bound of input is set to eps to avoid numerical errors.

If full is False, the last term $\ln y_i!$ will be omitted, otherwise the last term will be approximated using Stirling formula:

$$n!\approx \sqrt{2\pi n}{\left(\frac{n}{e}\right)}^n$$

Note

Calculating the logarithm of a negative number or the exponent of a large positive number under Ascend will have a different range of return values and results different from those under GPU and CPU.

Parameters

• log_input (bool, optional) – Whether use log input. Default: True.

• full (bool, optional) – Whether include the Stirling approximation term in the loss calculation. Default: False.

• eps (float, optional) – Lower bound of input when calculating logarithms. Default: 1e-08.

• reduction (str, optional) – Apply specific reduction method to the output: ‘none’, ‘mean’, ‘sum’. Default: ‘mean’.

Inputs:

• input (Tensor) - The input Tensor. The shape can be any number of dimensions.

• target (Tensor) - The label Tensor which has the same shape as input.

Outputs:

Tensor or Scalar, if reduction is ‘none’, then output is a tensor and has the same shape as input. Otherwise it is a scalar.

Raises

• TypeError – If reduction is not a str.

• TypeError – If neither input nor target is a tensor.

• TypeError – If dtype of input or target is not currently supported.

Supported Platforms:

Ascend GPU CPU

Examples

>>> x = Tensor([[0.3, 0.7], [0.5, 0.5]])
>>> target = Tensor([[1.0, 2.0], [3.0, 4.0]])
>>> loss = nn.PoissonNLLLoss()
>>> output = loss(x, target)
>>> print(output.asnumpy())
0.3652635