File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 22
33# Configuration
44
5- ## Hyperparameter yaml syntax
5+ ## Hyperparameter YAML syntax
66
77The syntax used in ` hyperparameters/algo_name.yml ` for setting
88hyperparameters (likewise the syntax to [ overwrite
Original file line number Diff line number Diff line change 44
55## Prerequisites
66
7- RL Zoo requires python 3.8 + and PyTorch >= 1.13
7+ RL Zoo requires Python 3.10 + and PyTorch >= 2.3
88
99## Minimal Installation
1010
@@ -36,8 +36,8 @@ additionally to download the ROMs
3636:::
3737
3838``` bash
39- apt-get install swig cmake ffmpeg
40- pip install -r requirements.txt
39+ apt-get install swig cmake ffmpeg
40+ pip install -r requirements.txt
4141pip install -e .[plots,tests]
4242```
4343
Original file line number Diff line number Diff line change 44
55## Huggingface Hub Integration
66
7- List and videos of trained agents can be found on our Huggingface page: < https://huggingface.co/sb3 >
7+ Lists and videos of trained agents can be found on our Huggingface page: < https://huggingface.co/sb3 >
88
99Upload model to hub (same syntax as for ` enjoy.py ` ):
1010
1111```
1212python -m rl_zoo3.push_to_hub --algo ppo --env CartPole-v1 -f logs/ -orga sb3 -m "Initial commit"
1313```
1414
15- you can choose custom ` repo-name ` (default: ` {algo}-{env_id} ` ) by
15+ You can choose custom ` repo-name ` (default: ` {algo}-{env_id} ` ) by
1616passing a ` --repo-name ` argument.
1717
1818Download model from hub:
@@ -35,5 +35,5 @@ python train.py --algo ppo --env CartPole-v1 --track --wandb-project-name sb3
3535yields a tracked experiment at this
3636[ URL] ( https://wandb.ai/openrlbenchmark/sb3/runs/1b65ldmh ) .
3737
38- To add a tag to the run, (e.g. ` optimized ` ), use the argument
38+ To add a tag to the run (e.g. ` optimized ` ), use the argument
3939` --wandb-tags optimized ` .
Original file line number Diff line number Diff line change @@ -59,4 +59,4 @@ each environment.
5959:::
6060
6161Remark: plotting with the ` --rliable ` option is usually slow as
62- confidence interval need to be computed using bootstrap sampling.
62+ confidence intervals need to be computed using bootstrap sampling.
Original file line number Diff line number Diff line change @@ -8,7 +8,7 @@ The hyperparameters for each environment are defined in
88` hyperparameters/algo_name.yml ` .
99
1010:::{note}
11- Once RL Zoo3 is install , you can do ` python -m rl_zoo3.train ` from any folder, it is equivalent to ` python train.py `
11+ Once RL Zoo3 is installed , you can run ` python -m rl_zoo3.train ` from any folder, which is equivalent to ` python train.py ` .
1212:::
1313
1414If the environment exists in this file, then you can train an agent using:
You can’t perform that action at this time.
0 commit comments