You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+50-1Lines changed: 50 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -28,4 +28,53 @@ git push origin gh-pages
28
28
To add a new doc please create a `.md` file under this directory. To make this doc show up in our [doc pages](https://pytorch.org/xla/master/index.html), please add a `.rst` file under `source/`.
29
29
30
30
## Adding images in the doc
31
-
Please add your imges to both `_static/img/` and `source/_static/img/` for images to properlly show up in the markdown files as well as our [doc pages](https://pytorch.org/xla/master/index.html).
31
+
Please add your imges to both `_static/img/` and `source/_static/img/` for images to properly show up in the markdown files as well as our [doc pages](https://pytorch.org/xla/master/index.html).
32
+
33
+
## Runnable tutorials
34
+
35
+
Stylistically, review the [pytorch tutorial contributing guide](https://github.com/pytorch/tutorials/blob/main/CONTRIBUTING.md).
36
+
37
+
Save your tutorial as `*_tutorial.py`.
38
+
39
+
We do not yet have an automated build system for runnable tutorials that matches
40
+
PyTorch. For now, include manual instructions and check-in the output ipynb and MD files.
41
+
42
+
TODO: Automate build of runnable tutorials. https://github.com/pytorch/xla/issues/9136
43
+
44
+
Note that the existing .gitattributes in this directory will prevent diffs and merges
45
+
on the ipynb's json representation, which is difficult to diff.
46
+
47
+
Add your runnable tutorial to the list below with build instructions,
48
+
necessary environments, and steps to manually verify correctness.
49
+
50
+
### source/tutorials/precision_tutorial.py
51
+
52
+
Run on a TPU machine.
53
+
54
+
One time installs not in requirements.txt:
55
+
56
+
```sh
57
+
conda install -c conda-forge pandoc
58
+
pip install py2nb
59
+
```
60
+
61
+
Install nbsphinx and lxml manually as there is a problem with nbsphinx's
0 commit comments