diff --git a/README.md b/README.md index 2b1018a786bda80317277e9da30523e5ce05cfdc..8105df33ad0e3cb4de71ae9834a58bb3832d368a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # NeurIPS 2020 Flatland Challenge baselines -The basic structure of this repository is adopted from [https://github.com/spMohanty/rl-experiments/](https://github.com/spMohanty/rl-experiments/) +📈 [**Results**](https://app.wandb.ai/masterscrat/flatland/reports/Flatland-Baselines--Vmlldzo4OTc5NA) -## Installation +Setup +--- Tested with Python 3.6 and 3.7 @@ -10,7 +11,7 @@ Tested with Python 3.6 and 3.7 conda create --name ray-env python=3.7 --yes ``` -You may need to install/update bazel: https://docs.bazel.build/versions/master/install-ubuntu.html +You may need to install/update bazel: [Ubuntu guide](https://docs.bazel.build/versions/master/install-ubuntu.html) ``` pip install ray[rllib] @@ -19,23 +20,28 @@ pip install -r requirements.txt ``` ## Usage -``` Training example: - python ./train.py -f experiments/flatland_random_sparse_small/global_obs_conv_net/ppo.yaml + +`python ./train.py -f experiments/flatland_random_sparse_small/global_obs_conv_net/ppo.yaml` Test example: - python ./rollout.py /tmp/ray/checkpoint_dir/checkpoint-0 --run PPO --no-render - --config '{"env_config": {"test": true}}' --episodes 1000 --out rollouts.pkl + +`python ./rollout.py /tmp/ray/checkpoint_dir/checkpoint-0 --run PPO --no-render + --config '{"env_config": {"test": true}}' --episodes 1000 --out rollouts.pkl` Note that -f overrides all other trial-specific command-line options. -``` ## Experiment structure -Experiments consist of one or many rllib YAML config files -alongside a MARKDOWN file containing results, plots -and a detailed description of the methodology. +Experiments consist of one or many RLlib YAML config files alongside a MARKDOWN file containing results, plots and a detailed description of the methodology. + All files are stored in a experiment folder under `experiments//`. -An example can be found under `experiments/flatland_random_sparse_small/global_obs_conv_net/README.md`. +- [Tree observations w/ fully connected network](master/experiments/flatland_random_sparse_small/tree_obs_fc_net) +- [Global observations w/ convnet](Global observation convnet experiments) + + +Notes +--- +- The basic structure of this repository is adopted from [https://github.com/spMohanty/rl-experiments/](https://github.com/spMohanty/rl-experiments/) \ No newline at end of file