pytorch/tutorials

它是什么

一个 PyTorch 学习材料集合，以网页文档形式发布在 https://pytorch.org/tutorials。教程以 Python 文件编写，转换为 HTML 页面，每个教程自动生成一个 Jupyter 笔记本版本（可在 Google Colab 中运行）。

在哪里提问

如果你对教程有疑问，请在 dev-discuss 论坛 上发布——而不是作为 GitHub issue。README 说在那里你会得到更快的回答。

如何报告问题

接受两种类型的问题：

• 功能请求 — 提议新教程。你必须解释为什么需要它以及它如何展示 PyTorch 的价值。
• 错误报告 — 报告损坏或过时的教程。在报告中包含 python3 -m torch.utils.collect_env 的输出（该命令收集有关你系统的信息）。

如何贡献新教程

1. 编写一个 Python 文件。如果你希望它在插入文档时被执行，请以 tutorial 后缀命名（例如，your_tutorial.py）。
2. 根据难度将其放在以下文件夹之一：
   • beginner_source — 初学者级别
   • intermediate_source — 中级级别
   • advanced_source — 高级级别
   • recipes_source — 简短配方
   • prototype_source — 不稳定的原型功能
3. 对于非原型教程，将其添加到目录（toctree）中，并在 index.rst 中创建 customcarditem。
4. 对于非原型教程，在 index.rst 中添加缩略图；对于配方，在 recipes_index.rst 中添加。

如果你从 Jupyter 笔记本开始，有一个链接的脚本可以将其转换为 Python 文件。转换后，检查标题和结构是否合理。

本地构建

完整构建很大，需要 GPU。选项：

• 完整构建（make docs）：下载数据，运行教程，将文档构建到 docs/。在 GPU 系统上需要 60–120 分钟。
• 快速预览（make html-noplot）：构建基本 HTML 到 _build/html，不运行教程代码——如果你没有 GPU，这很有用。

首先使用 pip install -r requirements.txt 安装依赖。你可以使用 conda 或 virtualenv（README 展示了 virtualenv 设置）。

构建单个教程

将 GALLERY_PATTERN 环境变量设置为文件名（或正则表达式）以仅构建该教程。示例：

GALLERY_PATTERN="neural_style_transfer_tutorial.py" make html

拼写检查

使用 pyspelling 捕获拼写错误：

• pyspelling — 完整检查（约 3 分钟）
• pyspelling -n python — 仅 Python 文件
• pyspelling -n reST — 仅 .rst 文件（目前限于 beginner/ 目录）

许可证

BSD 许可（见仓库中的 LICENSE 文件）。