-
Notifications
You must be signed in to change notification settings - Fork 2.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
jax.scipy.special: manually document functions to avoid scipy import #20822
Conversation
ede328e
to
dba5a2c
Compare
dba5a2c
to
d88eb4d
Compare
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.
Same general comments on these:
- use type links where possible for
Array
andArrayLike
- at least link to definition of the math in each case (Wikipedia being good), although having formulae is better where we can.
- an example would be peachy.
Doable?
It's all doable, it's just about how much time we want to invest
This is done automatically by sphinx; e.g. https://jax--20822.org.readthedocs.build/en/20822/_autosummary/jax.scipy.special.bernoulli.html#jax.scipy.special.bernoulli
I linked to the numpy documentation in each case, which generally includes the math. Is that sufficient? |
d88eb4d
to
25c5678
Compare
Mathematical definitions added |
34d2369
to
4c28a01
Compare
This lets us give more implementation-specific information, and lets us avoid a needless dependency on scipy.
4c28a01
to
74f1d88
Compare
This lets us give more implementation-specific information, and lets us avoid a dependency on scipy. Related to #20799.
Preview rendered docstrings here: https://jax--20822.org.readthedocs.build/en/20822/jax.scipy.html#module-jax.scipy.special
Part of #21461.