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

DOC: Improve docstrings for jax.scipy.linalg #21018

Merged
merged 1 commit into from
May 2, 2024

Conversation

jakevdp
Copy link
Collaborator

@jakevdp jakevdp commented Apr 30, 2024

More docstrings toward the joint goals of (1) improving our API docs, and (2) removing our runtime dependency on scipy, which is mostly used for runtime extraction of docstrings.

Rendered preview: https://jax--21018.org.readthedocs.build/en/21018/jax.scipy.html#module-jax.scipy.linalg

Part of #21461.

@jakevdp jakevdp self-assigned this Apr 30, 2024
@jakevdp jakevdp marked this pull request as draft April 30, 2024 21:41
@jakevdp jakevdp force-pushed the scipy-linalg-docs branch 7 times, most recently from 04f8400 to 0c33332 Compare May 1, 2024 20:59
@jakevdp jakevdp changed the title WIP: Add better docstrings in jax.scipy.linalg Improve docstrings for jax.scipy.linalg May 1, 2024
@jakevdp jakevdp requested a review from hawkinsp May 1, 2024 20:59
@jakevdp jakevdp marked this pull request as ready for review May 1, 2024 20:59
@jakevdp jakevdp changed the title Improve docstrings for jax.scipy.linalg DOC: Improve docstrings for jax.scipy.linalg May 1, 2024
jax/_src/scipy/linalg.py Show resolved Hide resolved
jax/_src/scipy/linalg.py Outdated Show resolved Hide resolved
@google-ml-butler google-ml-butler bot added kokoro:force-run pull ready Ready for copybara import and testing labels May 2, 2024
@copybara-service copybara-service bot merged commit d02ec9f into google:main May 2, 2024
13 checks passed
@jakevdp jakevdp deleted the scipy-linalg-docs branch May 2, 2024 01:08
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