Clarify phrasing of installation instructions with regards to running examples
@@ -51,9 +51,12 @@ pip install .
```
**Install with extra packages:**
+
+To install the dependencies required to run the probabilistic models included in the `examples`/`tutorials` directories, please use the following command:
```sh
-pip install pyro-ppl[extras] # for running examples/tutorials
+pip install pyro-ppl[extras]
```
+Make sure that the models come from the same release version of the [Pyro source code](https://github.com/uber/pyro/releases) as you have installed.
### Installing Pyro dev branch
@@ -82,11 +85,25 @@ On OSX:
MACOSX_DEPLOYMENT_TARGET=10.9 CC=clang CXX=clang++ python setup.py install
```
-Finally install Pyro
+Finally install Pyro using pip or from source as shown below.
+
+**Install using pip:**
+
+```sh
+pip install git+https://github.com/uber/pyro.git
+```
+
+or, with the `extras` dependency to run the probabilistic models included in the `examples`/`tutorials` directories:
+```sh
+pip install git+https://github.com/uber/pyro.git#egg=project[extras]
+```
+
+**Install from source:**
+
```sh
git clone https://github.com/uber/pyro
cd pyro
-pip install .
+pip install . # pip install .[extras] for running models in examples/tutorials
```
@@ -109,10 +126,7 @@ Then, install Pyro using the `pytorch-1.0` branch.
pip install git+https://github.com/uber/pyro.git@pytorch-1.0
```
-or, with the `extras` dependency to run examples/tutorials.
-```sh
-pip install -e git+https://github.com/uber/pyro.git@pytorch-1.0#egg=project[extras]
-```
+or, with the `extras` dependency as shown above.
**Install from source:**
@@ -120,7 +134,7 @@ pip install -e git+https://github.com/uber/pyro.git@pytorch-1.0#egg=project[extr
git clone https://github.com/uber/pyro
cd pyro
git checkout pytorch-1.0 # branch compatible with PyTorch 1.0 release candidate
-pip install . # pip install .[extras] for running examples/tutorials
+pip install . # pip install .[extras] for running models in examples/tutorials
```
## Running Pyro from a Docker Container
