Skip to content

Struct FSB3LoggingSettings

Struct FSB3LoggingSettings

  • Defined in File SB3LoggingSettings.h

Inheritance Relationships

Base Type

struct FSB3LoggingSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder

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


Public Functions

SymbolDetails
GenerateTrainingArgsGenerate the training arguments for the script using the ArgBuilder.
~FSB3LoggingSettings

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.

#DirectionNameTypeDescription
1ArgBuilderFScriptArgBuilder &The builder to use to generate the arguments.

Attributes: const, virtual

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

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


~FSB3LoggingSettings

virtual ~FSB3LoggingSettings()

Attributes: virtual

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

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


Public Members

SymbolDetails
EnvLoggingVerbosityThe verbosity of the environment logging.
TrainerLoggingVerbosityThe verbosity of the trainer logging.
bSaveTBLogsWhether to save training logs with tensorboard.
LogFreqThe frequency to save tensorboard logs.
LogDirThe directory to save logs to.
CallbackVerbosityThe verbosity of the callback logging.

EnvLoggingVerbosity

int32 EnvLoggingVerbosity = 0

The verbosity of the environment logging.


TrainerLoggingVerbosity

int32 TrainerLoggingVerbosity = 0

The verbosity of the trainer logging.


bSaveTBLogs

bool bSaveTBLogs = true

Whether to save training logs with tensorboard.


LogFreq

int LogFreq = 10

The frequency to save tensorboard logs.


LogDir

FDirectoryPath LogDir

The directory to save logs to.


CallbackVerbosity

int CallbackVerbosity = 1

The verbosity of the callback logging.