Skip to content
Snippets Groups Projects
README.rst 1.47 KiB
Newer Older
Vaibhav Agrawal's avatar
Vaibhav Agrawal committed
# Flatland

spmohanty's avatar
spmohanty committed



.. image:: https://gitlab.aicrowd.com/flatland/flatland/badges/master/pipeline.svg
     :target: https://gitlab.aicrowd.com/flatland/flatland/pipelines
     :alt: Test Running
.. image:: https://gitlab.aicrowd.com/flatland/flatland/badges/master/coverage.svg
     :target: https://gitlab.aicrowd.com/flatland/flatland/pipelines
maljx's avatar
maljx committed
     :alt: Test Coverage
spmohanty's avatar
spmohanty committed



Multi Agent Reinforcement Learning on Trains

Generate Docs
--------------
spmohanty's avatar
spmohanty committed
     | The docs have a lot more details about how to interact with this codebase.   
     | **TODO**: Mohanty to add atleast a neat outline herefor the contents to the docs here.

maljx's avatar
maljx committed
     .. code-block:: bash
spmohanty's avatar
spmohanty committed

          git clone git@gitlab.aicrowd.com:flatland/flatland.git
          cd flatland
          pip install -r requirements_dev.txt
maljx's avatar
maljx committed

     * Linux and macOS

          .. code-block:: bash

               make docs


     * Windows

          .. code-block:: bash

               python setup.py develop (or)
               python setup.py install
               python make_docs.py

spmohanty's avatar
spmohanty committed
Features
--------

* TODO

Vaibhav Agrawal's avatar
Vaibhav Agrawal committed

Installation
--------
     | To install the **Stable Release** of flatland, run this command in your terminal:
     
     .. code-block:: bash
     
          pip install flatland-rl




spmohanty's avatar
spmohanty committed
Authors
--------
* Sharada Mohanty <mohanty@aicrowd.com>
spiglerg's avatar
spiglerg committed
* Giacomo Spigler <giacomo.spigler@gmail.com>
* Mattias Ljungström <ml@mljx.io>
hagrid67's avatar
hagrid67 committed
* Jeremy Watson
Erik Nygren's avatar
Erik Nygren committed
* Erik Nygren <erik.nygren@sbb.ch>
adrian_egli's avatar
adrian_egli committed
* Adrian Egli <adrian.egli@sbb.ch>
maljx's avatar
maljx committed

<please fill yourself in>