Skip to content

Commit a044c03

Browse files
osandoval-fbfacebook-github-bot
authored andcommittedSep 1, 2020
updated documentation to streamline setup (pytorch#42850)
Summary: Pull Request resolved: pytorch#42850 Reviewed By: mrshenli Differential Revision: D23449055 Pulled By: osandoval-fb fbshipit-source-id: 6db695d4fe5f6d9b7bb2895c85c855db4779516b
1 parent b1f19c2 commit a044c03

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed
 

‎CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ PyTorch, see the [Contributing Guide](docs/source/community/contribution_guide.r
5959

6060
## Developing PyTorch
6161

62+
A full set of instructions on installing PyTorch from source is here:
63+
https://github.com/pytorch/pytorch#from-source
64+
6265
To develop PyTorch on your machine, here are some tips:
6366

6467
1. Uninstall all existing PyTorch installs:
@@ -88,8 +91,6 @@ If you want to have no-op incremental rebuilds (which are fast), see the section
8891

8992
3. Install PyTorch in `develop` mode:
9093

91-
A full set of instructions on installing PyTorch from source is here:
92-
https://github.com/pytorch/pytorch#from-source
9394

9495
The change you have to make is to replace
9596

‎README.md

+9
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,12 @@ On Linux
178178
conda install -c pytorch magma-cuda102 # or [ magma-cuda101 | magma-cuda100 | magma-cuda92 ] depending on your cuda version
179179
```
180180

181+
On MacOS
182+
```bash
183+
# Add these packages if torch.distributed is needed
184+
conda install pkg-config libuv
185+
```
186+
181187
#### Get the PyTorch Source
182188
```bash
183189
git clone --recursive https://github.com/pytorch/pytorch
@@ -311,6 +317,9 @@ pip install -r requirements.txt
311317
You can then build the documentation by running ``make <format>`` from the
312318
``docs/`` folder. Run ``make`` to get a list of all available output formats.
313319

320+
If you get a katex error run ```npm install katex```. If it persists, try
321+
```npm install -g katex```
322+
314323
### Previous Versions
315324

316325
Installation instructions and binaries for previous PyTorch versions may be found

0 commit comments

Comments
 (0)
Please sign in to comment.