FSB3CheckpointSettings

struct FSB3CheckpointSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder, FTrainingSettings

Inherits from: public FTrainingSettings

Public Interface

Destructor:

virtual ~FSB3CheckpointSettings()

Attributes: virtual

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 52, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.cpp (lines 30-33)

Public Functions:

virtual void GenerateTrainingArgs(int Port, FScriptArgBuilder &ArgBuilder) const const

Generate the training arguments for the script using the ArgBuilder.

Note: port is supplied as it is a common argument to pass to scripts, and is set at a high level but might be needed by specific subsettings

Parameters:

Port (int) – [in] The port to use for the script
ArgBuilder (FScriptArgBuilder &) – [in] The builder to use to generate the arguments

Attributes: const, virtual

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 50, column 6)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.cpp (lines 6-28)

Public Members:

bool bSaveCheckpoints = = false

Whether to save checkpoints during training.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 20, column 6)

bool bSaveFinalModel = = true

Whether to save the final model.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 24, column 6)

bool bSaveVecNormalize = = false

Whether to save the VecNormalize parameters.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 28, column 6)

bool bSaveReplayBuffer = = false

Whether to save the replay buffer.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 32, column 6)

bool bExportFinalModelToOnnx = = true

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

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 36, column 6)

FDirectoryPath CheckpointDir

The directory to save checkpoints to.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 40, column 16)

int SaveFreq = = 1000

The frequency to save checkpoints.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 44, column 5)

FString NamePrefix = = FString("ppo")

The prefix to use for the checkpoint files.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 48, column 9)

Used By: FSB3TrainingSettings

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3CheckpointSettings.h (line 13, column 1)