diff --git a/README.md b/README.md index f108e380706189311ed217adb5bf676994d27e3c..68a5a5957c14818d8bbfa5e8db110fd941d4b608 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,6 @@ Flatland is a open-source toolkit for developing and comparing Multi Agent Reinforcement Learning algorithms in little (or ridiculously large!) gridworlds. -The base environment is a two-dimensional grid in which many agents can be placed, and each agent must solve one or more navigational tasks in the grid world. - [The official documentation](http://flatland.aicrowd.com/) contains full details about the environment and problem statement 🆠Challenges @@ -20,30 +18,23 @@ The base environment is a two-dimensional grid in which many agents can be place This library was developed specifically for the AIcrowd [Flatland challenges](http://flatland.aicrowd.com/research/top-challenge-solutions.html) in which we strongly encourage you to take part in! - [NeurIPS 2020 Challenge](https://www.aicrowd.com/challenges/neurips-2020-flatland-challenge/) -- [2019 Challegent](https://www.aicrowd.com/challenges/flatland-challenge) +- [2019 Challenge](https://www.aicrowd.com/challenges/flatland-challenge) 📦 Setup --- -### Prerequisites +### Prerequisites (optional) -* Install [Anaconda](https://www.anaconda.com/distribution/) -* Create a new conda environment: +Install [Anaconda](https://www.anaconda.com/distribution/) and create a new conda environment: ```console $ conda create python=3.6 --name flatland-rl $ conda activate flatland-rl ``` -* Install the necessary dependencies: - -```console -$ conda install -c anaconda tk -``` - -### Stable Release +### Stable release -You can install Flatland from pip: +Install Flatland from pip: ```console $ pip install flatland-rl @@ -55,12 +46,13 @@ This is the preferred method to install Flatland, as it will always install the The Flatland code source is available from [AIcrowd gitlab](https://gitlab.aicrowd.com/flatland/flatland). -You can clone the public repository: +Clone the public repository: + ```console $ git clone git@gitlab.aicrowd.com:flatland/flatland.git ``` -Once you have a copy of the source, you can install it with: +Once you have a copy of the source, install it with: ```console $ python setup.py install @@ -83,11 +75,11 @@ python setup.py test 👥 Credits --- -This library was developed by [SBB](https://www.sbb.ch/en/), [AIcrowd](https://www.aicrowd.com/) and [numerous contributors](http://flatland.aicrowd.com/misc/credits.html) and AIcrowd research fellows from the AIcrowd community. +This library was developed by [SBB](https://www.sbb.ch/en/), [Deutsche Bahn](https://www.deutschebahn.com/), [AIcrowd](https://www.aicrowd.com/) and [numerous contributors](http://flatland.aicrowd.com/misc/credits.html) and AIcrowd research fellows from the AIcrowd community. ➕ Contributions --- -Please follow the [Contribution Guidelines](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/contributing.html) for more details on how you can successfully contribute to the project. We enthusiastically look forward to your contributions. +Please follow the [Contribution Guidelines](https://flatland.aicrowd.com/misc/contributing.html) for more details on how you can successfully contribute to the project. We enthusiastically look forward to your contributions! 💬 Communication --- diff --git a/examples/training_example.py b/examples/training_example.py index 5f8cbe4088b1358e13a323a7c665ac8ccf60f740..56a7947e85b81e69640c18f3a19dad07a74b4fc7 100644 --- a/examples/training_example.py +++ b/examples/training_example.py @@ -19,7 +19,7 @@ env = RailEnv(width=20, height=20, schedule_generator=complex_schedule_generator(), number_of_agents=3, obs_builder_object=TreeObservation) env.reset() -env_renderer = RenderTool(env, gl="PILSVG", ) +env_renderer = RenderTool(env) # Import your own Agent or use RLlib to train agents on Flatland diff --git a/flatland/envs/malfunction_generators.py b/flatland/envs/malfunction_generators.py index 99082ddd764c62e16ad6b71bef7901333732cc4b..2f27eca3652b89866432067ec50dda7ab6bdf2ff 100644 --- a/flatland/envs/malfunction_generators.py +++ b/flatland/envs/malfunction_generators.py @@ -103,7 +103,7 @@ def malfunction_from_params(parameters: MalfunctionParameters) -> Tuple[Malfunct ---------- parameters : contains all the parameters of the malfunction - malfunction_rate : float how many time steps it takes for a sinlge agent befor it breaks + malfunction_rate : float rate per timestep at which each agent malfunctions min_duration : int minimal duration of a failure max_number_of_steps_broken : int maximal duration of a failure