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.mint.linalg.vector_norm

mindspore.mint.linalg.vector_norm(x, ord=2, dim=None, keepdim=False, *, dtype=None)

Returns the vector norm of the given tensor on the specified dimensions.

ord is the calculation mode of norm. The following norm modes are supported.

ord	norm for vectors
2 (Default)	2-norm (see below)
inf	$max(abs(x))$
-inf	$min(abs(x))$
0	$sum(x!=0)$
other int or float	$sum(abs(x{)}^{ord}{)}^{(1/ord)}$

Warning

This is an experimental API that is subject to change or deletion.

Parameters

• x (Tensor) – Tensor of shape $(\ast )$ where * is zero s more batch dimensions.

• ord (Union[bool, int, float, inf, -inf], optional) – norm's mode. refer to the table above for behavior. Default: 2 .

• dim (Union[int, List(int), Tuple(int)], optional) –

  The dimensions along which to perform the vector norm calculation. Default: None .

  • When dim is an integer, a list or a tuple, the norm calculation will be performed across these specified dimensions, while the remaining dimensions will be considered as batch dimensions.

  • When dim is None, the norm will be calculated after flattening the Tensor x .

• keepdim (bool) – whether the output Tensor retains the original dimension. Default: False .

Keyword Arguments

dtype (mindspore.dtype, optional) – When set, x will be converted to the specified type, dtype before execution, and dtype of returned Tensor will also be dtype. When dtype is None , the dtype of x is preserved. Default: None .

Returns

Tensor, the result of norm calculation on the specified dimension, dim.

Raises

• TypeError – If x is not a Tensor.

• TypeError – If dim is neither an int nor a list or tuple.

• ValueError – If ord is not in [bool, int, float, inf, -inf].

• ValueError – The elements of dim are duplicate.

• ValueError – If any elements of dim is out of range.

Supported Platforms:

Ascend

Examples

>>> import mindspore as ms
>>> x = ms.ops.arange(0, 12, dtype=ms.float32) - 6
>>> print(ms.mint.linalg.vector_norm(x, ord=2))
12.083046
>>> print(ms.mint.linalg.vector_norm(x, ord=float('inf')))
6.0
>>> print(ms.mint.linalg.vector_norm(x, ord=float('-inf')))
0.0
>>> print(ms.mint.linalg.vector_norm(x, ord=0))
11.0
>>> print(ms.mint.linalg.vector_norm(x, ord=4.5))
7.2243643