diff --git a/docs/source/debug.rst b/docs/source/debug.rst new file mode 100644 index 000000000000..7c6a6eee671c --- /dev/null +++ b/docs/source/debug.rst @@ -0,0 +1 @@ +.. mdinclude:: ../../TROUBLESHOOTING.md \ No newline at end of file diff --git a/docs/source/gpu.rst b/docs/source/gpu.rst new file mode 100644 index 000000000000..79d8385467a1 --- /dev/null +++ b/docs/source/gpu.rst @@ -0,0 +1 @@ +.. mdinclude:: ../gpu.md \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 0d7182a45f1c..5ebf1af2f809 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 @@ -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 diff --git a/docs/source/multi_process_distributed.rst b/docs/source/multi_process_distributed.rst new file mode 100644 index 000000000000..f8f25e5c05a8 --- /dev/null +++ b/docs/source/multi_process_distributed.rst @@ -0,0 +1,2 @@ +.. mdinclude:: ../ddp.md +.. mdinclude:: ../fsdp.md \ No newline at end of file diff --git a/docs/source/runtime.rst b/docs/source/runtime.rst new file mode 100644 index 000000000000..3aca8f3dfe1c --- /dev/null +++ b/docs/source/runtime.rst @@ -0,0 +1 @@ +.. mdinclude:: ../pjrt.md \ No newline at end of file diff --git a/docs/source/spmd.rst b/docs/source/spmd.rst new file mode 100644 index 000000000000..6765a5d24a65 --- /dev/null +++ b/docs/source/spmd.rst @@ -0,0 +1,4 @@ +.. mdinclude:: ../spmd_basic.md +.. mdinclude:: ../fsdpv2.md +.. mdinclude:: ../spmd_advanced.md +.. mdinclude:: ../spmd_distributed_checkpoint.md \ No newline at end of file diff --git a/docs/source/torch_compile.rst b/docs/source/torch_compile.rst new file mode 100644 index 000000000000..505163227f0b --- /dev/null +++ b/docs/source/torch_compile.rst @@ -0,0 +1 @@ +.. mdinclude:: ../dynamo.md \ No newline at end of file