pytorch/tutorials

The PyTorch tutorials repository serves as the official collection of educational materials for the PyTorch deep learning framework. The tutorials are presented as Sphinx-style documentation hosted at pytorch.org/tutorials, making them accessible through a centralized web interface rather than directly from the GitHub repository. The project is written primarily in Python and covers a comprehensive range of topics spanning deep learning, machine learning, neural networks, tensor operations, computer vision, natural language processing, and AI applications, with materials organized at beginner, intermediate, advanced, and recipe difficulty levels.

The repository uses sphinx-gallery's notebook-styled examples as its primary authoring format, allowing contributors to write well-formatted Python files that are automatically converted into HTML documentation pages and Jupyter notebooks executable in Google Colab. This approach significantly lowers the barrier to entry for tutorial creation while ensuring consistency across the documentation. The contribution workflow is clearly defined, with tutorials placed in appropriate source directories based on difficulty level, and prototype features housed separately in a dedicated prototype_source directory.

Building tutorials locally requires significant computational resources, particularly GPU access, as the full build process downloads data and executes tutorial code, typically requiring 60 to 120 minutes on GPU-equipped systems. For contributors without GPU access, the make html-noplot command enables rapid preview builds of basic HTML documentation. The repository supports selective building through the GALLERY_PATTERN environment variable using regular expressions, allowing developers to test individual tutorials without rebuilding the entire documentation set. Quality assurance is maintained through pyspelling integration for spell checking across Python and reStructuredText files.

The repository maintains clear guidelines for issue submission and contribution, directing general questions to the dev-discuss forum rather than the issue tracker for faster resolution. Contributors are required to review the PyTorch Tutorial Submission Policy before proposing new tutorials and must provide environment information using torch.utils.collect_env when reporting bugs.