Skip to content

pytorch/tutorials

Repository files navigation

PyTorch Tutorials

All the tutorials are now presented as sphinx style documentation at:

Contributing

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:

  1. Create a notebook styled python file. If you want it executed while inserted into documentation, save the file as your_tutorial.py.
  2. Put it in one of the beginner_source, intermediate_source, advanced_source based on the level.
  3. Include it in the right TOC tree at index.rst
  4. Create a thumbnail in the index file using a command like .. galleryitem:: beginner/your_tutorial.py. (This is a custom directive. Argument should be a full path to the python file without a slash at the beginning.)