Skip to content

Commit 3808df0

Browse files
authored
8727 create a site map or centralize links in readme (#8843)
1 parent 46a7990 commit 3808df0

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ assignees: ''
1010
## 📚 Documentation
1111

1212
<!-- A clear and concise description of what content is an issue. -->
13+
<!-- If you create new docs, consider adding them to https://github.com/pytorch/xla/blob/master/README.md#github-doc-map -->

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,21 @@ PyTorch/XLA remains an open-source project and we welcome contributions from the
106106
community to help maintain and improve the project. To contribute, please start
107107
with the [contributors guide](https://github.com/pytorch/xla/blob/master/CONTRIBUTING.md).
108108

109+
## Github Doc Map
110+
111+
Our github contains many useful docs on working with different aspects of PyTorch XLA, here is a list of useful docs spread around our repository:
112+
113+
- [docs/source/learn](https://github.com/pytorch/xla/tree/master/docs/source/learn): docs for learning concepts associated with XLA, troubleshooting, pjrt, eager mode, and dynamic shape.
114+
- [docs/source/accelerators](https://github.com/pytorch/xla/tree/master/docs/source/accelerators): references to `GPU` and `TPU` accelerator documents.
115+
- [docs/source/perf](https://github.com/pytorch/xla/tree/master/docs/source/perf): documentation about performance specific aspects of PyTorch/XLA such as: `AMP`, `DDP`, `Dynamo`, Fori loop, `FSDP`, quantization, recompilation, and `SPMD`
116+
- [docs/source/features](https://github.com/pytorch/xla/tree/master/docs/source/features): documentation on distributed torch, pallas, scan, stable hlo, and triton.
117+
- [docs/source/contribute](https://github.com/pytorch/xla/tree/master/docs/source/contribute): documents on setting up PyTorch for development, and guides for lowering operations.
118+
- PJRT plugins:
119+
- [CPU](https://github.com/pytorch/xla/blob/master/plugins/cpu/README.md)
120+
- [CUDA](https://github.com/pytorch/xla/blob/master/plugins/cuda/README.md)
121+
- [torchax/docs](https://github.com/pytorch/xla/tree/master/torchax/docs): torchax documents
122+
- [torchax/examples](https://github.com/pytorch/xla/tree/master/torchax/examples): torchax examples
123+
109124
## Getting Started
110125

111126
To update your existing training loop, make the following changes:

0 commit comments

Comments
 (0)