[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU #23889

copybara-service · 2024-09-24T22:35:14Z

[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU

This fixes #22817

This changes is originally proposed by @justinjfu in the comments of the above issue.

This PR is related to #23885.

@justinjfu

…the instructions of running the existing example on TPU This fixes #22817 This changes is originally proposed by @justinjfu in the comments of the above issue. This PR is related to #23885. PiperOrigin-RevId: 679487218

This PR uses the same method to add cross references as the previous PR #23889 --- The content below is for future references. Useful commands: ```sh # sync *.md to *.ipynb jupytext docs/pallas/quickstart.md -o docs/pallas/quickstart.ipynb # build documentation sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto ``` Create labels in *.md: ```md (pallas_block_specs_by_example)= ``` Reference a label in *.md ```md {ref}`pallas_block_specs_by_example` ``` Create labels in *.rst: ```rst .. _pallas_tpu_noteworthy_properties: ``` PiperOrigin-RevId: 681675621

This PR uses the same method to add cross references as the previous PR #23889. --- The content below is for future references. Useful commands: ```sh # sync *.md to *.ipynb jupytext docs/pallas/quickstart.md -o docs/pallas/quickstart.ipynb # build documentation sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto ``` Create a label in *.md: ```md (pallas_block_specs_by_example)= ``` Create a label in *.rst: ```rst .. _pallas_tpu_noteworthy_properties: ``` Reference a label in *.md ```md {ref}`pallas_block_specs_by_example` ``` PiperOrigin-RevId: 681675621

This PR uses the same method to add cross references as the previous PR #23889. --- The content below is for future references. #### Useful commands Build documentation: ```sh sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto ``` Create a label in *.md: ```md (pallas_block_specs_by_example)= ``` Create a label in *.rst: ```rst .. _pallas_tpu_noteworthy_properties: ``` Reference a label in *.md ```md {ref}`pallas_block_specs_by_example` ``` PiperOrigin-RevId: 681675621

This PR uses the same method to add cross references as the previous PR #23889. --- The content below is for future references. #### Useful commands Build documentation: ```sh sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto ``` Create a label in *.md: ```md (pallas_block_specs_by_example)= ``` Create a label in *.rst: ```rst .. _pallas_tpu_noteworthy_properties: ``` Reference a label in *.md: ```md {ref}`pallas_block_specs_by_example` ``` Sync changes from *.md to *.ipynb: ```sh jupytext --sync docs/pallas/tpu/distributed.md ``` PiperOrigin-RevId: 681675621

This PR uses the same method to add cross references as the previous PR #23889. --- The content below is for future references. #### Useful commands Build documentation: ```sh sphinx-build -b html -D nb_execution_mode=off docs docs/build/html -j auto ``` Create a label in *.md: ```md (pallas_block_specs_by_example)= ``` Create a label in *.rst: ```rst .. _pallas_tpu_noteworthy_properties: ``` Reference a label in *.md: ```md {ref}`pallas_block_specs_by_example` ``` Sync changes from *.md to *.ipynb: ```sh jupytext --sync docs/pallas/tpu/distributed.md ``` PiperOrigin-RevId: 682034607

copybara-service bot assigned ayaka14732 Sep 24, 2024

copybara-service bot force-pushed the test_678420788 branch 9 times, most recently from d7bd3a3 to 1673ef9 Compare September 26, 2024 21:51

copybara-service bot force-pushed the test_678420788 branch 3 times, most recently from abf2dd7 to 0028c19 Compare September 27, 2024 08:08

copybara-service bot force-pushed the test_678420788 branch from 0028c19 to ab4590c Compare September 27, 2024 08:33

copybara-service bot merged commit ab4590c into main Sep 27, 2024
1 of 2 checks passed

copybara-service bot deleted the test_678420788 branch September 27, 2024 08:33

copybara-service bot mentioned this pull request Oct 3, 2024

[Pallas] [Docs] Replace full urls with label-based cross references #24091

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU #23889

[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU #23889

copybara-service bot commented Sep 24, 2024 •

edited

Loading

[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU #23889

[Pallas TPU] Add a note in the Pallas Quickstart documentation about the instructions of running the existing example on TPU #23889

Conversation

copybara-service bot commented Sep 24, 2024 • edited Loading

copybara-service bot commented Sep 24, 2024 •

edited

Loading