Conversation
Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
4a4d495 to
0aee443
Compare
Greptile OverviewGreptile SummaryThis PR fixes broken documentation links that pointed to a non-existent Changes:
All target files have been verified to exist in the repository. This is a straightforward documentation fix with no code changes. Confidence Score: 5/5
Important Files Changed
Sequence DiagramsequenceDiagram
participant User
participant README.rst
participant examples/README.md
participant Old Link
participant New Links
User->>README.rst: Click quickstart link
README.rst->>Old Link: quickstart.ipynb
Old Link-->>User: 404 - File not found
Note over README.rst,examples/README.md: PR fixes broken links
User->>README.rst: Click updated link
README.rst->>New Links: te_jax_integration.ipynb or getting_started/index.rst
New Links-->>User: Valid documentation loaded
User->>examples/README.md: Click TE tutorial link
examples/README.md->>New Links: te_jax_integration.ipynb
New Links-->>User: Valid tutorial loaded
|
| loss, (param_grads, other_grads) = fwd_bwd_fn(params, other_variables, inp) | ||
|
|
||
| For a more comprehensive tutorial, check out our `Quickstart Notebook <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/quickstart.ipynb>`_. | ||
| For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_. |
There was a problem hiding this comment.
Hi, could you switch the order of those to have the Getting Started page as the first one?
There was a problem hiding this comment.
Actually, maybe we should instead just point to the Getting Started HTML page here: https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/getting_started.html
|
Thanks for the contribution - I left one small comment and then we can merge. |
| loss, (param_grads, other_grads) = fwd_bwd_fn(params, other_variables, inp) | ||
|
|
||
| For a more comprehensive tutorial, check out our `Quickstart Notebook <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/quickstart.ipynb>`_. | ||
| For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_. |
There was a problem hiding this comment.
| For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_. | |
| For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/getting_started.html>`_. |
Description
Fixed broken links to non-existent
quickstart.ipynbfile in documentation.Fixes #2640
Type of change
Changes
README.rst(line 140) to point to existing tutorials:te_jax_integration.ipynb)docs/getting_started/index.rst)examples/README.md(line 26) to point to JAX Integration TutorialChecklist: