Skip to content

Sb3ResumeSettings

Full path: schola.scripts.sb3.train.settings.Sb3ResumeSettings

Dataclass for holding arguments related to resuming training from a saved state.

Sb3ResumeSettings(resume_from = None, load_vecnormalize = None,
                  load_replay_buffer = None, reset_timestep = False)

Parameters

  • resume_from (Annotated)

  • load_vecnormalize (Annotated)

  • load_replay_buffer (Annotated)

  • reset_timestep (bool)

Methods

init

__init__(resume_from = None, load_vecnormalize = None,
         load_replay_buffer = None, reset_timestep = False)

Parameters

  • resume_from (Annotated)

  • load_vecnormalize (Annotated)

  • load_replay_buffer (Annotated)

  • reset_timestep (bool)

Attributes

load_replay_buffer

load_replay_buffer

Path to a saved replay buffer to load when resuming training. This allows for loading a previously saved replay buffer, which can be useful for continuing training with the same set of experiences. The path should point to a valid replay buffer file created by Stable Baselines3. If set to None, it will not load any replay buffer, and a new one will be created instead.

load_vecnormalize

load_vecnormalize

Path to a saved vector normalization statistics file to load when resuming training. This allows for loading the normalization statistics from a previous training session, ensuring that the observations are normalized consistently when resuming training. If set to None, it will not load any vector normalization statistics.

reset_timestep

reset_timestep

Whether to reset the internal timestep counter when resuming training from a saved model. When set to True, it will reset the timestep counter to 0.

resume_from

resume_from

Path to a saved model to resume training from. This allows for continuing training from a previously saved checkpoint. The path should point to a valid model file created by Stable Baselines3. If set to None, training will start from scratch.