DOC: Better doc for jnp.rot90
#23451
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rajasekharporeddy
force-pushed
the
testbranch1
branch
from
461801f
to
809a70b
Compare
jakevdp
requested changes
Sep 5, 2024
jax/_src/numpy/lax_numpy.py
Outdated
| An array containing the elements of ``m`` rotated by 90 degrees. | ||
|
|
||
| Note: | ||
| - Unlike :func:`numpy.rot90`, :func:`jax.numpy.rot90` will return a copy rather |
There was a problem hiding this comment.
I don't think we need to say this here – it's true of every JAX API.
The reason we included this text in lax_description previously was that the numpy docs explicitly mention that the output is a view rather than a copy,. Now that we're not using NumPy's docs, we don't need text that corrects them.
If you're worried about this, you could mention under Returns: that the result is a copy of the input
There was a problem hiding this comment.
Thanks! I have seen a similar note in APIs like jnp.transpose and jnp.matrix_transpose in the updated docs. So, I have included the note for this API also. Can we remove the note in those APIs also?
jakevdp
reviewed
Sep 5, 2024
rajasekharporeddy
force-pushed
the
testbranch1
branch
from
3192ba2
to
ee67c41
Compare
|
Thanks! Squashed into single commit. |
jakevdp
approved these changes
Sep 5, 2024
google-ml-butler
bot
added
kokoro:force-run
pull ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #21461
Rendered Preview: