Struct FRLlibCheckpointSettings

Struct FRLlibCheckpointSettings

• Defined in File RLlibCheckpointSettings.h

Inheritance Relationships

Base Type

• public FTrainingSettings (Struct FTrainingSettings)

struct FRLlibCheckpointSettings : public FTrainingSettings

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

Dependencies: FScriptArgBuilder

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

---

Public Functions

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

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/RLlibCheckpointSettings.h

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

---

~FRLlibCheckpointSettings

virtual ~FRLlibCheckpointSettings()

Attributes: virtual

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

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

---

Public Members

Symbol	Details
bSaveFinalModel	Whether to save the final output of training.
bExportToONNX	Whether to export the final model to ONNX automatically.
bEnableCheckpoints	Whether to save checkpoints during training.
SaveFreq	How frequently should we make checkpoints.
CheckpointDir	The directory to save checkpoints to.

---

bSaveFinalModel

bool bSaveFinalModel = true

Whether to save the final output of training.

---

bExportToONNX

bool bExportToONNX = false

Whether to export the final model to ONNX automatically.

---

bEnableCheckpoints

bool bEnableCheckpoints = false

Whether to save checkpoints during training.

---

SaveFreq

int SaveFreq = 1000

How frequently should we make checkpoints.

---

CheckpointDir

FDirectoryPath CheckpointDir

The directory to save checkpoints to.