-
Notifications
You must be signed in to change notification settings - Fork 583
[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
base: main
Are you sure you want to change the base?
Conversation
Greptile SummaryThis PR refactors the Getting Started documentation by consolidating the PyTorch and JAX quickstart notebooks into a unified guide using sphinx-tabs. The new structure provides a side-by-side comparison of both frameworks with progressive optimization examples. Major Changes:
Benefits:
Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant Author as PR Author
participant Docs as Documentation System
participant User as Documentation User
Author->>Docs: Remove old notebooks (quickstart.ipynb, quickstart_jax.ipynb)
Author->>Docs: Create getting_started/ directory structure
Author->>Docs: Add getting_started_pytorch.py with examples
Author->>Docs: Add getting_started_jax.py with examples
Author->>Docs: Add utility scripts (utils_pytorch.py, utils_jax.py)
Author->>Docs: Run benchmarks and capture outputs (.out files)
Author->>Docs: Generate summary CSV files with performance data
Author->>Docs: Create index.rst with sphinx-tabs integration
Author->>Docs: Add custom CSS (rtabs.css, output-style.css)
Author->>Docs: Add transformer_layer.svg diagram
Author->>Docs: Update conf.py with sphinx_tabs extension
Author->>Docs: Update workflow to install sphinx-tabs dependency
Author->>Docs: Update main index.rst to reference new location
User->>Docs: Visit Getting Started page
Docs->>User: Display unified guide with PyTorch/JAX tabs
User->>Docs: Select framework tab (PyTorch or JAX)
Docs->>User: Show framework-specific examples and benchmarks
User->>Docs: View progressive optimization steps
Docs->>User: Display performance improvements at each step
|
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]>
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: