-
Notifications
You must be signed in to change notification settings - Fork 599
[docs] Getting started refactor #2534
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
Conversation
Greptile SummaryRefactored getting started documentation from separate Jupyter notebooks to unified RST format with sphinx tabs for PyTorch and JAX frameworks.
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant Sphinx
participant Browser
participant TabsExt as Sphinx Tabs Extension
User->>Sphinx: Build documentation
Sphinx->>Sphinx: Load conf.py with sphinx_tabs.tabs extension
Sphinx->>Sphinx: Parse getting_started/index.rst
Sphinx->>TabsExt: Process .. tabs:: directives
TabsExt->>TabsExt: Generate PyTorch/JAX tab HTML
TabsExt->>Sphinx: Return processed content
Sphinx->>Sphinx: Include literalinclude from .py files
Sphinx->>Sphinx: Include output from .out files
Sphinx->>Sphinx: Include CSV tables from summary.csv
Sphinx->>Sphinx: Apply custom CSS (rtabs.css, output-style.css)
Sphinx->>Browser: Generate HTML documentation
Browser->>User: Display getting started page
User->>Browser: Click PyTorch/JAX tab
Browser->>Browser: Switch tab content (JavaScript)
Browser->>User: Show framework-specific tutorial
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Additional Comments (1)
-
docs/getting_started/transformer_layer.svg, line 1 (link)style: Three identical copies of this SVG exist in the PR:
docs/_static/images/transformer_layer.svgdocs/getting_started/transformer_layer.svg(this file)docs/getting_started/_images/transformer_layer.svg
The documentation at
docs/getting_started/index.rst:53referencestransformer_layer.svgdirectly, which should work. Consider keeping only one copy (preferably in_static/images/or the current directory) to avoid redundancy.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
15 files reviewed, 1 comment
5a547ca to
a9b4e62
Compare
- Add new Getting Started documentation with PyTorch and JAX tutorials - Include benchmark scripts demonstrating TE performance benefits - Add CSS styling for code output and tabs - Replace old quickstart notebooks with improved documentation - Add transformer layer diagram (SVG) - Update docs configuration and workflow Signed-off-by: Pawel Gadzinski <[email protected]>
a9b4e62 to
802c747
Compare
for more information, see https://pre-commit.ci
Signed-off-by: Pawel Gadzinski <[email protected]>
for more information, see https://pre-commit.ci
Signed-off-by: Pawel Gadzinski <[email protected]>
jberchtold-nvidia
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks! Checked out the built docs locally and they look great! I also like how you set it up so all the JAX code for getting started is in a single getting_started_jax.py and same for PyTorch, so we get the benefit of both a) a unified tutorial doc with tabs, but also b) users wanting to work with directly JAX don't have to look thru a notebook with both PyTorch/JAX and could easily build off of this by editing the python file or even from getting_start_jax import SomeLayer while exploring TE
tdophung
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Pawel Gadzinski <[email protected]>
Description
Refactored getting started in the docs by adding sphinx tabs.
It's better to download the artifact rather than reading the changes.
Type of change
Checklist: