diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57d16bb6a1e..f6adf15d02b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ We welcome your pull requests (PR) for updates and fixes. 1. If you haven't already, complete the Contributor License Agreement ("CLA"). 1. Fork the repo and create a branch from - [`master`](https://github.com/pytorch/tutorials). + [`main`](https://github.com/pytorch/tutorials). 1. Test your code. 1. Lint your code with a tool such as [Pylint](https://pylint.pycqa.org/en/latest/). @@ -88,7 +88,7 @@ commonly-used storage service, such as Amazon S3, and instructing your users to download the data at the beginning of your tutorial. The -[Makefile](https://github.com/pytorch/tutorials/blob/master/Makefile) +[Makefile](https://github.com/pytorch/tutorials/blob/main/Makefile) that we use to build the tutorials contains automation that downloads required data files. @@ -248,14 +248,14 @@ For Python files, our CI system runs your code during each build. [https://github.com/pytorch/tutorials](https://github.com/pytorch/tutorials) 1. Put the tutorial in one of the - [`beginner_source`](https://github.com/pytorch/tutorials/tree/master/beginner_source), - [`intermediate_source`](https://github.com/pytorch/tutorials/tree/master/intermediate_source), - [`advanced_source`](https://github.com/pytorch/tutorials/tree/master/advanced_source) + [`beginner_source`](https://github.com/pytorch/tutorials/tree/main/beginner_source), + [`intermediate_source`](https://github.com/pytorch/tutorials/tree/main/intermediate_source), + [`advanced_source`](https://github.com/pytorch/tutorials/tree/main/advanced_source) based on the technical level of the content. For recipes, put the recipe in - [`recipes_source`](https://github.com/pytorch/tutorials/tree/master/recipes_source). + [`recipes_source`](https://github.com/pytorch/tutorials/tree/main/recipes_source). In addition, for recipes, add the recipe in the recipes - [README.txt](https://github.com/pytorch/tutorials/blob/master/recipes_source/recipes/README.txt) + [README.txt](https://github.com/pytorch/tutorials/blob/main/recipes_source/recipes/README.txt) file. @@ -266,9 +266,9 @@ search, you need to include it in `index.rst`, or for recipes, in `recipes_index.rst`. 1. Open the relevant file - [`index.rst`](https://github.com/pytorch/tutorials/blob/master/index.rst) + [`index.rst`](https://github.com/pytorch/tutorials/blob/main/index.rst) or - [`recipes_index.rst`](https://github.com/pytorch/tutorials/blob/master/recipes_source/recipes_index.rst) + [`recipes_index.rst`](https://github.com/pytorch/tutorials/blob/main/recipes_source/recipes_index.rst) 1. Add a _card_ in reStructuredText format similar to the following: ``` @@ -300,10 +300,10 @@ might fail to build, and the cards will not display properly. ### Image ### Add a thumbnail to the -[`_static/img/thumbnails/cropped`](https://github.com/pytorch/tutorials/tree/master/_static/img/thumbnails/cropped) +[`_static/img/thumbnails/cropped`](https://github.com/pytorch/tutorials/tree/main/_static/img/thumbnails/cropped) directory. Images that render the best are square--that is, they have equal `x` and `y` dimensions--and also have high resolution. [Here is an -example](https://github.com/pytorch/tutorials/blob/master/_static/img/thumbnails/cropped/loading-data.PNG). +example](https://github.com/pytorch/tutorials/blob/main/_static/img/thumbnails/cropped/loading-data.PNG). ## `toctree` ## @@ -344,7 +344,7 @@ test your tutorial when you submit your PR. NOTE: Please do not use [ghstack](https://github.com/ezyang/ghstack). We do not support ghstack in the [`pytorch/tutorials`](https://github.com/pytorch/tutorials) repo. -Submit the changes as a PR to the master branch of +Submit the changes as a PR to the main branch of [`pytorch/tutorials`](https://github.com/pytorch/tutorials). 1. Add your changes, commit, and push: diff --git a/README.md b/README.md index a9c6664bfdc..d9fda75a019 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Here is how you can create a new tutorial (for a detailed description, see [CONT 1. Create a Python file. If you want it executed while inserted into documentation, save the file with the suffix `tutorial` so that the file name is `your_tutorial.py`. 2. Put it in one of the `beginner_source`, `intermediate_source`, `advanced_source` directory based on the level of difficulty. If it is a recipe, add it to `recipes_source`. For tutorials demonstrating unstable prototype features, add to the `prototype_source`. 2. For Tutorials (except if it is a prototype feature), include it in the `toctree` directive and create a `customcarditem` in [index.rst](./index.rst). -3. For Tutorials (except if it is a prototype feature), create a thumbnail in the [index.rst file](https://github.com/pytorch/tutorials/blob/master/index.rst) using a command like `.. customcarditem:: beginner/your_tutorial.html`. For Recipes, create a thumbnail in the [recipes_index.rst](https://github.com/pytorch/tutorials/blob/master/recipes_source/recipes_index.rst) +3. For Tutorials (except if it is a prototype feature), create a thumbnail in the [index.rst file](https://github.com/pytorch/tutorials/blob/main/index.rst) using a command like `.. customcarditem:: beginner/your_tutorial.html`. For Recipes, create a thumbnail in the [recipes_index.rst](https://github.com/pytorch/tutorials/blob/main/recipes_source/recipes_index.rst) If you are starting off with a Jupyter notebook, you can use [this script](https://gist.github.com/chsasank/7218ca16f8d022e02a9c0deb94a310fe) to convert the notebook to Python file. After conversion and addition to the project, please make sure that section headings and other things are in logical order. diff --git a/advanced_source/generic_join.rst b/advanced_source/generic_join.rst index ec9ef561055..30259650278 100644 --- a/advanced_source/generic_join.rst +++ b/advanced_source/generic_join.rst @@ -4,7 +4,7 @@ Distributed Training with Uneven Inputs Using the Join Context Manager **Author**\ : `Andrew Gu `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. .. note:: ``Join`` is introduced in PyTorch 1.10 as a prototype feature. This API is subject to change. diff --git a/advanced_source/rpc_ddp_tutorial.rst b/advanced_source/rpc_ddp_tutorial.rst index 17458e801e5..747c12f6d4f 100644 --- a/advanced_source/rpc_ddp_tutorial.rst +++ b/advanced_source/rpc_ddp_tutorial.rst @@ -3,7 +3,7 @@ Combining Distributed DataParallel with Distributed RPC Framework **Authors**: `Pritam Damania `_ and `Yi Wang `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. This tutorial uses a simple example to demonstrate how you can combine `DistributedDataParallel `__ (DDP) diff --git a/beginner_source/dist_overview.rst b/beginner_source/dist_overview.rst index e9036342661..542eb31e038 100644 --- a/beginner_source/dist_overview.rst +++ b/beginner_source/dist_overview.rst @@ -3,7 +3,7 @@ PyTorch Distributed Overview **Author**: `Shen Li `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. This is the overview page for the ``torch.distributed`` package. The goal of this page is to categorize documents into different topics and briefly diff --git a/beginner_source/former_torchies/parallelism_tutorial.py b/beginner_source/former_torchies/parallelism_tutorial.py index cb06c9334f6..18c14c43167 100644 --- a/beginner_source/former_torchies/parallelism_tutorial.py +++ b/beginner_source/former_torchies/parallelism_tutorial.py @@ -132,7 +132,7 @@ def forward(self, x): # - `Discuss PyTorch on the Forums`_ # - `Chat with other users on Slack`_ # -# .. _`Deep Learning with PyTorch: a 60-minute blitz`: https://github.com/pytorch/tutorials/blob/master/Deep%20Learning%20with%20PyTorch.ipynb +# .. _`Deep Learning with PyTorch: a 60-minute blitz`: https://github.com/pytorch/tutorials/blob/main/Deep%20Learning%20with%20PyTorch.ipynb # .. _Train a state-of-the-art ResNet network on imagenet: https://github.com/pytorch/examples/tree/master/imagenet # .. _Train a face generator using Generative Adversarial Networks: https://github.com/pytorch/examples/tree/master/dcgan # .. _Train a word-level language model using Recurrent LSTM networks: https://github.com/pytorch/examples/tree/master/word_language_model diff --git a/beginner_source/nn_tutorial.py b/beginner_source/nn_tutorial.py index 8b2fa4d425c..cdc20040654 100644 --- a/beginner_source/nn_tutorial.py +++ b/beginner_source/nn_tutorial.py @@ -47,7 +47,7 @@ PATH.mkdir(parents=True, exist_ok=True) -URL = "https://github.com/pytorch/tutorials/raw/master/_static/" +URL = "https://github.com/pytorch/tutorials/raw/main/_static/" FILENAME = "mnist.pkl.gz" if not (PATH / FILENAME).exists(): diff --git a/intermediate_source/FSDP_tutorial.rst b/intermediate_source/FSDP_tutorial.rst index d711637ae34..cc9411e14b1 100644 --- a/intermediate_source/FSDP_tutorial.rst +++ b/intermediate_source/FSDP_tutorial.rst @@ -4,7 +4,7 @@ Getting Started with Fully Sharded Data Parallel(FSDP) **Author**: `Hamid Shojanazeri `__, `Yanli Zhao `__, `Shen Li `__ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Training AI models at a large scale is a challenging task that requires a lot of compute power and resources. It also comes with considerable engineering complexity to handle the training of these very large models. diff --git a/intermediate_source/ax_multiobjective_nas_tutorial.py b/intermediate_source/ax_multiobjective_nas_tutorial.py index 1693492818d..7c43f59473c 100644 --- a/intermediate_source/ax_multiobjective_nas_tutorial.py +++ b/intermediate_source/ax_multiobjective_nas_tutorial.py @@ -46,7 +46,7 @@ # ----------------------- # # Our goal is to optimize the PyTorch Lightning training job defined in -# `mnist_train_nas.py `__. +# `mnist_train_nas.py `__. # To do this using TorchX, we write a helper function that takes in # the values of the architcture and hyperparameters of the training # job and creates a `TorchX AppDef `__ diff --git a/intermediate_source/ddp_tutorial.rst b/intermediate_source/ddp_tutorial.rst index 87e709e1e8d..366db8db130 100644 --- a/intermediate_source/ddp_tutorial.rst +++ b/intermediate_source/ddp_tutorial.rst @@ -5,7 +5,7 @@ Getting Started with Distributed Data Parallel **Edited by**: `Joe Zhu `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/dist_pipeline_parallel_tutorial.rst b/intermediate_source/dist_pipeline_parallel_tutorial.rst index cac57005621..ecc64c2e1f0 100644 --- a/intermediate_source/dist_pipeline_parallel_tutorial.rst +++ b/intermediate_source/dist_pipeline_parallel_tutorial.rst @@ -3,7 +3,7 @@ Distributed Pipeline Parallelism Using RPC **Author**: `Shen Li `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/dist_tuto.rst b/intermediate_source/dist_tuto.rst index 4a1b9e92eb0..9a0ceb7a4a8 100644 --- a/intermediate_source/dist_tuto.rst +++ b/intermediate_source/dist_tuto.rst @@ -3,7 +3,7 @@ Writing Distributed Applications with PyTorch **Author**: `Séb Arnold `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/process_group_cpp_extension_tutorial.rst b/intermediate_source/process_group_cpp_extension_tutorial.rst index 15eb23bf3ee..48ecc056bb2 100644 --- a/intermediate_source/process_group_cpp_extension_tutorial.rst +++ b/intermediate_source/process_group_cpp_extension_tutorial.rst @@ -4,7 +4,7 @@ Customize Process Group Backends Using Cpp Extensions **Author**: `Feng Tian `__, `Shen Li `__, `Min Si `__ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/rpc_async_execution.rst b/intermediate_source/rpc_async_execution.rst index 8c373b7fda6..bd04fe33991 100644 --- a/intermediate_source/rpc_async_execution.rst +++ b/intermediate_source/rpc_async_execution.rst @@ -3,7 +3,7 @@ Implementing Batch RPC Processing Using Asynchronous Executions **Author**: `Shen Li `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/rpc_param_server_tutorial.rst b/intermediate_source/rpc_param_server_tutorial.rst index 3f810091e30..5531c51c0f8 100644 --- a/intermediate_source/rpc_param_server_tutorial.rst +++ b/intermediate_source/rpc_param_server_tutorial.rst @@ -5,7 +5,7 @@ Implementing a Parameter Server Using Distributed RPC Framework **Author**\ : `Rohan Varma `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/intermediate_source/rpc_tutorial.rst b/intermediate_source/rpc_tutorial.rst index d63878e2f49..835e6f0649f 100644 --- a/intermediate_source/rpc_tutorial.rst +++ b/intermediate_source/rpc_tutorial.rst @@ -3,7 +3,7 @@ Getting Started with Distributed RPC Framework **Author**: `Shen Li `_ .. note:: - |edit| View and edit this tutorial in `github `__. + |edit| View and edit this tutorial in `github `__. Prerequisites: diff --git a/prototype_source/README.txt b/prototype_source/README.txt index 12dfa3b082e..94c182dcca0 100644 --- a/prototype_source/README.txt +++ b/prototype_source/README.txt @@ -10,15 +10,15 @@ Prototype Tutorials 3. graph_mode_dynamic_bert_tutorial.rst Graph Mode Dynamic Quantization on BERT - https://github.com/pytorch/tutorials/blob/master/prototype_source/graph_mode_dynamic_bert_tutorial.rst + https://github.com/pytorch/tutorials/blob/main/prototype_source/graph_mode_dynamic_bert_tutorial.rst 4. numeric_suite_tutorial.py PyTorch Numeric Suite Tutorial - https://github.com/pytorch/tutorials/blob/master/prototype_source/numeric_suite_tutorial.py + https://github.com/pytorch/tutorials/blob/main/prototype_source/numeric_suite_tutorial.py 5. torchscript_freezing.py Model Freezing in TorchScript - https://github.com/pytorch/tutorials/blob/master/prototype_source/torchscript_freezing.py + https://github.com/pytorch/tutorials/blob/main/prototype_source/torchscript_freezing.py 6. vulkan_workflow.rst Vulkan Backend User Workflow