nightly docs

scopatz · scopatz · commit 9270b50daa99 · 2020-08-19T17:40:14.000-05:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -122,7 +122,7 @@ You do not need to repeatedly install after modifying Python files.
 In case you want to reinstall, make sure that you uninstall PyTorch first by running `pip uninstall torch`
 and `python setup.py clean`. Then you can install in `develop` mode again.
 
-## Nightly Checkout
+## Nightly Checkout & Pull
 
 The `tools/nightly_checkout.py` script is provided to ease pure Python development of
 PyTorch. This uses conda and git to check out the nightly development version of PyTorch
@@ -132,18 +132,29 @@ or editable install, but without needing the ability to compile any C++ code.
 You can use this script to check out a new nightly branch with the following::
 
 ```sh
-$ ./tools/nightly_checkout.py -b my-nightly-branch
+$ ./tools/nightly.py checkout -b my-nightly-branch
 $ conda activate pytorch-deps
 ```
 
 Or if you would like to re-use an existing conda environment, you can pass in
 the regular environment parameters (--name or --prefix)::
 
 ```sh
-$ ./tools/nightly_checkout.py -b my-nightly-branch -n my-env
+$ ./tools/nightly.py checkout -b my-nightly-branch -n my-env
 $ conda activate my-env
 ```
 
+You can also use this tool to pull the nightly commits into the current branch as
+well. This can be done with
+
+```sh
+$ ./tools/nightly.py pull -n my-env
+$ conda activate my-env
+```
+
+Pulling will reinstalle the conda dependencies as well as the nightly binaries into
+the repo directory.
+
 ## Codebase structure
 
 * [c10](c10) - Core library files that work everywhere, both server
diff --git a/tools/nightly.py b/tools/nightly.py
@@ -6,14 +6,23 @@
 
 You can use this script to check out a new nightly branch with the following::
 
-    $ ./tools/nightly_checkout.py -b my-nightly-branch
+    $ ./tools/nightly.py checkout -b my-nightly-branch
     $ conda activate pytorch-deps
 
 Or if you would like to re-use an existing conda environment, you can pass in
 the regular environment parameters (--name or --prefix)::
 
-    $ ./tools/nightly_checkout.py -b my-nightly-branch -n my-env
+    $ ./tools/nightly.py checkout -b my-nightly-branch -n my-env
     $ conda activate my-env
+
+You can also use this tool to pull the nightly commits into the current branch as
+well. This can be done with
+
+    $ ./tools/nightly.py pull -n my-env
+    $ conda activate my-env
+
+Pulling will reinstalle the conda dependencies as well as the nightly binaries into
+the repo directory.
 """
 import os
 import re
@@ -510,7 +519,7 @@ def write_pth(env_opts, platform):
     spdir = _site_packages(env_dir, platform)
     pth = os.path.join(spdir, "pytorch-nightly.pth")
     s = (
-        "# This file was autogenerated by PyTorch's tools/nightly_checkout.py\n"
+        "# This file was autogenerated by PyTorch's tools/nightly.py\n"
         "# Please delete this file if you no longer need the following development\n"
         "# version of PyTorch to be importable\n"
         f"{os.getcwd()}\n"
