flatland.envs package

Subpackages

• flatland.envs.graph package
  • Submodules
    • flatland.envs.graph.distance_map module
      • GraphDistanceMap
    • flatland.envs.graph.graph_rendering module
      • add_flatland_styling()
      • get_positions()
    • flatland.envs.graph.graph_simplification module
      • DecisionPointGraph
      • DecisionPointGraphEdgeData
    • flatland.envs.graph.rail_graph_transition_map module
      • GraphTransitionMap
  • Module contents
• flatland.envs.grid package
  • Submodules
    • flatland.envs.grid.distance_map module
      • DistanceMap
    • flatland.envs.grid.rail_env_grid module
      • RailEnvTransitions
      • RailEnvTransitionsEnum
  • Module contents
• flatland.envs.step_utils package
  • Submodules
    • flatland.envs.step_utils.action_saver module
      • ActionSaver
    • flatland.envs.step_utils.env_utils module
      • AgentTransitionData
    • flatland.envs.step_utils.malfunction_handler module
      • MalfunctionHandler
      • get_number_of_steps_to_break()
    • flatland.envs.step_utils.speed_counter module
      • SpeedCounter
    • flatland.envs.step_utils.state_machine module
      • TrainStateMachine
    • flatland.envs.step_utils.states module
      • StateTransitionSignals
      • TrainState
  • Module contents

Submodules

• flatland.envs.RailEnvPolicy module
• flatland.envs.agent_chains module
  • MotionCheck
    • MotionCheck.add_agent()
    • MotionCheck.check_motion()
    • MotionCheck.find_conflicts()
  • MotionCheckLegacy
    • MotionCheckLegacy.add_agent()
    • MotionCheckLegacy.check_motion()
    • MotionCheckLegacy.find_conflicts()
    • MotionCheckLegacy.find_stop_preds()
    • MotionCheckLegacy.find_stopped_agents()
    • MotionCheckLegacy.find_swaps()
    • MotionCheckLegacy.get_G_reversed()
    • MotionCheckLegacy.mark_preds()
• flatland.envs.agent_utils module
  • Agent
    • Agent.action_saver
    • Agent.arrival_time
    • Agent.direction
    • Agent.earliest_departure
    • Agent.handle
    • Agent.initial_direction
    • Agent.initial_position
    • Agent.latest_arrival
    • Agent.malfunction_handler
    • Agent.moving
    • Agent.old_direction
    • Agent.old_position
    • Agent.position
    • Agent.speed_counter
    • Agent.state_machine
    • Agent.target
    • Agent.waypoints
    • Agent.waypoints_earliest_departure
    • Agent.waypoints_latest_arrival
  • EnvAgent
    • EnvAgent.apply_timetable()
    • EnvAgent.direction
    • EnvAgent.from_line()
    • EnvAgent.get_current_delay()
    • EnvAgent.get_shortest_path()
    • EnvAgent.get_time_remaining_until_latest_arrival()
    • EnvAgent.get_travel_time_on_shortest_path()
    • EnvAgent.initial_direction
    • EnvAgent.initial_position
    • EnvAgent.load_legacy_static_agent()
    • EnvAgent.malfunction_data
    • EnvAgent.old_direction
    • EnvAgent.old_position
    • EnvAgent.position
    • EnvAgent.reset()
    • EnvAgent.speed_data
    • EnvAgent.state
    • EnvAgent.target
    • EnvAgent.to_agent()
    • EnvAgent.to_line()
  • load_env_agent()
• flatland.envs.distance_map module
• flatland.envs.fast_methods module
  • fast_argmax()
  • fast_clip()
  • fast_count_nonzero()
  • fast_delete()
  • fast_isclose()
  • fast_position_equal()
  • fast_where()
• flatland.envs.flatland_envs_rail_env_utils module
• flatland.envs.graph_rail_env module
  • GraphRailEnv
    • GraphRailEnv.from_rail_env()
    • GraphRailEnv.get_num_agents()
• flatland.envs.grid4_generators_utils module
  • align_cell_to_city()
  • connect_rail_in_grid_map()
  • connect_straight_line_in_grid_map()
  • fix_inner_nodes()
• flatland.envs.line_generators module
  • BaseLineGen
    • BaseLineGen.generate()
  • FileLineGenerator
    • FileLineGenerator.generate()
    • FileLineGenerator.save()
    • FileLineGenerator.wrap()
  • SparseLineGen
    • SparseLineGen.decide_orientation()
    • SparseLineGen.generate()
  • line_from_file()
  • sparse_line_generator()
  • speed_initialization_helper()
• flatland.envs.malfunction_effects_generators module
  • ConditionalMalfunctionEffectsGenerator
    • ConditionalMalfunctionEffectsGenerator.on_episode_step_start()
  • IntermediateStopMalfunctionEffectsGenerator
  • MalfunctionEffectsGenerator
    • MalfunctionEffectsGenerator.on_episode_step_start()
  • condition_stopped_cells_and_range()
  • condition_stopped_intermediate_and_range()
  • make_multi_malfunction_condition()
  • on_map_state_condition()
• flatland.envs.malfunction_generators module
  • FileMalfunctionGen
  • Malfunction
    • Malfunction.num_broken_steps
  • MalfunctionParameters
    • MalfunctionParameters.malfunction_rate
    • MalfunctionParameters.max_duration
    • MalfunctionParameters.min_duration
  • MalfunctionProcessData
    • MalfunctionProcessData.malfunction_rate
    • MalfunctionProcessData.max_duration
    • MalfunctionProcessData.min_duration
  • NoMalfunctionGen
  • ParamMalfunctionGen
    • ParamMalfunctionGen.generate()
    • ParamMalfunctionGen.generate_rand_numbers()
    • ParamMalfunctionGen.get_process_data()
  • malfunction_from_file()
  • malfunction_from_params()
  • no_malfunction_generator()
  • single_malfunction_generator()
• flatland.envs.observations module
  • FullEnvObservation
    • FullEnvObservation.get()
    • FullEnvObservation.reset()
    • FullEnvObservation.set_env()
  • GlobalObsForRailEnv
    • GlobalObsForRailEnv.get()
    • GlobalObsForRailEnv.reset()
    • GlobalObsForRailEnv.set_env()
  • LocalObsForRailEnv
    • LocalObsForRailEnv.field_of_view()
    • LocalObsForRailEnv.get()
    • LocalObsForRailEnv.reset()
  • Node
    • Node.childs
    • Node.dist_min_to_target
    • Node.dist_other_agent_encountered
    • Node.dist_other_target_encountered
    • Node.dist_own_target_encountered
    • Node.dist_potential_conflict
    • Node.dist_to_next_branch
    • Node.dist_unusable_switch
    • Node.num_agents_malfunctioning
    • Node.num_agents_opposite_direction
    • Node.num_agents_ready_to_depart
    • Node.num_agents_same_direction
    • Node.speed_min_fractional
  • TreeObsForRailEnv
    • TreeObsForRailEnv.get()
    • TreeObsForRailEnv.get_many()
    • TreeObsForRailEnv.print_node_features()
    • TreeObsForRailEnv.print_subtree()
    • TreeObsForRailEnv.reset()
    • TreeObsForRailEnv.set_env()
    • TreeObsForRailEnv.tree_explored_actions_char
    • TreeObsForRailEnv.util_print_obs_subtree()
• flatland.envs.observations_perturbed module
  • perturbation_tree_observation_builder_wrapper()
• flatland.envs.persistence module
  • RailEnvPersister
    • RailEnvPersister.deprecated_get_agent_state_msg()
    • RailEnvPersister.deprecated_get_full_state_dist_msg()
    • RailEnvPersister.deprecated_get_full_state_msg()
    • RailEnvPersister.deprecated_set_full_state_dist_msg()
    • RailEnvPersister.deprecated_set_full_state_msg()
    • RailEnvPersister.get_full_state()
    • RailEnvPersister.load()
    • RailEnvPersister.load_env_dict()
    • RailEnvPersister.load_new()
    • RailEnvPersister.load_resource()
    • RailEnvPersister.save()
    • RailEnvPersister.save_episode()
    • RailEnvPersister.set_full_state()
• flatland.envs.predictions module
  • DummyPredictorForRailEnv
    • DummyPredictorForRailEnv.get()
  • ShortestPathPredictorForRailEnv
    • ShortestPathPredictorForRailEnv.get()
• flatland.envs.rail_env module
  • AbstractRailEnv
    • AbstractRailEnv.action_required()
    • AbstractRailEnv.add_agent()
    • AbstractRailEnv.clear_rewards_dict()
    • AbstractRailEnv.end_of_episode_update()
    • AbstractRailEnv.get_agent_handles()
    • AbstractRailEnv.get_info_dict()
    • AbstractRailEnv.get_num_agents()
    • AbstractRailEnv.handle_done_state()
    • AbstractRailEnv.reset()
    • AbstractRailEnv.reset_agents()
    • AbstractRailEnv.step()
  • RailEnv
    • RailEnv.clone_from()
    • RailEnv.record_timestep()
    • RailEnv.step()
• flatland.envs.rail_env_action module
  • RailEnvActions
    • RailEnvActions.DO_NOTHING
    • RailEnvActions.MOVE_FORWARD
    • RailEnvActions.MOVE_LEFT
    • RailEnvActions.MOVE_RIGHT
    • RailEnvActions.STOP_MOVING
    • RailEnvActions.from_value()
    • RailEnvActions.is_action_valid()
    • RailEnvActions.is_left_right_action()
    • RailEnvActions.is_moving_action()
    • RailEnvActions.to_char()
• flatland.envs.rail_env_policies module
  • ShortestPathPolicy
    • ShortestPathPolicy.act_many()
• flatland.envs.rail_env_policy module
  • RailEnvPolicy
• flatland.envs.rail_env_shortest_paths module
  • get_k_shortest_paths()
  • visualize_distance_map()
• flatland.envs.rail_env_utils module
  • load_flatland_environment_from_file()
• flatland.envs.rail_generators module
  • EmptyRailGen
    • EmptyRailGen.generate()
  • FileRailFromGridGen
    • FileRailFromGridGen.from_dict()
    • FileRailFromGridGen.generate()
    • FileRailFromGridGen.save()
    • FileRailFromGridGen.to_dict()
    • FileRailFromGridGen.wrap()
  • RailFromGridGen
    • RailFromGridGen.generate()
  • RailGen
    • RailGen.generate()
  • RailGeneratorProduct
  • SparseRailGen
    • SparseRailGen.argsort()
    • SparseRailGen.fix_transitions()
    • SparseRailGen.generate()
    • SparseRailGen.get_closest_neighbour_for_direction()
  • empty_rail_generator()
  • rail_from_file()
  • rail_from_grid_transition_map()
  • sparse_rail_generator()
• flatland.envs.rail_grid_transition_map module
  • RailGridTransitionMap
    • RailGridTransitionMap.apply_action_independent()
    • RailGridTransitionMap.get_predecessor_configurations()
    • RailGridTransitionMap.get_successor_configurations()
    • RailGridTransitionMap.get_valid_directions_on_grid()
• flatland.envs.rail_trainrun_data_structures module
  • TrainrunWaypoint
    • TrainrunWaypoint.scheduled_at
    • TrainrunWaypoint.waypoint
  • Waypoint
    • Waypoint.direction
    • Waypoint.position
• flatland.envs.rewards module
  • BaseDefaultRewards
    • BaseDefaultRewards.cumulate()
    • BaseDefaultRewards.empty()
    • BaseDefaultRewards.end_of_episode_reward()
    • BaseDefaultRewards.normalize()
    • BaseDefaultRewards.step_reward()
  • BasicMultiObjectiveRewards
    • BasicMultiObjectiveRewards.cumulate()
    • BasicMultiObjectiveRewards.empty()
    • BasicMultiObjectiveRewards.end_of_episode_reward()
    • BasicMultiObjectiveRewards.normalize()
    • BasicMultiObjectiveRewards.step_reward()
  • DefaultPenalties
    • DefaultPenalties.CANCELLATION
    • DefaultPenalties.COLLISION
    • DefaultPenalties.INTERMEDIATE_EARLY_DEPARTURE
    • DefaultPenalties.INTERMEDIATE_LATE_ARRIVAL
    • DefaultPenalties.INTERMEDIATE_NOT_SERVED
    • DefaultPenalties.TARGET_LATE_ARRIVAL
    • DefaultPenalties.TARGET_NOT_REACHED
  • DefaultRewards
    • DefaultRewards.cancellation_factor
    • DefaultRewards.cancellation_time_buffer
    • DefaultRewards.collision_factor
    • DefaultRewards.cumulate()
    • DefaultRewards.empty()
    • DefaultRewards.end_of_episode_reward()
    • DefaultRewards.intermediate_early_departure_penalty_factor
    • DefaultRewards.intermediate_late_arrival_penalty_factor
    • DefaultRewards.intermediate_not_served_penalty
    • DefaultRewards.normalize()
    • DefaultRewards.step_reward()
  • PunctualityRewards
    • PunctualityRewards.cumulate()
    • PunctualityRewards.empty()
    • PunctualityRewards.end_of_episode_reward()
    • PunctualityRewards.step_reward()
  • Rewards
    • Rewards.cumulate()
    • Rewards.empty()
    • Rewards.end_of_episode_reward()
    • Rewards.normalize()
    • Rewards.step_reward()
  • defaultdict_list()
  • defaultdict_set()
• flatland.envs.schedule_generators module
• flatland.envs.timetable_generators module
  • FileTimetableGenerator
    • FileTimetableGenerator.generate()
    • FileTimetableGenerator.save()
    • FileTimetableGenerator.wrap()
  • len_handle_none()
  • timetable_from_file()
  • timetable_generator()
  • ttgen_flatland2()
• flatland.envs.timetable_utils module
  • Line
    • Line.agent_speeds
    • Line.agent_waypoints
  • Timetable
    • Timetable.earliest_departures
    • Timetable.latest_arrivals
    • Timetable.max_episode_steps
  • TimetableUtils
    • TimetableUtils.from_agents()

Module contents