[BUGFIX] CLI example documentation improved

2021-06-03 13:47:20 +02:00 · 2021-06-03 13:47:20 +02:00 · 5918f1cc21
commit 5918f1cc21
parent 3b02d99ebe
2 changed files with 8 additions and 0 deletions
--- a/examples/cli/README.md
+++ b/examples/cli/README.md
@ -0,0 +1,8 @@
+# Examples using Lightning CLI
+
+Examples in this folder use the experimental [Lightning CLI](https://pytorch-lightning.readthedocs.io/en/latest/common/lightning_cli.html).
+
+To use the example run
+```
+python gmlvq.py --config gmlvq.yaml
+```
--- a/examples/cli/config.yaml
+++ b/examples/cli/config.yaml