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.

Document feedback

mindspore.ops.ArgMaxWithValue

class mindspore.ops.ArgMaxWithValue(axis=0, keep_dims=False)[source]

Calculates the maximum value along with the given axis for the input tensor and, returns the maximum values and indices.

Note

In auto_parallel and semi_auto_parallel mode, the first output index can not be used.

Warning

If there are multiple maximum values, the index of the first maximum value is used.
The value range of “axis” is [-dims, dims - 1]. “dims” is the dimension length of “x”.

Also see: func: mindspore.ops.max.

Parameters

axis (int) – The dimension to reduce. Default: 0.
keep_dims (bool) – Whether to reduce dimension, if true, the output will keep same dimension with the input, the output will reduce dimension if false. Default: False.

Inputs:

x (Tensor) - The input tensor, can be any dimension. Set the shape of input tensor as $(x_{1}, x_{2}, . . ., x_{N})$ .

Outputs:

tuple (Tensor), tuple of 2 tensors, containing the corresponding index and the maximum value of the input tensor.

index (Tensor) - The index for the maximum value of the input tensor, with dtype int32. If keep_dims is true, the shape of output tensors is $(x_{1}, x_{2}, . . ., x_{a x i s - 1}, 1, x_{a x i s + 1}, . . ., x_{N})$ . Otherwise, the shape is $(x_{1}, x_{2}, . . ., x_{a x i s - 1}, x_{a x i s + 1}, . . ., x_{N})$ .
values (Tensor) - The maximum value of input tensor, with the same shape as index, and same dtype as x.

Raises

TypeError – If x is not Tensor.
TypeError – If keep_dims is not a bool.
TypeError – If axis is not an int.

Supported Platforms:: Ascend GPU CPU

Examples

>>> input_x = Tensor(np.array([0.0, 0.4, 0.6, 0.7, 0.1]), mindspore.float32)
>>> index, output = ops.ArgMaxWithValue()(input_x)
>>> print(index, output)
3 0.7
>>> index, output = ops.ArgMaxWithValue(keep_dims=True)(input_x)
>>> print(index, output)
[3] [0.7]