Skip to content

Commit e046d33

Browse files
authored
Merge pull request #12 from edbeeching/doc_updates
Doc, env and checkpoint updates for version 0.2
2 parents dc8aba7 + 1ab740e commit e046d33

File tree

112 files changed

+4322
-12585
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+4322
-12585
lines changed

docs/EXAMPLE_ENVIRONMENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
4242
### Pretrained models:
4343
We provide pretrained models while can be visualized with the following command:
4444
```
45-
gdrl --env_path envs/builds/JumperHard/jumper_hard.x86_64 --eval --restore envs/checkpoints/jumper_hard/checkpoint_004000/checkpoint-4000
45+
gdrl --env_path envs/builds/JumperHard/jumper_hard.x86_64 --eval --restore envs/checkpoints/jumper_hard/checkpoint_000500/checkpoint-500
4646
4747
```
4848

@@ -81,7 +81,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
8181
### Pretrained models:
8282
We provide pretrained models while can be visualized with the following command:
8383
```
84-
gdrl --env_path envs/builds/BallChase/ball_chase.x86_64 --eval --restore envs/checkpoints/ball_chase/checkpoint_001000/checkpoint-1000
84+
gdrl --env_path envs/builds/BallChase/ball_chase.x86_64 --eval --restore envs/checkpoints/ball_chase/checkpoint_000100/checkpoint-100
8585
8686
```
8787

@@ -118,7 +118,7 @@ tensorboard --logdir /PATH/TO/LOG/DIR
118118
### Pretrained models:
119119
We provide pretrained models while can be visualized with the following command:
120120
```
121-
gdrl --env_path envs/builds/FlyBy/fly_by.x86_64 --eval --restore envs/checkpoints/fly_by/checkpoint_000940/checkpoint-940
121+
gdrl --env_path envs/builds/FlyBy/fly_by.x86_64 --eval --restore envs/checkpoints/fly_by/checkpoint_000500/checkpoint-500
122122
123123
```
124124

docs/INSTALLATION.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,27 @@ Please ensure to download a release version of Godot RL agents as the main branc
99
| Release v0.1.0 | 17/10/2021 | [v0.1.0](https://github.com/edbeeching/godot_rl_agents/releases/tag/v0.1.0) |
1010

1111
## Windows
12-
Unless you are an experienced python3 user, we recommend installing using
13-
[conda](https://docs.conda.io/en/latest/miniconda.html)
12+
The [conda](https://docs.conda.io/en/latest/miniconda.html) package manager is used to install all packages.
13+
Execute the following commands from a terminal window (e.g powershell)
14+
Make sure you are inside the godot_rl_agents directory
1415
```
15-
conda create -n your_env_name python=3.8
16-
conda activate your_env_name
16+
conda create env
17+
conda activate gdrl_conda
1718
conda install -c conda-forge brotlipy # this may we required on windows
18-
cd godot_rl_agents
19-
pip install -r requirements.txt
20-
pip install -e .
19+
20+
pip install .
2121
```
2222

2323
## Linux
24-
Unless you are an experienced python3 user, we recommend installing using
25-
[conda](https://docs.conda.io/en/latest/miniconda.html)
24+
The [conda](https://docs.conda.io/en/latest/miniconda.html) package manager is used to install all packages.
25+
Execute the following commands from a terminal window
26+
Make sure you are inside the godot_rl_agents directory
2627
```
27-
conda create -n your_env_name python=3.8
28-
conda activate your_env_name
29-
cd godot_rl_agents
30-
pip install -r requirements.txt
31-
pip install -e .
28+
conda create env
29+
conda activate gdrl_conda
30+
conda install -c conda-forge brotlipy # this may we required on windows
31+
32+
pip install .
3233
```
3334

3435
# After Installation

0 commit comments

Comments
 (0)