Skip to content

separate PyTorch/XLA docs #7593

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 8, 2024
Merged

separate PyTorch/XLA docs #7593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1ad5f98
separate PyTorch/XLA docs
JackCaoG Jun 28, 2024
6f35b4b
update index
JackCaoG Jul 8, 2024
be14065
Update index
JackCaoG Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/debug.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../../TROUBLESHOOTING.md
1 change: 1 addition & 0 deletions docs/source/gpu.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../gpu.md
27 changes: 18 additions & 9 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
:github_url: https://github.com/pytorch/xla

PyTorch/XLA documentation
===================================
PyTorch/XLA is a Python package that uses the XLA deep learning compiler to connect the PyTorch deep learning framework and Cloud TPUs.

.. toctree::
:hidden:

self

.. toctree::
:glob:
:maxdepth: 1
:caption: Docs

*

.. mdinclude:: ../../API_GUIDE.md

PyTorch/XLA API
Expand Down Expand Up @@ -90,12 +108,3 @@ debug
.. autofunction:: counter_value
.. autofunction:: metric_names
.. autofunction:: metric_data

.. mdinclude:: ../../TROUBLESHOOTING.md
.. mdinclude:: ../pjrt.md
.. mdinclude:: ../dynamo.md
.. mdinclude:: ../fsdp.md
.. mdinclude:: ../ddp.md
.. mdinclude:: ../gpu.md
.. mdinclude:: ../spmd_basic.md
.. mdinclude:: ../fsdpv2.md
2 changes: 2 additions & 0 deletions docs/source/multi_process_distributed.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. mdinclude:: ../ddp.md
.. mdinclude:: ../fsdp.md
1 change: 1 addition & 0 deletions docs/source/runtime.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../pjrt.md
4 changes: 4 additions & 0 deletions docs/source/spmd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.. mdinclude:: ../spmd_basic.md
.. mdinclude:: ../fsdpv2.md
.. mdinclude:: ../spmd_advanced.md
.. mdinclude:: ../spmd_distributed_checkpoint.md
1 change: 1 addition & 0 deletions docs/source/torch_compile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../dynamo.md