pytorch/tutorials

これは何か

PyTorch の学習教材のコレクションで、https://pytorch.org/tutorials でウェブドキュメントとして公開されています。チュートリアルは Python ファイルとして書かれ、HTML ページに変換され、各チュートリアルには Jupyter ノートブック版が自動生成されます（Google Colab で実行可能）。

質問する場所

チュートリアルについて質問がある場合は、dev-discuss フォーラムに投稿してください — GitHub の issue ではありません。README によると、そこではより速い回答が得られます。

問題の報告方法

2 種類の問題が受け付けられています：

機能リクエスト — 新しいチュートリアルを提案します。なぜ必要なのか、PyTorch の価値をどのように示すのかを説明する必要があります。
バグ報告 — 壊れた、または古いチュートリアルを報告します。レポートには python3 -m torch.utils.collect_env の出力（システムに関する情報を収集します）を含めてください。

新しいチュートリアルの貢献方法

Python ファイルを書きます。ドキュメントに挿入されたときに実行したい場合は、ファイル名に tutorial という接尾辞を付けます（例：your_tutorial.py）。
難易度に応じて、次のフォルダのいずれかに配置します：
- beginner_source — 初心者レベル
- intermediate_source — 中級レベル
- advanced_source — 上級レベル
- recipes_source — 短いレシピ
- prototype_source — 不安定なプロトタイプ機能
プロトタイプ以外のチュートリアルでは、目次（toctree）に追加し、index.rst に customcarditem を作成します。
プロトタイプ以外のチュートリアルでは、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 ファイルを参照）。