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

Create JAX Advanced Tutorials (section, move/create docs) #23165

Merged
merged 1 commit into from
Sep 22, 2024

Conversation

8bitmp3
Copy link
Contributor

@8bitmp3 8bitmp3 commented Aug 21, 2024

Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Several of these sections are duplicative of existing docs (e.g. docs/external-callbacks.md and docs/notebooks/external_callbacks.md.

More work is necessary to de-duplicate these, update indices, and re-direct old URLs to the new locations. See #21064 for an example of how we did this in the past

Also, rather than creating new files, we should move the old files out of docs/_tutorials to their new location, in order to preserve change history.

docs/advanced_tutorials.rst Outdated Show resolved Hide resolved
@jakevdp jakevdp self-assigned this Aug 21, 2024
@8bitmp3 8bitmp3 force-pushed the jax-docs-advanced-tutorials branch 10 times, most recently from 76ac690 to 726c8a2 Compare September 4, 2024 23:51
Copy link
Collaborator

@jakevdp jakevdp left a comment

Choose a reason for hiding this comment

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

Errors are due to the change noted below; also it looks like there are two remaining uses of the understanding-jaxprs reference that need to be updated, one in glossary.rst and one in jit-compilation.md.

docs/tutorials.rst Outdated Show resolved Hide resolved
@8bitmp3 8bitmp3 force-pushed the jax-docs-advanced-tutorials branch 2 times, most recently from 29456b2 to 0fabd73 Compare September 10, 2024 20:59
@8bitmp3 8bitmp3 closed this Sep 11, 2024
@8bitmp3 8bitmp3 reopened this Sep 11, 2024
@8bitmp3 8bitmp3 force-pushed the jax-docs-advanced-tutorials branch 3 times, most recently from 01e315b to 95f7335 Compare September 11, 2024 19:57
docs/conf.py Outdated Show resolved Hide resolved
@8bitmp3
Copy link
Contributor Author

8bitmp3 commented Sep 11, 2024

@jakevdp PTAL

@8bitmp3 8bitmp3 closed this Sep 20, 2024
@8bitmp3 8bitmp3 reopened this Sep 20, 2024
@8bitmp3 8bitmp3 closed this Sep 20, 2024
@8bitmp3 8bitmp3 reopened this Sep 20, 2024
@jakevdp
Copy link
Collaborator

jakevdp commented Sep 21, 2024

As we discussed, the structure of the left-nav dropdown is still not exactly how we'd like it, but we can land and iterate. Thanks for working on this!

@jakevdp jakevdp added the pull ready Ready for copybara import and testing label Sep 21, 2024
@copybara-service copybara-service bot merged commit 3c3bbb8 into jax-ml:main Sep 22, 2024
10 checks passed
@8bitmp3 8bitmp3 deleted the jax-docs-advanced-tutorials branch September 25, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pull ready Ready for copybara import and testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants