README.md : Add descriptions for optional arguments (pytorch#712)

Signed-off-by: nbqu <dk41245@gmail.com>
mpc001 · Mar 5, 2020 · db0dbf6 · db0dbf6
1 parent dce9319
commit db0dbf6
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/vae/README.md b/vae/README.md
@@ -7,3 +7,13 @@ It uses ReLUs and the adam optimizer, instead of sigmoids and adagrad. These cha
 pip install -r requirements.txt
 python main.py
 ```
+The main.py script accepts the following arguments:
+
+```bash
+optional arguments:
+  --batch-size		input batch size for training (default: 128)
+  --epochs		number of epochs to train (default: 10)
+  --no-cuda		enables CUDA training
+  --seed		random seed (default: 1)
+  --log-interval	how many batches to wait before logging training status
+```