Skip to content
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.stats: manually document functions to avoid scipy import #20847

Merged
merged 1 commit into from May 1, 2024

Conversation

jakevdp
Copy link
Collaborator

@jakevdp jakevdp commented Apr 19, 2024

This lets us give more implementation-specific information, and lets us avoid a dependency on scipy. Related to #20799.

@jakevdp jakevdp requested a review from hawkinsp April 19, 2024 23:14
@jakevdp jakevdp self-assigned this Apr 19, 2024
Copy link
Member

@hawkinsp hawkinsp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I skimmed the first few, but have the same comments on all.

Not sure if you want to address these or defer them to the future, but we could improve these docs a bit.

jax/_src/scipy/stats/_core.py Show resolved Hide resolved
jax/_src/scipy/stats/_core.py Outdated Show resolved Hide resolved
jax/_src/scipy/stats/_core.py Show resolved Hide resolved
jax/_src/scipy/stats/_core.py Show resolved Hide resolved
a: arraylike
axis: optional integer. If not specified, the input array is flattened.
ddof: integer, default=1. The degrees of freedom in the SEM computation.
nan_policy: str, default="propagate". JAX supports only "propagate" and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double backticks here probably.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean around the string literals?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

jax/_src/scipy/stats/_core.py Show resolved Hide resolved
jax/_src/scipy/stats/bernoulli.py Outdated Show resolved Hide resolved
@jakevdp jakevdp force-pushed the scipy-stats-doc branch 3 times, most recently from 7765d44 to c0cd48a Compare April 22, 2024 20:46
@jakevdp jakevdp requested a review from hawkinsp April 22, 2024 21:07
@jakevdp jakevdp force-pushed the scipy-stats-doc branch 9 times, most recently from d728c1e to ec17e1f Compare April 29, 2024 16:23
a: arraylike
axis: optional integer. If not specified, the input array is flattened.
ddof: integer, default=1. The degrees of freedom in the SEM computation.
nan_policy: str, default="propagate". JAX supports only "propagate" and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

@google-ml-butler google-ml-butler bot added kokoro:force-run pull ready Ready for copybara import and testing labels May 1, 2024
@copybara-service copybara-service bot merged commit 8626b9e into google:main May 1, 2024
13 checks passed
@jakevdp jakevdp deleted the scipy-stats-doc branch May 1, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation pull ready Ready for copybara import and testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants