From 08822672a3913667f79123a01aace261aa04b904 Mon Sep 17 00:00:00 2001 From: Felix Jung Date: Thu, 13 Jul 2023 11:44:54 +0200 Subject: [PATCH] Update README.md fix readme format problems --- README.md | 56 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 5df4905..b532705 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ [//]: # (This is for the doxygen) + [//]: # (![logo](images/logo.png)) Logo @@ -117,12 +118,12 @@ Install the following software: Perform the following steps to set up and run the project: 1. Clone the repo - ``` - git clone https://github.com/Pristar4/SnakeGame.git - ``` + ``` + git clone https://github.com/Pristar4/SnakeGame.git + ``` 2. Set up the virtual environment in the mk-agents folder under SnakeGame\ml-agents by running: ``` - python -m venv ./venv + python -m venv ./venv ``` 3. Activate your virtual enviroment: ``` @@ -130,33 +131,40 @@ Perform the following steps to set up and run the project: ``` 4. Install ML-agents within the virtual environment by following the Getting Started in the ml-agents rep -5. ``` +5. + ``` python.exe -m pip install --upgrade pip - ``` -6. ``` - pip install torch -f https://download.pytorch.org/whl/torch_stable.html - ``` -7. ``` - pip install tensorboard - ``` -7. ``` + ``` +6. + ``` + pip install torch -f https://download.pytorch.org/whl/torch_stable.html + ``` +7. + ``` + pip install tensorboard + ``` +8. + ``` pip install -e ./ml-agents-envs - ``` -8. ``` + ``` + +9. + ``` pip install -e ./ml-agents - ``` -9. ``` - pip install tensorboard - ``` -9. Start the training by running: ``` - mlagents-learn config/ppo/Snake.yaml --run-id=trainingRun01 - ``` -10. Open a second terminal and start TensorBoard to monitor training. +10. + ``` + pip install tensorboard + ``` +11. Start the training by running: + ``` + mlagents-learn config/ppo/Snake.yaml --run-id=trainingRun01 + ``` +12. Open a second terminal and start TensorBoard to monitor training. ``` tensorboard --logdir results ``` -11. Enter the Play mode in the Unity editor in the AI scene +13. Enter the Play mode in the Unity editor in the AI scene under ``SnakeGame\Assets\SnakeGame\_Levels\AI``.

(back to top)