From 3be66f899910a71ba1bdaf707bebb67fa5193421 Mon Sep 17 00:00:00 2001
From: Ziyang Li <liby99@icloud.com>
Date: Wed, 12 Apr 2023 01:17:50 -0400
Subject: [PATCH] Adding readme for pacman-maze

---
 experiments/pacman_maze/readme.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 experiments/pacman_maze/readme.md

diff --git a/experiments/pacman_maze/readme.md b/experiments/pacman_maze/readme.md
new file mode 100644
index 0000000..da746ea
--- /dev/null
+++ 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.