DOC: Add flat examples to argmax and argmin #28826
Conversation
| @@ -1306,6 +1306,8 @@ def argmax(a, axis=None, out=None, *, keepdims=np._NoValue): | |||
|
|
|||
| Indexes of the maximal elements of a N-dimensional array: | |||
|
|
|||
| >>> a.flat[np.argmax(a)] | |||
There was a problem hiding this comment.
This seems like a useful addition to the docs, but the example code does not match the text above (e.g. Indexes of the maximal elements of a N-dimensional array:). Maybe move this a bit down (after the a[ind] example)? Or rename the text to Indices and values of the maximal ...
Note: both Indexes and Indices are correct, but it is a bit inconsistent to have the docs of argmin and argmax use a different form.
There was a problem hiding this comment.
That seems to me like it could be a separate change. The addition just shows how to simply use the index without having to unravel it first; the raw form is used to actually to get the value, but that was already the case with the unraveled form. (and unlike the unraveled form, the raw index already appears above, so seemed to me like it's not worth repeating).
There was a problem hiding this comment.
The addition just shows how to simply use the index without having to unravel it first
The point of the section that starts with "Indexes of the maximal elements of a N-dimensional array:" is to show how to obtain the indices of the maximal elements when using axis=None. Is your addition relevant to that section?
There was a problem hiding this comment.
Sure! Just like existing first example it precedes in each of argmin/argmax shows how to obtain and take the value at an index by using unravel_index, this one shows how to do it by using flat.
No description provided.