-
Notifications
You must be signed in to change notification settings - Fork 6.8k
fix doc for the op sort() and argsort() #15317
Conversation
@mxnet-label-bot add [Doc, pr-awaiting-review] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the last axis example might need to be updated for clarity...please verify.
@@ -114,7 +114,7 @@ Examples:: | |||
[ 1., 3.]] | |||
|
|||
// flattens and then sorts | |||
sort(x) = [ 1., 1., 3., 4.] | |||
sort(x, axis=None) = [ 1., 1., 3., 4.] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sort makes sense.
But I'm thrown off by the other example. Sorting along the last axis would be 3 then 4 unless it is descending rather than ascending. Does this need to be specified for clarity?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi,
Thanks for your reply!
Do you mean this example?
// sorts along the last axis
sort(x) = [[ 1., 4.], [ 1., 3.]]
Since x = [[ 1, 4],[ 3, 1]]
, the pairs in the last axis are [1,4]
and [3,1]
. Sorting only along the last axis in a descend way would be [1,4]
and [1,3]
. So, in my opinion, it is correct? or maybe I'm wrong?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested it in numpy and it matches fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry that I didn't get your point. What I did wrong in this PR?
If the argument axis=None
is not given, this function will sort the array alone the last axis. However, in the second example, we want the array to be flattened and then sorted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything is fine. I might have needed more examples to see the patterns, but I understand that if you're conversant with NumPy then this all works as expected.
@mxnet-label-bot add [pr-awaiting-merge] is this good to go? |
Description
Errors in the example of
sort()
andargsort()
. Those op flatten and sort the array only whenaxis=None
is given explicitly.Checklist