Struct FRLlibResourceSettings

Struct FRLlibResourceSettings

• Defined in File RLlibResourceSettings.h

Inheritance Relationships

Base Type

• public FTrainingSettings (Struct FTrainingSettings)

struct FRLlibResourceSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder

A struct to hold resource settings for an RLlib training script.

---

Public Functions

Symbol	Details
GenerateTrainingArgs	Generate the training arguments for the script using the ArgBuilder.
~FRLlibResourceSettings	—

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.

#	Direction	Name	Type	Description
1	—	ArgBuilder	FScriptArgBuilder &	The builder to use to generate the arguments.

Attributes: const, virtual

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

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

---

~FRLlibResourceSettings

virtual ~FRLlibResourceSettings()

Attributes: virtual

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

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

---

Public Members

Symbol	Details
NumGPUs	The number of GPUs to use for training.
bUseCustomNumberOfCPUs	Whether to use a custom number of CPUs for training.
NumCPUs	The maximum number of CPUs/workers to use for training.
NumLearners	The number of learner processes to use for training.
NumGPUsPerLearner	The number of GPUs to use for the learner.
NumCPUsPerLearner	The number of CPUs to use for the learner.
NumCPUsForMainProcess	The number of CPUs to use for the main process.

---

NumGPUs

int NumGPUs = 0

The number of GPUs to use for training.

---

bUseCustomNumberOfCPUs

bool bUseCustomNumberOfCPUs = false

Whether to use a custom number of CPUs for training.

---

NumCPUs

int NumCPUs = 1

The maximum number of CPUs/workers to use for training.

If empty uses number of vCPUs on system

---

NumLearners

int NumLearners = 0

The number of learner processes to use for training.

Set to 0 to run in main process

---

NumGPUsPerLearner

int NumGPUsPerLearner = 0

The number of GPUs to use for the learner.

---

NumCPUsPerLearner

int NumCPUsPerLearner = 1

The number of CPUs to use for the learner.

---

NumCPUsForMainProcess

int NumCPUsForMainProcess = 1

The number of CPUs to use for the main process.