From 436674716dd0a8c034d23519085d7d0a0a61b332 Mon Sep 17 00:00:00 2001 From: gmollard <guillaume.mollard2@gmail.com> Date: Sat, 29 Jun 2019 12:37:48 +0000 Subject: [PATCH] Update README.md --- RLLib_training/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/RLLib_training/README.md b/RLLib_training/README.md index 63afbd4..de772db 100644 --- a/RLLib_training/README.md +++ b/RLLib_training/README.md @@ -1,6 +1,6 @@ This repository allows to run Rail Environment multi agent training with the RLLib Library. -It should be clone inside the main flatland repository. +It should be cloned inside the main flatland repository. ## Installation: ```sh @@ -8,20 +8,20 @@ pip install ray pip install gin-config ``` -To start a grid search on some parameters, you can create a folder containing a config.gin file (see example in `grid_search_configs/n_agents_grid_search/config.gin`. +To start a training with different parameters, you can create a folder containing a config.gin file (see example in `experiment_configs/config_example/config.gin`. -Then, you can modify the config.gin file path at the end of the `grid_search_train.py` file. +Then, you can modify the config.gin file path at the end of the `train_experiment.py` file. The results will be stored inside the folder, and the learning curves can be visualized in tensorboard: ``` -tensorboard --logdir=/path/to/foler_containing_config_gin_file +tensorboard --logdir=/path/to/folder_containing_config_gin_file ``` ## Gin config files -In each config.gin files, all the parameters, except `local_dir` of the `run_experiment` functions have to be specified. +In each config.gin files, all the parameters of the `run_experiment` functions have to be specified. For example, to indicate the number of agents that have to be initialized at the beginning of each simulation, the following line should be added: ``` @@ -54,4 +54,4 @@ Note that `@TreeObsForRailEnv` references the class, while `@TreeObsForRailEnv() -More documentation on how to use gin-config can be found on the library github repository: https://github.com/google/gin-config +More documentation on how to use gin-config can be found on the github repository: https://github.com/google/gin-config -- GitLab