dpnp.argmax

dpnp.argmax(a, axis=None, out=None, *, keepdims=False)[source]

Returns the indices of the maximum values along an axis.

For full documentation refer to numpy.argmax.

Parameters:

a ({dpnp.ndarray, usm_ndarray}) – Input array.
axis (int, optional) – Axis along which to search. If None, the function must return the index of the maximum value of the flattened array. Default: None.
out ({None, dpnp.ndarray, usm_ndarray}, optional) – If provided, the result will be inserted into this array. It should be of the appropriate shape and dtype.
keepdims (bool) – If True, the reduced axes (dimensions) must be included in the result as singleton dimensions, and, accordingly, the result must be compatible with the input array. Otherwise, if False, the reduced axes (dimensions) must not be included in the result. Default: False.

Returns:

out – If axis is None, a zero-dimensional array containing the index of the first occurrence of the maximum value; otherwise, a non-zero-dimensional array containing the indices of the minimum values. The returned array must have the default array index data type.

Return type:

dpnp.ndarray

See also

dpnp.ndarray.argmax: Equivalent function.
dpnp.nanargmax: Returns the indices of the maximum values along an axis, igonring NaNs.
dpnp.argmin: Returns the indices of the minimum values along an axis.
dpnp.max: The maximum value along a given axis.
dpnp.unravel_index: Convert a flat index into an index tuple.
dpnp.take_along_axis: Apply np.expand_dims(index_array, axis) from argmax to an array as if by calling max.

Notes

In case of multiple occurrences of the maximum values, the indices corresponding to the first occurrence are returned.

Examples

>>> import dpnp as np
>>> a = np.arange(6).reshape((2, 3)) + 10
>>> a
array([[10, 11, 12],
       [13, 14, 15]])
>>> np.argmax(a)
array(5)

>>> np.argmax(a, axis=0)
array([1, 1, 1])
>>> np.argmax(a, axis=1)
array([2, 2])

>>> b = np.arange(6)
>>> b[1] = 5
>>> b
array([0, 5, 2, 3, 4, 5])
>>> np.argmax(b)  # Only the first occurrence is returned.
array(1)

>>> x = np.arange(24).reshape((2, 3, 4))
>>> res = np.argmax(x, axis=1, keepdims=True) # Setting keepdims to True
>>> res.shape
(2, 1, 4)