Flatland issueshttps://gitlab.aicrowd.com/flatland/flatland/-/issues2020-06-11T20:30:38Zhttps://gitlab.aicrowd.com/flatland/flatland/-/issues/309Move Documentatino to one place2020-06-11T20:30:38ZErik NygrenMove Documentatino to one placeWe want to keep all the documentation at one place.
Look that all information can be found on the one global documentationWe want to keep all the documentation at one place.
Look that all information can be found on the one global documentationhttps://gitlab.aicrowd.com/flatland/flatland/-/issues/278Errors in Getting Started Doc2020-06-11T20:48:32ZashivaniErrors in Getting Started Doc* [ ] File: https://gitlab.aicrowd.com/flatland/flatland/blob/master/docs/tutorials/02_observationbuilder.rst
- Topic : ## How to access environment and agent data for observation builders
- Transition Map
The...* [ ] File: https://gitlab.aicrowd.com/flatland/flatland/blob/master/docs/tutorials/02_observationbuilder.rst
- Topic : ## How to access environment and agent data for observation builders
- Transition Map
The link in the last line "here_" is wrong.
* [ ] File : https://gitlab.aicrowd.com/flatland/flatland/blob/master/docs/tutorials/02_observationbuilder.rst
- Topic : ## Agent Information - Agent Speed Information
Expected but no link found in the last point.
* [ ] File : https://gitlab.aicrowd.com/flatland/flatland/blob/master/docs/tutorials/03_rail_and_schedule_generator.md
- Topic : ##Sparse Rail Generator
- Comment the explanation part in first code snippet.MasterScratMasterScrathttps://gitlab.aicrowd.com/flatland/flatland/-/issues/261Clean Up Redundancies in Docs2020-06-11T20:45:44ZErik NygrenClean Up Redundancies in Docs### Story
As a Participant i want o better understand how flatland works. Contraticting infromation in the docs make this hard.
We have to go through all the documentations to guarantee that information is not presented twice with differ...### Story
As a Participant i want o better understand how flatland works. Contraticting infromation in the docs make this hard.
We have to go through all the documentations to guarantee that information is not presented twice with different details.
Also we need to be sure that these concepts are explained to the participants
* [ ] Level Generation
* [ ] Rail and Schedule Generator interplay: Is documented only needs update. [here](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#rail-generators-and-schedule-generators)
* [ ] Generate from file: Simple example
* [ ] Sequential execution of steps by agents:
* [ ] This means that even though solutions would be possible in simultaneous execution it might be infeasible with sequential
* [ ] Agent index is thus also kind o a priority. Given the index you can know what agent willg o first
* [ ] Malfunction behavior
* [ ] What happens to agents if they are malfuncitoning at the start (counter only goes down when entered in level)
* [ ] What happens if agent malfunctions in middle of cell and is then restarted [update here](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#railenv-malfunctioning-stochasticity)
* [ ] Action space, why is there an action do nothing [update here](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#action-space)
* [ ] Observation space. Seem to be present at multiple places and outdated [here](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#tree-observation)
* [ ] The observations are also again explained [here](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#tree-observation-builder) and seem to be updated here.
* [ ] [This](http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/04_specifications.html#rail-generators-and-schedule-generators) leads to alot of redundancies. It is nice and updated but we should remove where it is showing the same infromation again.
### Acceptance Criteria
- Redundancies in Docs are gone
- Test this maybe with outsiders within SBB that have never used the repository
https://gitlab.aicrowd.com/flatland/flatland/-/issues/82Add a "How do I .... ?" section to the documentation2020-06-11T20:43:52ZmohantyAdd a "How do I .... ?" section to the documentationThe goal of a `How do I...?` section in the documentation is to aggregate simple code snippets for a series of common tasks of different complexity, for example : how do I load and interact with an environment pickle file. How do I draw ...The goal of a `How do I...?` section in the documentation is to aggregate simple code snippets for a series of common tasks of different complexity, for example : how do I load and interact with an environment pickle file. How do I draw my own env, etc.
Its a non exhaustive list, but we can get started with some, and user contributions will enrich it with time !
If you have some of such "How do I....?" tasks in mind, please include them in the comments.v3mohantymohantyhttps://gitlab.aicrowd.com/flatland/flatland/-/issues/350Add mathematical formulation of the flatland problem to flatland book2024-02-03T12:15:42ZmmartiAdd mathematical formulation of the flatland problem to flatland bookWe should consider adding a mathematical formulation of the flatland problem to the flatland book, maybe like in the thesis of Ryzner (see https://dspace.cvut.cz/bitstream/handle/10467/87776/F3-BP-2020-Ryzner-Filip-BP_FILIP_RYZNER_2020.p...We should consider adding a mathematical formulation of the flatland problem to the flatland book, maybe like in the thesis of Ryzner (see https://dspace.cvut.cz/bitstream/handle/10467/87776/F3-BP-2020-Ryzner-Filip-BP_FILIP_RYZNER_2020.pdf on page 8).
I am not sure that all the details there are correct though.https://gitlab.aicrowd.com/flatland/flatland/-/issues/349Add more material on OR / planning approaches to flatland book2023-04-14T13:29:16ZmmartiAdd more material on OR / planning approaches to flatland bookIn the flatland book (see https://flatland.aicrowd.com/intro.html), section "Tutorials", we should add more material on OR / planning approaches (e.g. complete path reservation, prioritized planning, conflict-based methods, ...).
We shou...In the flatland book (see https://flatland.aicrowd.com/intro.html), section "Tutorials", we should add more material on OR / planning approaches (e.g. complete path reservation, prioritized planning, conflict-based methods, ...).
We should have links to the relevant papers, and ideally some baseline code ready to run in a notebook.https://gitlab.aicrowd.com/flatland/flatland/-/issues/326where is the `observation_utils`?2023-09-21T10:48:24Zxzhaomawhere is the `observation_utils`?following the tutorial here:
https://flatland.aicrowd.com/getting-started/rl/single-agent.html
The fourth line of :
```
from flatland.envs.rail_env import RailEnv
from flatland.envs.rail_generators import sparse_rail_generator
from fla...following the tutorial here:
https://flatland.aicrowd.com/getting-started/rl/single-agent.html
The fourth line of :
```
from flatland.envs.rail_env import RailEnv
from flatland.envs.rail_generators import sparse_rail_generator
from flatland.envs.schedule_generators import sparse_schedule_generator
from utils.observation_utils import normalize_observation
from flatland.envs.observations import TreeObsForRailEnv
```
there is actually no `utils`.
And under `flatland.utils`, there's no `observation_utils`...
Is the project updated? Where should I find that function?https://gitlab.aicrowd.com/flatland/flatland/-/issues/312Examples Repository2020-01-22T20:05:24ZErik NygrenExamples RepositoryWe want to make a seperate Example Repository where we can keep flatland version and examples synchronized.
Tasks:
* Make Repository
* Add Examples to Repository
* Check that examples are compatible with PyPi packageWe want to make a seperate Example Repository where we can keep flatland version and examples synchronized.
Tasks:
* Make Repository
* Add Examples to Repository
* Check that examples are compatible with PyPi packageMasterScratMasterScrathttps://gitlab.aicrowd.com/flatland/flatland/-/issues/258Document agent.status and env.done when finishing early2019-10-24T16:10:06ZErik NygrenDocument agent.status and env.done when finishing early### Story
As a TEAM MEMBER, I want clearly document the behavior of `agent.status` and `env.done` so that USERS of Flatland have a clear understanding of the meaning of these parameters.
Meaning of different parameters:
`env.done = TRUE...### Story
As a TEAM MEMBER, I want clearly document the behavior of `agent.status` and `env.done` so that USERS of Flatland have a clear understanding of the meaning of these parameters.
Meaning of different parameters:
`env.done = TRUE` The environment has terminated --> All agents are done or the max_timesteps was achieved
`agent.status=DONE` --> Agent finished its tasks and remains in the environment
`agent.status=DONE_REMOVED` --> Agent finishes its individual task and was removed from the environment.
### Acceptance Criteria
- Documentation in the main documentation about the different cases `done=True` vs `agent.status = DONE or DONE_REMOVE`https://gitlab.aicrowd.com/flatland/flatland/-/issues/225Documentation - Doc string for function to_list2019-10-22T19:35:30ZashivaniDocumentation - Doc string for function to_listhttps://gitlab.aicrowd.com/flatland/flatland/blob/master/flatland/envs/agent_utils.py#L75
Missing doc string for function to_list.https://gitlab.aicrowd.com/flatland/flatland/blob/master/flatland/envs/agent_utils.py#L75
Missing doc string for function to_list.ashivaniashivanihttps://gitlab.aicrowd.com/flatland/flatland/-/issues/158Training in Flatland 2.0 Documentation2019-10-16T12:52:04ZErik NygrenTraining in Flatland 2.0 DocumentationWrite document on how to train agents properly in new environment.
Here we need to show how to respect multi speed and malfunctions. These two new features mean that agents cannot act at all time steps. Thus during training we need to re...Write document on how to train agents properly in new environment.
Here we need to show how to respect multi speed and malfunctions. These two new features mean that agents cannot act at all time steps. Thus during training we need to respect this.v3https://gitlab.aicrowd.com/flatland/flatland/-/issues/84Series of examples of increasing difficulty2020-06-11T20:51:07ZChristian EichenbergerSeries of examples of increasing difficulty* [ ] @mlerik examples are labelled in a sensible order and remove examples not working, write for an interested student.
* [ ] @mohanty examples are documented
* [ ] @christian\_eichenberger examples are run in continuous integration
*...* [ ] @mlerik examples are labelled in a sensible order and remove examples not working, write for an interested student.
* [ ] @mohanty examples are documented
* [ ] @christian\_eichenberger examples are run in continuous integration
* [ ] @mlerik link to go further to baselines #42 that will use the env for training with ML/DL.v3mohantymohanty