FRLlibResourceSettings

struct FRLlibResourceSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder, FTrainingSettings

Inherits from: public FTrainingSettings

Public Interface

Destructor:

virtual ~FRLlibResourceSettings()

Attributes: virtual

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 49, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.cpp (lines 21-23)

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/Ray/RLlibResourceSettings.h (line 47, column 6)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.cpp (lines 7-19)

Public Members:

int NumGPUs = = 0

The number of GPUs to use for training.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 21, column 5)

bool bUseCustomNumberOfCPUs = = false

Whether to use a custom number of CPUs for training.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 25, column 6)

int NumCPUs = = 1

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

If empty uses number of vCPUs on system

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 29, column 5)

int NumLearners = = 0

The number of learner processes to use for training.

Set to 0 to run in main process

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 33, column 5)

int NumGPUsPerLearner = = 0

The number of GPUs to use for the learner.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 37, column 5)

int NumCPUsPerLearner = = 1

The number of CPUs to use for the learner.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 41, column 5)

int NumCPUsForMainProcess = = 1

The number of CPUs to use for the main process.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibResourceSettings.h (line 45, column 5)

Used By: FRLlibTrainingSettings

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