Skip to content

Struct FRLlibTrainingSettings

Struct FRLlibTrainingSettings

  • Defined in File RLlibTrainingSettings.h

Inheritance Relationships

Base Type

struct FRLlibTrainingSettings : public FTrainingSettings

Source: Source/Schola/Training/Public/TrainingSettings/Ray/RLlibTrainingSettings.h

Dependencies: FRLlibAPPOSettings, FRLlibCheckpointSettings, FRLlibIMPALASettings, FRLlibLoggingSettings, FRLlibNetworkArchSettings, FRLlibPPOSettings, FRLlibResourceSettings, FRLlibResumeSettings, FScriptArgBuilder

Configuration struct for Ray RLlib training scripts.

Contains all settings necessary to launch and configure an RLlib training session, including algorithm selection, hyperparameters, logging, checkpointing, and resource allocation.


Public Functions

SymbolDetails
GenerateTrainingArgsGenerate command-line arguments for the RLlib training script.
~FRLlibTrainingSettingsVirtual destructor.

GenerateTrainingArgs

virtual void GenerateTrainingArgs(FScriptArgBuilder &ArgBuilder) const

Generate command-line arguments for the RLlib training script.

Parameters

ArgBuilder – [inout] The argument builder to populate with settings.

#DirectionNameTypeDescription
1ArgBuilderFScriptArgBuilder &The argument builder to populate with settings.

Attributes: const, virtual

Source: Source/Schola/Training/Public/TrainingSettings/Ray/RLlibTrainingSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/Ray/RLlibTrainingSettings.cpp


~FRLlibTrainingSettings

virtual ~FRLlibTrainingSettings()

Virtual destructor.

Attributes: virtual

Source: Source/Schola/Training/Public/TrainingSettings/Ray/RLlibTrainingSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/Ray/RLlibTrainingSettings.cpp


Public Members

SymbolDetails
TimestepsThe total number of environment timesteps to train for.
LearningRateThe learning rate for the optimizer.
MinibatchSizeThe size of minibatches for gradient updates.
TrainBatchSizePerLearnerThe training batch size per learner worker.
NumSGDIterThe number of SGD (stochastic gradient descent) iterations per training batch.
GammaThe discount factor (gamma) for future rewards.
LoggingSettingsThe logging settings for the training script.
CheckpointSettingsThe checkpoint settings for the training script.
ResumeSettingsThe resume settings for the training script.
NetworkArchitectureSettingsThe network architecture settings for the training script.
ResourceSettingsThe resource settings for the training script.
AlgorithmThe algorithm to use during training (e.g.
PPOSettingsPPO specific settings.
APPOSettingsAPPO specific settings.
IMPALASettingsIMPALA specific settings.

Timesteps

int Timesteps = 8000

The total number of environment timesteps to train for.


LearningRate

float LearningRate = 0.0003

The learning rate for the optimizer.


MinibatchSize

int MinibatchSize = 128

The size of minibatches for gradient updates.


TrainBatchSizePerLearner

int TrainBatchSizePerLearner = 256

The training batch size per learner worker.


NumSGDIter

int NumSGDIter = 5

The number of SGD (stochastic gradient descent) iterations per training batch.


Gamma

float Gamma = 0.99

The discount factor (gamma) for future rewards.


LoggingSettings

FRLlibLoggingSettings LoggingSettings

The logging settings for the training script.


CheckpointSettings

FRLlibCheckpointSettings CheckpointSettings

The checkpoint settings for the training script.


ResumeSettings

FRLlibResumeSettings ResumeSettings

The resume settings for the training script.


NetworkArchitectureSettings

FRLlibNetworkArchSettings NetworkArchitectureSettings

The network architecture settings for the training script.


ResourceSettings

FRLlibResourceSettings ResourceSettings

The resource settings for the training script.


Algorithm

ERLlibTrainingAlgorithm Algorithm = ERLlibTrainingAlgorithm::PPO

The algorithm to use during training (e.g.

SAC, PPO)


PPOSettings

FRLlibPPOSettings PPOSettings

PPO specific settings.


APPOSettings

FRLlibAPPOSettings APPOSettings

APPO specific settings.


IMPALASettings

FRLlibIMPALASettings IMPALASettings

IMPALA specific settings.