FSB3LoggingSettings

struct FSB3LoggingSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder, FTrainingSettings

Inherits from: public FTrainingSettings

Public Interface

Destructor:

virtual ~FSB3LoggingSettings()

Attributes: virtual

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

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/StableBaselines/SB3LoggingSettings.cpp (lines 20-22)

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/SB3LoggingSettings.h (line 44, column 6)

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

Public Members:

int32 EnvLoggingVerbosity = = 0

The verbosity of the environment logging.

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

int32 TrainerLoggingVerbosity = = 0

The verbosity of the trainer logging.

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

bool bSaveTBLogs = = true

Whether to save training logs with tensorboard.

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

int LogFreq = = 10

The frequency to save tensorboard logs.

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

FDirectoryPath LogDir

The directory to save logs to.

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

int CallbackVerbosity = = 1

The verbosity of the callback logging.

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

Used By: FSB3TrainingSettings

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