README.md 3.69 KB
Newer Older
MasterScrat's avatar
MasterScrat committed
1
🚂 Flatland
u214892's avatar
u214892 committed
2
3
4
5
========

![Flatland](https://i.imgur.com/0rnbSLY.gif)

MasterScrat's avatar
MasterScrat committed
6
<p style="text-align:center">
MasterScrat's avatar
MasterScrat committed
7
<img alt="repository" src="https://gitlab.aicrowd.com/flatland/flatland/badges/master/pipeline.svg">
nimishsantosh107's avatar
nimishsantosh107 committed
8
<img alt="coverage" src="https://gitlab.aicrowd.com/flatland/flatland/badges/master/coverage.svg">
MasterScrat's avatar
MasterScrat committed
9
</p>
u214892's avatar
u214892 committed
10

MasterScrat's avatar
MasterScrat committed
11
Flatland is a open-source toolkit for developing and comparing Multi Agent Reinforcement Learning algorithms in little (or ridiculously large!) gridworlds.
u214892's avatar
u214892 committed
12

MasterScrat's avatar
MasterScrat committed
13
[The official documentation](http://flatland.aicrowd.com/) contains full details about the environment and problem statement
u214892's avatar
u214892 committed
14

nimishsantosh107's avatar
nimishsantosh107 committed
15
Flatland is tested with Python 3.6, 3.7 and 3.8 on modern versions of macOS, Linux and Windows. You may encounter problems with graphical rendering if you use WSL. Your [contribution is welcome](https://flatland.aicrowd.com/misc/contributing.html) if you can help with this!  
MasterScrat's avatar
MasterScrat committed
16

MasterScrat's avatar
MasterScrat committed
17
18
🏆 Challenges
---
u214892's avatar
u214892 committed
19

MasterScrat's avatar
MasterScrat committed
20
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!
u214892's avatar
u214892 committed
21

nimishsantosh107's avatar
nimishsantosh107 committed
22
23
- [Flatland 3 Challenge](https://www.aicrowd.com/challenges/flatland-3) - ONGOING!
- [AMLD 2021 Challenge](https://www.aicrowd.com/challenges/flatland)
MasterScrat's avatar
MasterScrat committed
24
- [NeurIPS 2020 Challenge](https://www.aicrowd.com/challenges/neurips-2020-flatland-challenge/)
MasterScrat's avatar
MasterScrat committed
25
- [2019 Challenge](https://www.aicrowd.com/challenges/flatland-challenge)
u214892's avatar
u214892 committed
26

MasterScrat's avatar
MasterScrat committed
27
28
📦 Setup
---
u214892's avatar
u214892 committed
29

MasterScrat's avatar
MasterScrat committed
30
### Prerequisites (optional)
MasterScrat's avatar
MasterScrat committed
31

MasterScrat's avatar
MasterScrat committed
32
Install [Anaconda](https://www.anaconda.com/distribution/) and create a new conda environment:
u214892's avatar
u214892 committed
33
34

```console
nimishsantosh107's avatar
nimishsantosh107 committed
35
$ conda create python=3.7 --name flatland-rl
u214892's avatar
u214892 committed
36
37
38
$ conda activate flatland-rl
```

MasterScrat's avatar
MasterScrat committed
39
### Stable release
u214892's avatar
u214892 committed
40

MasterScrat's avatar
MasterScrat committed
41
Install Flatland from pip:
u214892's avatar
u214892 committed
42
43
44
45
46

```console
$ pip install flatland-rl
```

MasterScrat's avatar
MasterScrat committed
47
This is the preferred method to install Flatland, as it will always install the most recent stable release.
u214892's avatar
u214892 committed
48

MasterScrat's avatar
MasterScrat committed
49
### From sources
u214892's avatar
u214892 committed
50

MasterScrat's avatar
MasterScrat committed
51
The Flatland code source is available from [AIcrowd gitlab](https://gitlab.aicrowd.com/flatland/flatland).
u214892's avatar
u214892 committed
52

MasterScrat's avatar
MasterScrat committed
53
Clone the public repository:
MasterScrat's avatar
MasterScrat committed
54

u214892's avatar
u214892 committed
55
56
57
58
```console
$ git clone git@gitlab.aicrowd.com:flatland/flatland.git
```

MasterScrat's avatar
MasterScrat committed
59
Once you have a copy of the source, install it with:
u214892's avatar
u214892 committed
60
61

```console
nimishsantosh107's avatar
nimishsantosh107 committed
62
$ pip install -e .
u214892's avatar
u214892 committed
63
64
```

u214892's avatar
u214892 committed
65
66
### Test installation

MasterScrat's avatar
MasterScrat committed
67
Test that the installation works:
u214892's avatar
u214892 committed
68
69
70
71
72

```console
$ flatland-demo
```

MasterScrat's avatar
MasterScrat committed
73
You can also run the full test suite:
u214892's avatar
u214892 committed
74

MasterScrat's avatar
MasterScrat committed
75
76
```console
python setup.py test
u214892's avatar
u214892 committed
77
78
```

MasterScrat's avatar
MasterScrat committed
79
80
👥 Credits
---
u214892's avatar
u214892 committed
81

nimishsantosh107's avatar
nimishsantosh107 committed
82
This library was developed by [SBB](https://www.sbb.ch/en/), [Deutsche Bahn](https://www.deutschebahn.com/), [SNCF](https://www.sncf.com/en), [AIcrowd](https://www.aicrowd.com/) and [numerous contributors](http://flatland.aicrowd.com/misc/credits.html) and AIcrowd research fellows from the AIcrowd community.
u214892's avatar
u214892 committed
83

MasterScrat's avatar
MasterScrat committed
84
85
➕ Contributions
---
MasterScrat's avatar
MasterScrat committed
86
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!
u214892's avatar
u214892 committed
87

MasterScrat's avatar
MasterScrat committed
88
89
💬 Communication
---
u214892's avatar
u214892 committed
90

MasterScrat's avatar
MasterScrat committed
91
92
93
* [Discord Channel](https://discord.com/invite/hCR3CZG)
* [Discussion Forum](https://discourse.aicrowd.com/c/neurips-2020-flatland-challenge)
* [Issue Tracker](https://gitlab.aicrowd.com/flatland/flatland/issues/)
u214892's avatar
u214892 committed
94

MasterScrat's avatar
MasterScrat committed
95
96
🔗 Partners
---
u214892's avatar
u214892 committed
97

nimishsantosh107's avatar
nimishsantosh107 committed
98
99
100
101
<a href="https://sbb.ch" target="_blank" style="margin-right:30px"><img src="https://annpr2020.ch/wp-content/uploads/2020/06/SBB.png" alt="SBB" width="140"/></a> 
<a href="https://www.deutschebahn.com/" target="_blank" style="margin-right:30px"><img src="https://i.imgur.com/pjTki15.png" alt="DB"  width="140"/></a>
<a href="https://www.sncf.com/en" target="_blank" style="margin-right:30px"><img src="https://iconape.com/wp-content/png_logo_vector/logo-sncf.png" alt="SNCF"  width="140"/></a>
<a href="https://www.aicrowd.com" target="_blank"><img src="https://i.imgur.com/kBZQGI9.png" alt="AIcrowd"  width="140"/></a>