From 6ddd5812550cedb08df1802610011841f4ec9ce0 Mon Sep 17 00:00:00 2001 From: flaurent <florian.laurent@gmail.com> Date: Thu, 11 Jun 2020 18:35:01 +0200 Subject: [PATCH] README touch ups --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8435845d..68a5a595 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,24 +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 ``` -### Stable Release +### Stable release -You can install Flatland from pip: +Install Flatland from pip: ```console $ pip install flatland-rl @@ -49,13 +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 @@ -78,7 +75,7 @@ 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 --- -- GitLab