All the tutorials are now presented as sphinx style documentation at:
We use sphinx-gallery's notebook styled examples to create the tutorials. Syntax is very simple. In essence, you write a slightly well formatted python file and it shows up as documentation page.
Here's how to create a new tutorial or recipe:
- Create a notebook styled python file. If you want it executed while inserted into documentation, save the file with suffix
tutorialso that file name isyour_tutorial.py. - Put it in one of the beginner_source, intermediate_source, advanced_source based on the level. If it is a recipe, add to recipes_source.
- For Tutorials (except if it is a prototype feature), include it in the TOC tree at index.rst
- For Tutorials (except if it is a prototype feature), create a thumbnail in the index.rst file using a command like
.. customcarditem:: beginner/your_tutorial.html. For Recipes, create a thumbnail in the recipes_index.rst
In case you prefer to write your tutorial in jupyter, you can use this script to convert the notebook to python file. After conversion a 7048 nd addition to the project, please make sure the sections headings etc are in logical order.
- Start with installing torch, torchvision, and your GPUs latest drivers. Install other requirements using
pip install -r requirements.txt
If you want to use
virtualenv, make your environment in avenvdirectory like:virtualenv ./venv, thensource ./venv/bin/activate.
- Then you can build using
make docs. This will download the data, execute the tutorials and build the documentation todocs/directory. This will take about 60-120 min for systems with GPUs. If you do not have a GPU installed on your system, then see next step. - You can skip the computationally intensive graph generation by running
make html-noplotto build basic html documentation to_build/html. This way, you can quickly preview your tutorial.
If you get ModuleNotFoundError: No module named 'pytorch_sphinx_theme' make: *** [html-noplot] Error 2, from /tutorials/src/pytorch-sphinx-theme run
python setup.py install.
- You can find information about contributing to PyTorch documentation in the PyTorch Repo README.md file.
- Additional information can be found in PyTorch CONTRIBUTING.md.