FSB3TrainingSettings

struct FSB3TrainingSettings : public FTrainingSettings

A struct to hold all the settings for an SB3 training script.

Note: This is a partial implementation of the SB3 settings, and is not exhaustive

Dependencies

This type depends on:

Inherits from: public FTrainingSettings

Public Interface

Destructor:

~FSB3TrainingSettings

virtual ~FSB3TrainingSettings()

Attributes: virtual

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

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

Public Functions:

GenerateTrainingArgs

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

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

Public Members:

int Timesteps

int Timesteps = = 8000

The number of timesteps to train for.

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

FSB3LoggingSettings LoggingSettings

FSB3LoggingSettings LoggingSettings

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3TrainingSettings.h (line 43, column 21)

FSB3CheckpointSettings CheckpointSettings

FSB3CheckpointSettings CheckpointSettings

Checkpoint related arguments.

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

FSB3ResumeSettings ResumeSettings

FSB3ResumeSettings ResumeSettings

Resume related arguments.

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

FSB3NetworkArchSettings NetworkArchitectureSettings

FSB3NetworkArchSettings NetworkArchitectureSettings

Network architecture related arguments.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3TrainingSettings.h (line 55, column 25)

bool bDisplayProgressBar

bool bDisplayProgressBar = = true

Display a progress bar during training.

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

ESB3TrainingAlgorithm Algorithm

ESB3TrainingAlgorithm Algorithm = = ESB3TrainingAlgorithm::PPO

The algorithm to use during training (e.g.

SAC, PPO)

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3TrainingSettings.h (line 63, column 23)

FSB3PPOSettings PPOSettings

FSB3PPOSettings PPOSettings

PPO specific settings.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3TrainingSettings.h (line 67, column 17)

FSB3SACSettings SACSettings

FSB3SACSettings SACSettings

SAC specific settings.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/StableBaselines/SB3TrainingSettings.h (line 71, column 17)

Used By: FScriptSettings

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