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

Document methods of custom_jvp/custom_vjp #23069

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

jakevdp
Copy link
Collaborator

@jakevdp jakevdp commented Aug 14, 2024

Replaces #22895

I think this is a better approach than using autoclass, since the URL for the generated docs does not change and the cross-references to the methods now work correctly.

Rendered preview (in particular, notice how the methods section in each case now has links to the appropriate docs):

I tackled this as a warmup for doing the same treatment to jax.Array

@jakevdp jakevdp requested a review from cgarciae August 14, 2024 22:09
@jakevdp jakevdp self-assigned this Aug 14, 2024
@google-ml-butler google-ml-butler bot added kokoro:force-run pull ready Ready for copybara import and testing labels Aug 15, 2024
@copybara-service copybara-service bot merged commit 527a4b8 into jax-ml:main Aug 15, 2024
16 checks passed
@jakevdp jakevdp deleted the doc-vjp branch August 15, 2024 20:30
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.

3 participants