Skip to content

Sb3CheckpointSettings

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

SB3-specific checkpoint settings.

Sb3CheckpointSettings(enable_checkpoints = False,
                      checkpoint_dir = WindowsPath('ckpt'), save_freq = 100000,
                      name_prefix_override = None, export_onnx = False,
                      save_final_policy = False, save_replay_buffer = False,
                      save_vecnormalize = False)

Parameters

  • enable_checkpoints (Annotated)

  • checkpoint_dir (Any)

  • save_freq (Annotated)

  • name_prefix_override (str)

  • export_onnx (bool)

  • save_final_policy (bool)

  • save_replay_buffer (bool)

  • save_vecnormalize (bool)

Methods

init

__init__(enable_checkpoints = False, checkpoint_dir = WindowsPath('ckpt'),
         save_freq = 100000, name_prefix_override = None, export_onnx = False,
         save_final_policy = False, save_replay_buffer = False,
         save_vecnormalize = False)

Parameters

  • enable_checkpoints (Annotated)

  • checkpoint_dir (Any)

  • save_freq (Annotated)

  • name_prefix_override (str)

  • export_onnx (bool)

  • save_final_policy (bool)

  • save_replay_buffer (bool)

  • save_vecnormalize (bool)

Attributes

save_replay_buffer

save_replay_buffer

Whether to save the replay buffer when saving a checkpoint. This allows for resuming training from the same state of the replay buffer.

save_vecnormalize

save_vecnormalize

Whether to save the vector normalization statistics when saving a checkpoint. This is useful for environments where observations need to be normalized, and it allows for consistent normalization when resuming training.