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:
- Create a notebook styled python file. If you want it executed while inserted into documentation, save the file with suffix
tutorialso that file name is
- Put it in one of the beginner_source, intermediate_source, advanced_source based on the level.
- Include it in the right TOC tree at index.rst
- Create a thumbnail in the index file using a command like
.. galleryitem:: beginner/your_tutorial.py. (This is a custom directive. See
custom_directives.pyfor more info.)
In case you prefer to write your tutorial in jupyter, you can use this script to convert the notebook to python file. After conversion and addition to the project, please make sure the sections headings etc are in logical order.
- Start with installing torch and torchvision. Install other requirements using
pip install -r requirements.txt
- Then you can build using
make docs. This will download the data, execute the tutorials and build the documentation to
docs/directory. However, this will take about 30-60 min based on your system.
- You can skip the execution by running
make html-noplotto build html documentation to
_build/html. This way, you can quickly preview your tutorial.