Merge pull request #12 from edbeeching/doc_updates

Doc, env and checkpoint updates for version 0.2
edbeeching · Mar 24, 2022 · e046d33 · e046d33
2 parents dc8aba7 + 1ab740e
commit e046d33
Show file tree

Hide file tree

Showing 112 changed files with 4,322 additions and 12,585 deletions.
diff --git a/docs/EXAMPLE_ENVIRONMENTS.md b/docs/EXAMPLE_ENVIRONMENTS.md
@@ -42,7 +42,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
 ### Pretrained models:
 We provide pretrained models while can be visualized with the following command:
 ```
-gdrl --env_path envs/builds/JumperHard/jumper_hard.x86_64 --eval --restore envs/checkpoints/jumper_hard/checkpoint_004000/checkpoint-4000
+gdrl --env_path envs/builds/JumperHard/jumper_hard.x86_64 --eval --restore envs/checkpoints/jumper_hard/checkpoint_000500/checkpoint-500
 
 ```
 
@@ -81,7 +81,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
 ### Pretrained models:
 We provide pretrained models while can be visualized with the following command:
 ```
-gdrl --env_path envs/builds/BallChase/ball_chase.x86_64 --eval --restore envs/checkpoints/ball_chase/checkpoint_001000/checkpoint-1000
+gdrl --env_path envs/builds/BallChase/ball_chase.x86_64 --eval --restore envs/checkpoints/ball_chase/checkpoint_000100/checkpoint-100
 
 ```
 
@@ -118,7 +118,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
 ### Pretrained models:
 We provide pretrained models while can be visualized with the following command:
 ```
-gdrl --env_path envs/builds/FlyBy/fly_by.x86_64 --eval --restore envs/checkpoints/fly_by/checkpoint_000940/checkpoint-940
+gdrl --env_path envs/builds/FlyBy/fly_by.x86_64 --eval --restore envs/checkpoints/fly_by/checkpoint_000500/checkpoint-500
 
 ```
 

diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md
@@ -9,26 +9,27 @@ Please ensure to download a release version of Godot RL agents as the main branc
 | Release v0.1.0 |    17/10/2021    | [v0.1.0](https://github.com/edbeeching/godot_rl_agents/releases/tag/v0.1.0) |
 
 ## Windows
-Unless you are an experienced python3 user, we recommend installing using
-[conda](https://docs.conda.io/en/latest/miniconda.html)
+The [conda](https://docs.conda.io/en/latest/miniconda.html) package manager is used to install all packages.
+Execute the following commands from a terminal window (e.g powershell)
+Make sure you are inside the godot_rl_agents directory
 ```
-conda create -n your_env_name python=3.8 
-conda activate your_env_name
+conda create env
+conda activate gdrl_conda
 conda install -c conda-forge brotlipy # this may we required on windows
-cd godot_rl_agents
-pip install -r requirements.txt
-pip install -e .
+
+pip install .
 ```
 
 ## Linux
-Unless you are an experienced python3 user, we recommend installing using
-[conda](https://docs.conda.io/en/latest/miniconda.html)
+The [conda](https://docs.conda.io/en/latest/miniconda.html) package manager is used to install all packages.
+Execute the following commands from a terminal window
+Make sure you are inside the godot_rl_agents directory
 ```
-conda create -n your_env_name python=3.8 
-conda activate your_env_name
-cd godot_rl_agents
-pip install -r requirements.txt
-pip install -e .
+conda create env
+conda activate gdrl_conda
+conda install -c conda-forge brotlipy # this may we required on windows
+
+pip install .
 ```
 
 # After Installation