FSB3CheckpointSettings

A struct to hold checkpoint settings for an SB3 training script.

struct FSB3CheckpointSettings : public FTrainingSettings

Methods

GenerateTrainingArgs

virtual void GenerateTrainingArgs(FScriptArgBuilder &ArgBuilder) const

Generate the training arguments for the script using the ArgBuilder.

Parameters

• ArgBuilder (FScriptArgBuilder)

---

FSB3CheckpointSettings

virtual ~FSB3CheckpointSettings()

Attributes

bSaveCheckpoints

bool bSaveCheckpoints = false

Whether to save checkpoints during training.

---

bSaveFinalModel

bool bSaveFinalModel = false

Whether to save the final model.

---

bSaveVecNormalize

bool bSaveVecNormalize = false

Whether to save the VecNormalize parameters.

---

bSaveReplayBuffer

bool bSaveReplayBuffer = false

Whether to save the replay buffer.

---

bExportFinalModelToOnnx

bool bExportFinalModelToOnnx = true

Whether we should just create a checkpoint, or if we should also export the final model out to ONNX.

---

CheckpointDir

FDirectoryPath CheckpointDir

The directory to save checkpoints to.

---

SaveFreq

int SaveFreq = 1000

The frequency to save checkpoints.

---

FString

FString NamePrefix = FString("ppo")

The prefix to use for the checkpoint files.

Parameters

• "ppo"

Source: Source/ScholaTraining/Public/TrainingSettings/StableBaselines/SB3CheckpointSettings.h