Github: https://github.com/pytorch/tutorials
PyTorchチュートリアル
すべてのチュートリアルは、次の場所にあるスフィンクススタイルのドキュメントとして表示されます。
http://pytorch.org/tutorials
貢献する
私たちは、sphinx-galleryのノートブックスタイルの例を使ってチュートリアルを作成します。 構文は非常に簡単です。 本質的には、書式の付いたPythonファイルを少し書くだけで、ドキュメントページとして表示されます。
新しいチュートリアルを作成する方法は次のとおりです。
- ノートブックスタイルのpythonファイルを作成します。 ドキュメントに挿入して実行する場合は、ファイル名を
your_tutorial.pyように接尾辞tutorialファイルを保存します。 - レベルに基づいてbeginner_source、intermediate_source、advanced_sourceのいずれかに入れます。
- index.rstの右側のTOCツリーに含めます。
-
.. galleryitem:: beginner/your_tutorial.pyようなコマンドを使用して、インデックスファイルにサムネイルを作成します。 （これはカスタムディレクティブです。詳細については、custom_directives.pyを参照してください）。
jupyterでチュートリアルを書くことを好む場合は、 このスクリプトを使ってノートブックをpythonファイルに変換することができます。 プロジェクトへの変換と追加の後、セクション見出しなどが論理的な順序であることを確認してください。
建物
- トーチとtorchvisionのインストールから始めます。
pip install -r requirements.txtを使用して他の要件をpip install -r requirements.txt - その後、
make docsを使っmake docsビルドすることができます。 これは、データをダウンロードし、チュートリアルを実行し、ドキュメントをdocs/ディレクトリに構築します。 ただし、システムに応じて約30-60分かかります。 - 実行をスキップして、
make html-noplotを実行して、_build/htmlへのhtmlドキュメントを構築することができます。 これにより、チュートリアルをすばやくプレビューできます。