Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Skylark0924 committed Aug 23, 2023
1 parent 3eff546 commit a763273
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions doc/source/tutorial/config_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ We adopt `hydra` as our configuration system. It is a powerful tool to manage AI
The pre-defined configurations for `RofuncRL` can be found in [`rofunc/config/learning/rl`](https://github.com/Skylark0924/Rofunc/tree/main/rofunc/config/learning/rl). Configurations for learning each task contains three files:

- `task/TaskName.yaml`: the task-related configurations for the task `TaskName` (e.g. DoughRolling)
- `train/TaskNameAgent`: the agent-related configurations for training. (e.g. DoughRollingPPORofuncRL)
- `train/TaskNameAgent.yaml`: the agent-related configurations for training. (e.g. DoughRollingPPORofuncRL)
- `config`: the template for generating configurations for both task and training algorithm.

Therefore, in each `main.py` script, you need to specify the task and the agent you want to train. For example, if you want to train the `DoughRolling` task with `PPO` algorithm, you need to specify `task=DoughRolling` and `train=DoughRollingPPORofuncRL` in the command line arguments. Then, the configuration system will automatically load the corresponding configurations for the task and the agent.
Expand Down Expand Up @@ -61,7 +61,7 @@ if __name__ == '__main__':
```

:::{tip}
More examples can be found in [example-RofuncRL](https://rofunc.readthedocs.io/en/latest/auto_examples/learning_rl/index.html)
More examples can be found in [Example/RofuncRL](https://rofunc.readthedocs.io/en/latest/auto_examples/learning_rl/index.html).
:::

## Customize configurations
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorial/customizeRL.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,5 +99,5 @@ if __name__ == '__main__':

:::{tip}
1. For more details about the configuration system, please refer to [Configuration System](https://rofunc.readthedocs.io/en/latest/tutorial/config_system.html).
2. More examples can be found in [example-RofuncRL](https://rofunc.readthedocs.io/en/latest/auto_examples/learning_rl/index.html)
2. More examples can be found in [Example/RofuncRL](https://rofunc.readthedocs.io/en/latest/auto_examples/learning_rl/index.html).
:::

0 comments on commit a763273

Please sign in to comment.