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.

Sign up for GitHub

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

Jump to bottom

Document jax.lax APIs #26219

Open
jakevdp opened this issue Jan 30, 2025 · 0 comments
Open

Document jax.lax APIs #26219

jakevdp opened this issue Jan 30, 2025 · 0 comments
Assignees
@jakevdp
Labels
documentation

Comments

@jakevdp
Copy link
Collaborator

jakevdp commented Jan 30, 2025 •
edited
Loading

Most docstrings for jax.lax APIs are just short stubs at the moment. We should add documentation including:

  • one-line short description
  • what primitive & HLO operation they lower to
  • Args: section mentioning shape/dtype requirements (if any)
  • Returns: section mentioning output shape/dtype
  • Notes: section with unexpected conventions or dtype-dependent behavior
  • Examples: section, but only when they would add clarity (e.g. we don't need an example showing that lax.sin computes the sine)

#26220 is an example of updating a few docstrings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jakevdp jakevdp

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jakevdp