DOC: Improve docs for jax.numpy: arcsinh, arccosh and arctanh
#23977
+137
−6
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
846ef62
to
261e09e
Compare
jakevdp
reviewed
Sep 27, 2024
jax/_src/numpy/ufuncs.py
Outdated
| .. math:: | ||
| arcsinh(x) = ln(x + \sqrt{1 + x^2}) |
There was a problem hiding this comment.
Here and below, within math expressions please use \ln in place of ln
jakevdp
reviewed
Sep 27, 2024
jax/_src/numpy/ufuncs.py
Outdated
| Note: | ||
| - ``jnp.arctanh`` returns ``nan`` for real-values outside the range ``[-1, 1]``. | ||
| - ``jnp.arctanh`` is equivalent to computing ``1j * jnp.arctan(x / 1j)``. |
There was a problem hiding this comment.
I would remove this: we don't need to note well-known mathematical identities.
There was a problem hiding this comment.
Should I remove this in arcsinh doc also?
There was a problem hiding this comment.
Thanks! Removed.
rajasekharporeddy
force-pushed
the
testbranch1
branch
from
743080b
to
526b1a7
Compare
jakevdp
reviewed
Sep 27, 2024
jakevdp
approved these changes
Sep 27, 2024
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