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.

PR

Just a small problem.

I can fix it online!

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

class mindspore.ops.L2Normalize(axis=0, epsilon=1e-4)

L2 Normalization Operator.

This operator will normalize the input using the given axis. The function is shown as follows:

$$\begin{array}{c}\text{output}=\frac{x}{\sqrt{\text{max}(\sum _i^{}{\left|x_i\right|}^2,ϵ)}}\end{array}$$

where $ϵ$ is epsilon and $\sum _i^{}{\left|x_i\right|}^2$ calculate the sum of squares of the input x along the dimension axis.

Note

On Ascend, input data type of float64 is currently not supported.

Parameters

• axis (Union[list(int), tuple(int), int], optional) – Specify the axis for calculating the L2 norm. Default: 0 .

• epsilon (float, optional) – A small value added for numerical stability. Default: 1e-4 .

Inputs:

• x (Tensor) - Input to compute the normalization. Tensor of shape $(N,\ast )$, where $\ast$ means any number of additional dimensions. Data type must be float16, float32 or float64.

Outputs:

Tensor, with the same type and shape as the x.

Raises

• TypeError – If axis is not one of the following: list, tuple or int.

• TypeError – If epsilon is not a float.

• TypeError – If x is not a Tensor.

• TypeError – If dtype of x is not in [float16, float32, float64].

• ValueError – If dimension of x is not greater than 0.

Supported Platforms:

Ascend GPU CPU

Examples

>>> import mindspore
>>> import numpy as np
>>> from mindspore import Tensor, ops
>>> l2_normalize = ops.L2Normalize()
>>> x = Tensor(np.random.randint(-256, 256, (2, 3, 4)), mindspore.float32)
>>> output = l2_normalize(x)
>>> print(output.shape)
(2, 3, 4)