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

Sidebar restructure and minor clean-up #136

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Conversation

pavithraes
Copy link
Contributor

@pavithraes pavithraes commented Dec 20, 2024

This PR:

  • Organizes notebooks into "Tutorials" and "Example applications" dropdown sections
  • Creates a sub-section for "Introduction to data loaders" within "Tutorials"
  • Update several page titles for consistency and with more topic information -- for instance, removing phrases like "using JAX and Flax" where it seemed redundant
  • Makes minor updates to some page text and links
  • Updates contributing guide (closes minor refresh to dev docs needed #132)

I did look into intra-site cross-links. While we can add more cross-links to pages like the data-loaders in several notebooks under example applications, there are already links to specific Grain data loaders and such, which seemed enough. I can include more where relevant in follow-up PRs related to the sidenotes below.

Link to preview: https://jax-ai-stack--136.org.readthedocs.build/en/136/tutorials.html


Sidenotes:

I noticed a few more areas to update but did not include here because it was creeping up the scope:

  • The TensorBoard tutorial page could benefit from narration updates and organizing into sections. I started on it as a part of this PR, but can open a separate scoped-PR.
  • It might be worth updating for consistent:
    • Language and style: Consistent grammatical person ("you" > "we"), voice (active), etc.
    • Page structure: Like having consistent sections for setup and installation, further reading/summary, etc. across most pages. (This is not required for every single page. For example, the getting started page has a good flow, but several others have the similar sections defined differently.)
      Didn't want to include these updates here because some decisions are subjective. Again, I can open a separate scoped-PR for this.
  • The "Introduction to Data Loaders" pages for CPU and GPU are very similar (I believe Jake also noted this earlier). I created a separate sidebar dropdown for now, but we may want to consolidate this into one page with specific notes for different hardware, or have one primary content and document only differences for different hardware in the specific pages.

Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@pavithraes pavithraes changed the title Sidebar restructure and misc clean-up Sidebar restructure and minor clean-up Dec 20, 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.

This looks really great, thanks! Two small comments below.

docs/source/JAX_Vision_transformer.md Outdated Show resolved Hide resolved
docs/source/tutorials.md Outdated Show resolved Hide resolved
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
Signed-off-by: Pavithra Eswaramoorthy <pavithraes@outlook.com>
@jakevdp jakevdp self-assigned this Dec 20, 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.

Looks really great – thanks for working on this! I also love the ideas you have for further clarification & organization.

Thanks!

@jakevdp jakevdp merged commit 9bd430a into jax-ml:main Dec 20, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

minor refresh to dev docs needed
2 participants