Update installation instructions to include virtual env.
@@ -44,9 +44,19 @@ along with the `README.md` associated with each agent.
## Installation
-We support Python 3.6 and 3.7.
+We have tested `acme` on Python 3.6 & 3.7.
-To install `acme` core:
+1. **Optional**: We recommend using a
+ [Python virtual environment](https://docs.python.org/3/tutorial/venv.html)
+ to manage your dependencies, so as to avoid version conflicts:
+
+ ```bash
+ python3 -m venv acme
+ source acme/bin/activate
+ pip install --upgrade pip setuptools
+ ```
+
+1. To install `acme` core:
```bash
# Install Acme core dependencies.
@@ -56,7 +66,7 @@ pip install dm-acme
pip install dm-acme[reverb]
```
-To install dependencies for our JAX/TensorFlow-based agents:
+1. To install dependencies for our JAX/TensorFlow-based agents:
```bash
pip install dm-acme[tf]
@@ -64,7 +74,7 @@ pip install dm-acme[tf]
pip install dm-acme[jax]
```
-Finally, to install environments (gym, dm_control, bsuite):
+1. Finally, to install environments ([gym], [dm_control], [bsuite]):
```bash
pip install dm-acme[envs]
@@ -72,7 +82,8 @@ pip install dm-acme[envs]
## Citing Acme
-If you use Acme in your work, please cite the accompanying [technical report][Paper]:
+If you use Acme in your work, please cite the accompanying
+[technical report][Paper]:
```bibtex
@article{hoffman2020acme,
@@ -108,3 +119,6 @@ If you use Acme in your work, please cite the accompanying [technical report][Pa
[Agents]: acme/agents/
[Reverb]: https://github.com/deepmind/reverb
[Paper]: https://arxiv.org/abs/2006.00979
+[gym]: https://github.com/openai/gym
+[dm_control]: https://github.com/deepmind/dm_control
+[bsuite]: https://github.com/deepmind/bsuite
