Skip to content
Snippets Groups Projects
Commit 6ddd5812 authored by MasterScrat's avatar MasterScrat
Browse files

README touch ups

parent a9aa0078
No related branches found
No related tags found
No related merge requests found
...@@ -10,8 +10,6 @@ ...@@ -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. 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 [The official documentation](http://flatland.aicrowd.com/) contains full details about the environment and problem statement
🏆 Challenges 🏆 Challenges
...@@ -20,24 +18,23 @@ The base environment is a two-dimensional grid in which many agents can be place ...@@ -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! 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/) - [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 📦 Setup
--- ---
### Prerequisites ### Prerequisites (optional)
* Install [Anaconda](https://www.anaconda.com/distribution/) Install [Anaconda](https://www.anaconda.com/distribution/) and create a new conda environment:
* Create a new conda environment:
```console ```console
$ conda create python=3.6 --name flatland-rl $ conda create python=3.6 --name flatland-rl
$ conda activate flatland-rl $ conda activate flatland-rl
``` ```
### Stable Release ### Stable release
You can install Flatland from pip: Install Flatland from pip:
```console ```console
$ pip install flatland-rl $ pip install flatland-rl
...@@ -49,13 +46,13 @@ This is the preferred method to install Flatland, as it will always install the ...@@ -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). 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 ```console
$ git clone git@gitlab.aicrowd.com:flatland/flatland.git $ 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 ```console
$ python setup.py install $ python setup.py install
...@@ -78,7 +75,7 @@ python setup.py test ...@@ -78,7 +75,7 @@ python setup.py test
👥 Credits 👥 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 ➕ Contributions
--- ---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment