flatland.envs.persistence module

class flatland.envs.persistence.RailEnvPersister

Bases: object

deprecated_get_agent_state_msg() → Packer

Returns agents information in msgpack object

deprecated_get_full_state_dist_msg() → Packer

Returns environment information with distance map information as msgpack object

deprecated_get_full_state_msg() → Packer

Returns state of environment in msgpack object

deprecated_set_full_state_dist_msg(msg_data)

Sets environment grid state and distance map with msgdata object passed as argument

Parameters

msg_data: msgpack object

deprecated_set_full_state_msg(msg_data)

Sets environment state with msgdata object passed as argument

Parameters

msg_data: msgpack object

classmethod get_full_state(env)

Returns state of environment in dict object, ready for serialization

classmethod load(env: RailEnv, filename: str | Path = None, env_dict=None, load_from_package: str | None = None, obs_builder: ObservationBuilder[RailEnv, RailEnv] | None = None)

Load environment with distance map from a file into existing env.

Parameters:

env: RailEnv filename: Union[str, Path] load_from_package: Optional[str]

defaults to None.

obs_builderObservationBuilder[RailEnv]

defaults to None. If None, then a DummyObservationBuilder is installed.

classmethod load_env_dict(filename: str | Path, load_from_package=None) → Dict

classmethod load_new(filename: str | Path, load_from_package=None, obs_builder: ObservationBuilder[Any, RailEnv] | None = None, rewards: Rewards | None = None, effects_generator: EffectsGenerator[RailEnv] | None = None) → Tuple[RailEnv, Dict]

Load environment with distance map from a file into new env.

obs_builder, rewards and effects_generator are never part of the persisted state as such (only effects_generator has a genuine persisted counterpart, restored from env_dict); if given, each of the three always takes effect for the restored env, replacing rather than merging with any restored or default counterpart.

Parameters:

filename: Union[str, Path] load_from_package: Optional[str]

defaults to None.

obs_builderObservationBuilder[RailEnv]

obs builder for the restored env. Defaults to DummyObservationBuilder if not given.

rewardsRewards

rewards for the restored env. Defaults to the env’s own default rewards if not given.

effects_generatorEffectsGenerator

if given, replaces the effects generator restored from env_dict instead of being discarded.

classmethod load_resource(package, resource)

Load environment (with distance map?) from a binary

classmethod save(env, filename: str | Path, save_distance_maps=False)

Saves environment and distance map information in a file

Parameters:

filename: string save_distance_maps: bool

classmethod save_episode(env, filename)

classmethod set_full_state(env, env_dict, effects_generator: EffectsGenerator | None = None)

Sets environment state from env_dict

Parameters

env_dict: dict effects_generator: Optional[EffectsGenerator]

if given, replaces the effects generator restored from env_dict instead of being discarded. Without this, any effects generator passed to the RailEnv constructor would be silently discarded here, since env_dict’s “new format” effects_generator state (if present) always takes precedence at reconstruction time.