diff --git a/docs/source/index.rst b/docs/source/index.rst index 3e02cd34ad4..d96086704c3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,9 +41,10 @@ architectures, and common image transformations for computer vision. .. toctree:: :maxdepth: 1 - :caption: Examples + :caption: Examples and training references auto_examples/index + training_references .. automodule:: torchvision :members: diff --git a/docs/source/models.rst b/docs/source/models.rst index 4ac582a33a2..9d05b509899 100644 --- a/docs/source/models.rst +++ b/docs/source/models.rst @@ -1,3 +1,5 @@ +.. _models: + torchvision.models ################## diff --git a/docs/source/training_references.rst b/docs/source/training_references.rst new file mode 100644 index 00000000000..fc22ac5eba6 --- /dev/null +++ b/docs/source/training_references.rst @@ -0,0 +1,29 @@ +Training references +=================== + +On top of the many models, datasets, and image transforms, Torchvision also +provides training reference scripts. These are the scripts that we use to train +the :ref:`models ` which are then available with pre-trained weights. + +These scripts are not part of the core package and are instead available `on +GitHub `_. We currently +provide references for +`classification `_, +`detection `_, +`segmentation `_, +`similarity learning `_, +and `video classification `_. + +While these scripts are largely stable, they do not offer backward compatibility +guarantees. + +In general, these scripts rely on the latest (not yet released) pytorch version +or the latest torchvision version. This means that to use them, **you might need +to install the latest pytorch and torchvision versions**, with e.g.:: + + conda install pytorch torchvision -c pytorch-nightly + +If you need to rely on an older stable version of pytorch or torchvision, e.g. +torchvision 0.10, then it's safer to use the scripts from that corresponding +release on GitHub, namely +https://github.com/pytorch/vision/tree/v0.10.0/references.