Struct FSB3CheckpointSettings

Struct FSB3CheckpointSettings

• Defined in File SB3CheckpointSettings.h

Inheritance Relationships

Base Type

• public FTrainingSettings (Struct FTrainingSettings)

struct FSB3CheckpointSettings : public FTrainingSettings

Source: Source/Schola/Training/Public/TrainingSettings/StableBaselines/SB3CheckpointSettings.h

Dependencies: FScriptArgBuilder

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

---

Public Functions

Symbol	Details
GenerateTrainingArgs	Generate the training arguments for the script using the ArgBuilder.
~FSB3CheckpointSettings	—

GenerateTrainingArgs

virtual void GenerateTrainingArgs(FScriptArgBuilder &ArgBuilder) const

Generate the training arguments for the script using the ArgBuilder.

Populates the ArgBuilder with training-specific command-line arguments.

Parameters

ArgBuilder – [inout] The builder to use to generate the arguments.

#	Direction	Name	Type	Description
1	—	ArgBuilder	FScriptArgBuilder &	The builder to use to generate the arguments.

Attributes: const, virtual

Source: Source/Schola/Training/Public/TrainingSettings/StableBaselines/SB3CheckpointSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/StableBaselines/SB3CheckpointSettings.cpp

---

~FSB3CheckpointSettings

virtual ~FSB3CheckpointSettings()

Attributes: virtual

Source: Source/Schola/Training/Public/TrainingSettings/StableBaselines/SB3CheckpointSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/StableBaselines/SB3CheckpointSettings.cpp

---

Public Members

Symbol	Details
bSaveCheckpoints	Whether to save checkpoints during training.
bSaveFinalModel	Whether to save the final model.
bSaveVecNormalize	Whether to save the VecNormalize parameters.
bSaveReplayBuffer	Whether to save the replay buffer.
bExportFinalModelToOnnx	Whether we should just create a checkpoint, or if we should also export the final model out to ONNX.
CheckpointDir	The directory to save checkpoints to.
SaveFreq	The frequency to save checkpoints.
NamePrefix	The prefix to use for the checkpoint files.

---

bSaveCheckpoints

bool bSaveCheckpoints = false

Whether to save checkpoints during training.

---

bSaveFinalModel

bool bSaveFinalModel = true

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.

---

NamePrefix

FString NamePrefix = FString("ppo")

The prefix to use for the checkpoint files.