Flatland documentation / code inconsistency

Flatland Challenge
#1

Hi,

The code and the documentation in the latest version (2.1.10) is inconsistent.
In example.py the import line:

from flatland.envs.malfunction_generators import malfunction_from_params, MalfunctionParameters
is inconsistent as there is no MalfunctionParameters class / function.

In the main readmd.md the line:

env = RailEnv(width=width,
height=height,
rail_generator=rail_generator,
schedule_generator=schedule_generator,
number_of_agents=nr_trains,
malfunction_generator_and_process_data=malfunction_from_params(stochastic_data),
obs_builder_object=observation_builder,
remove_agents_at_target=True # Removes agents at the end of their journey to make space for others
)

creates an error as malfunction_from_params is not imported.
Can you please fix these and create a consistent example file?

2 Likes
#2

Hi @eli_meirom

Thank you for pointing this out. We had just realized this at the current week. A workaround is to check out an earlier version of the Example. But we will also update the example to be compatible with the earlier version.

Sorry for the caused inconvenience…