Adding readme for pacman-maze

scallop-lang · Apr 12, 2023 · 3be66f8 · 3be66f8
1 parent c19a6b4
commit 3be66f8
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/experiments/pacman_maze/readme.md b/experiments/pacman_maze/readme.md
@@ -0,0 +1,11 @@
+# PacMan-Maze
+
+To run the experiment, assuming you are in the root folder of this project, simply run
+
+``` bash
+$ python experiments/pacman_maze/run.py --show-run --overlay-prediction
+```
+
+Note that the `--show-run` flag tells the system to visualize the real-time training process.
+This would only work if GUI is present in the system.
+`--overlay-prediction` is used for visualizing the model predictions.