Skip to content

Commit 459f615

Browse files
committed
Fix templated README
Signed-off-by: Fabrice Normandin <[email protected]>
1 parent 188bec8 commit 459f615

File tree

1 file changed

+1
-50
lines changed

1 file changed

+1
-50
lines changed

README.md.jinja

Lines changed: 1 addition & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -17,54 +17,5 @@ uv sync
1717

1818
```console
1919
. .venv/bin/activate
20-
python {{project_module}}/main.py --help
20+
python {{module_name}}/main.py --help
2121
```
22-
23-
## Examples of how to launch experiments
24-
25-
<details>
26-
<summary><b>Override any config parameter from command line</b></summary>
27-
28-
```bash
29-
python train.py trainer.max_epochs=20 algorithm.optimizer.lr=1e-4
30-
```
31-
32-
> **Note**: You can also add new parameters with `+` sign.
33-
34-
```bash
35-
python train.py +algorithm.new_param="owo"
36-
```
37-
38-
</details>
39-
40-
<details>
41-
<summary><b>Train on CPU, GPU, multi-GPU and TPU</b></summary>
42-
43-
```bash
44-
# train on CPU
45-
python train.py resources=cpu
46-
47-
# train on 1 GPU
48-
python train.py resources=gpu
49-
50-
# train on TPU (if you're already on a TPU node somehow?)
51-
python train.py +trainer.tpu_cores=8
52-
53-
# train with DDP (Distributed Data Parallel) (4 GPUs)
54-
python train.py resources=gpu hydra.launcher. trainer.strategy=ddp trainer.devices=4
55-
56-
# train with DDP (Distributed Data Parallel) (8 GPUs, 2 nodes)
57-
python train.py trainer=ddp trainer.devices=4 trainer.num_nodes=2
58-
```
59-
60-
</details>
61-
62-
<details>
63-
<summary><b>Train with mixed precision</b></summary>
64-
65-
```bash
66-
# train with pytorch native automatic mixed precision (AMP)
67-
python train.py trainer=gpu +trainer.precision=16
68-
```
69-
70-
</details>

0 commit comments

Comments
 (0)