Skip to content

Commit 17f4f87

Browse files
authored
Merge pull request #1 from vwxyzjn/minor-docs-fix
[Doc] Minor documentation fix
2 parents 20bfe67 + bcdae9c commit 17f4f87

File tree

2 files changed

+9
-112
lines changed

2 files changed

+9
-112
lines changed

README.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,8 @@ There are three sources of speed-ups in the codes proposed here:
7474
**To reproduce these results in your own code base**: look for calls to `torch.compile` and `CudaGraphModule` wrapper
7575
within the `*_torchcompile.py` scripts.
7676

77+
You can also look into `run.sh` for the exact commands we used to run the scripts.
78+
7779
The following table displays speed-ups obtained on a H100 equipped node with TODO cpu cores.
7880
All models were executed on GPU, simulation was done on CPU.
7981

@@ -172,7 +174,7 @@ scripts).
172174
<details>
173175
<summary>PPO (Atari - Breakout-v5)</summary>
174176

175-
![SAC.png](doc/artifacts/PPO.png)
177+
![SAC.png](doc/artifacts/ppo.png)
176178

177179
![sac_speed.png](doc/artifacts/ppo_speed.png)
178180

@@ -218,17 +220,17 @@ Prerequisites:
218220
git clone https://github.com/pytorch-labs/leanrl.git && cd leanrl
219221
```
220222
* Python >=3.7.1,<3.11
221-
- `pip install -r requirements/requirements.txt` for basic requirements, or another `.txt` file for specific applications.
222223
- Upgrade torch to its nightly builds for a better coverage of `torch.compile`:
223-
- CUDA 11.8: `pip3 install --pre torch --index-url https://download.pytorch.org/whl/nightly/cu118`
224-
- CUDA 12.1: `pip3 install --pre torch --index-url https://download.pytorch.org/whl/nightly/cu121`
225-
- CUDA 12.4: `pip3 install --pre torch --index-url https://download.pytorch.org/whl/nightly/cu124`
226-
- CPU: `pip3 install --pre torch --index-url https://download.pytorch.org/whl/nightly/cpu`
224+
- CUDA 11.8: `pip3 install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu118`
225+
- CUDA 12.1: `pip3 install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu121`
226+
- CUDA 12.4: `pip3 install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cu124`
227+
- CPU: `pip3 install --upgrade --pre torch --index-url https://download.pytorch.org/whl/nightly/cpu`
228+
- `pip install -r requirements/requirements.txt` for basic requirements, or another `.txt` file for specific applications.
227229

228230
Once the dependencies have been installed, run the scripts as follows
229231

230232
```bash
231-
python leanrl/ppo_atari_torchcompile.py \
233+
python leanrl/ppo_atari_envpool_torchcompile.py \
232234
--seed 1 \
233235
--total-timesteps 50000 \
234236
--compile \

pyproject.toml

-105
This file was deleted.

0 commit comments

Comments
 (0)