FRLlibCheckpointSettings

struct FRLlibCheckpointSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder, FTrainingSettings

Inherits from: public FTrainingSettings

Public Interface

Destructor:

virtual ~FRLlibCheckpointSettings()

Attributes: virtual

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

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/Ray/RLlibCheckpointSettings.cpp (lines 24-27)

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

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/Ray/RLlibCheckpointSettings.cpp (lines 6-22)

Public Members:

bool bSaveFinalModel = = true

Whether to save the final output of training.

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

bool bExportToONNX = = false

Whether to export the final model to ONNX automatically.

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

bool bEnableCheckpoints = = false

Whether to save checkpoints during training.

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

int SaveFreq = = 1000

How frequently should we make checkpoints.

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

FDirectoryPath CheckpointDir

The directory to save checkpoints to.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/Ray/RLlibCheckpointSettings.h (line 36, column 16)

Used By: FRLlibTrainingSettings

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