CheckpointArgs

Full path: schola.scripts.common.CheckpointArgs

schola.scripts.common.CheckpointArgs

CheckpointArgs

CheckpointArgs(
    enable_checkpoints=False,
    checkpoint_dir=WindowsPath("ckpt"),
    save_freq=100000,
    name_prefix_override=None,
    export_onnx=False,
    save_final_policy=False,
)

Bases: object

Settings for checkpoints in Schola.

Methods

Item	Description
init	—

Attributes

Item	Description
checkpoint_dir	Directory to save checkpoints to.
enable_checkpoints	Enable saving checkpoints
export_onnx	Whether to export the model to ONNX format instead of just saving a checkpoint.
name_prefix_override	Override the name prefix for the checkpoint files (e.g. SAC, PPO, etc.).
save_final_policy	Whether to save the final policy after training is complete.
save_freq	Frequency with which to save checkpoints.

Parameters

enable_checkpoints (bool)

checkpoint_dir (Annotated[Path, Parameter(validator=(Path(exists=False, file_okay=False, dir_okay=True, ext=()),))])

save_freq (Annotated[int, Parameter(validator=(Number(lt=None, lte=None, gt=None, gte=0, modulo=None),))])

name_prefix_override (str | None)

export_onnx (bool)

save_final_policy (bool)

init

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

Parameters

enable_checkpoints (bool)

checkpoint_dir (Annotated[Path, Parameter(validator=(Path(exists=False, file_okay=False, dir_okay=True, ext=()),))])

save_freq (Annotated[int, Parameter(validator=(Number(lt=None, lte=None, gt=None, gte=0, modulo=None),))])

name_prefix_override (str | None)

export_onnx (bool)

save_final_policy (bool)

Returns

None

---

checkpoint_dir

= WindowsPath('ckpt') checkpoint_dir: Annotated[Path, Parameter(validator=Path(exists=False, file_okay=False, dir_okay=True, ext=()))]

Directory to save checkpoints to.

---

enable_checkpoints

= False enable_checkpoints: bool

Enable saving checkpoints

---

export_onnx

= False export_onnx: bool

Whether to export the model to ONNX format instead of just saving a checkpoint.

---

name_prefix_override

= None name_prefix_override: str | None

Override the name prefix for the checkpoint files (e.g. SAC, PPO, etc.)

---

save_final_policy

= False save_final_policy: bool

Whether to save the final policy after training is complete.

---

save_freq

= 100000 save_freq: Annotated[int, Parameter(validator=Number(lt=None, lte=None, gt=None, gte=0, modulo=None))]

Frequency with which to save checkpoints.

---