- Schola Documentation
-
Examples
- Index
- Training NPCs to Play a MultiAgent Game of Tag
- Training StateTree RL Agents via Hierarchical Reinforcement Learning
-
Training an X-Arm 5 Robotic Arm with AMD Schola and Unreal Engine
-
API Documentation
- Index
-
Python API
- Index
-
Core
-
Extensions
-
Rllib
-
-
Scripts
- Index
-
Minari
-
Rllib
-
Sb3
-
Utils
- Index
-
Compile Proto
- Index
- compile_proto.add_api_macro
- compile_proto.add_third_party_include_guards
- compile_proto.default_warnings
- compile_proto.disable_warnings
- compile_proto.ensure_ue_verify_macro_sandbox
- compile_proto.fix_imports
- compile_proto.get_expected_generated_files
- compile_proto.get_files
- compile_proto.get_generated_cpp_file_types
- compile_proto.get_generated_python_file_types
- compile_proto.get_proto_files
- compile_proto.make_grpc_files
- compile_proto.make_proto_files
- compile_proto.move_files
- compile_proto.remove_stale_generated_files
-
C++ API (Unreal)
- Index
-
Classes
- Index
- AGymConnectorManager
- AImitationConnectorManager
- AImitationPlayerController
- AImitationPlayerControllerBase
- AMultiAgentImitationPlayerController
- ConstPointVisitor
- ConstSpaceVisitor
- ExchangeRPCWorker
- FCPUModelWrapper
- FCPURuntimeWrapper
- FEnhancedInputUtils
- FGPUModelWrapper
- FGPURuntimeWrapper
- FScholaEditorModule
- FScholaImitationModule
- FScholaInferenceUtilsModule
- FScholaInteractorsModule
- FScholaModule
- FScholaNNEModule
- FScholaProtobufModule
- FScholaTrainingModule
- IAgent
- IBaseImitationScholaEnvironment
- IBaseScholaEnvironment
- IConsumerBackend
- ICppOnlyMultiAgentEnvironment
- IExchangeBackend
- IGymConnector
- IImitationScholaEnvironment
- IModelInstanceInterface
- IModelInterface
- IMultiAgentImitationScholaEnvironment
- IMultiAgentScholaEnvironment
- IPolicy
- IProducerBackend
- IProtobufBackend
- IRuntimeInterface
- IScholaActuator
- IScholaEnvironment
- IScholaSensor
- ISingleAgentImitationScholaEnvironment
- ISingleAgentScholaEnvironment
- IStepper
- PointAllocator
- PointVisitor
- ProducerRPCWorker
- ProtobufPointDeserializer
- ProtobufPointSerializer
- ProtobufSpaceDeserializer
- ProtobufSpaceSerializer
- SpaceTransmuter
- SpaceVisitor
- TCallData
- TConsumerRPCBackend
- TConsumerRPCWorker
- TExchangeCallData
- TExchangeRPCBackend
- TImitationScholaEnvironment
- TProducerRPCBackend
- TRPCBackend
- TScholaEnvironment
- UAbstractGymConnector
- UAbstractImitationConnector
- UAgent
- UBaseImitationScholaEnvironment
- UBaseScholaEnvironment
- UBlueprintPolicy
- UBoxPointBlueprintLibrary
- UBoxSpaceBlueprintLibrary
- UBoxStacker
- UCameraSensor
- UCommunicationManager
- UCppOnlyMultiAgentEnvironment
- UDictPointBlueprintLibrary
- UDictSpaceBlueprintLibrary
- UDictStacker
- UDiscretePointBlueprintLibrary
- UDiscreteSpaceBlueprintLibrary
- UExternalGymConnector
- UGymConnector
- ULaunchableScriptFunctionLibrary
- UManualGymConnector
- UMovementInputActuator
- UMultiAgentImitationScholaEnvironment
- UMultiAgentScholaEnvironment
- UMultiBinaryPointBlueprintLibrary
- UMultiBinarySpaceBlueprintLibrary
- UMultiDiscretePointBlueprintLibrary
- UMultiDiscreteSpaceBlueprintLibrary
- UNNEPolicy
- UPipelinedStepper
- UPointBlueprintLibrary
- UPolicy
- URPCGymConnector
- URPCImitationConnector
- URayCastSensor
- URotationActuator
- UScholaActuator
- UScholaSensor
- USimpleStepper
- USingleAgentImitationScholaEnvironment
- USingleAgentScholaEnvironment
- USpaceBlueprintLibrary
- UStackerBase
- UStepper
- UTeleportActuator
-
Structs
- Index
- FAgentState
- FBoxPoint
- FBoxSpace
- FBoxSpaceDimension
- FCustomTrainingSettings
- FDictPoint
- FDictSpace
- FDiscretePoint
- FDiscreteSpace
- FEnvReset
- FEnvStep
- FEnvironmentDefinition
- FEnvironmentState
- FExternalGymConnectorSettings
- FImitationAgentState
- FImitationEnvironmentState
- FImitationLoggingSettings
- FImitationScriptSettings
- FImitationSettings
- FImitationState
- FImitationTrainingState
- FInitialAgentState
- FInitialEnvironmentState
- FInitialState
- FInteractionDefinition
- FLaunchableScript
- FLaunchableScriptRunnable
- FMinariCollectionSettings
- FMultiBinaryPoint
- FMultiBinarySpace
- FMultiDiscretePoint
- FMultiDiscreteSpace
- FNNEBindingCreator
- FNNEBoxBuffer
- FNNEBufferAllocator
- FNNEBufferVisitor
- FNNEDictBuffer
- FNNEDiscreteBuffer
- FNNEMultiBinaryBuffer
- FNNEMultiDiscreteBuffer
- FNNEPointBuffer
- FNNEPointCreator
- FNNEPointToBufferConverter
- FNNEStateBuffer
- FPoint
- FRLlibAPPOSettings
- FRLlibCheckpointSettings
- FRLlibIMPALASettings
- FRLlibLoggingSettings
- FRLlibNetworkArchSettings
- FRLlibPPOSettings
- FRLlibResourceSettings
- FRLlibResumeSettings
- FRLlibSACSettings
- FRLlibTrainingSettings
- FRPCServerSettings
- FSB3CheckpointSettings
- FSB3LoggingSettings
- FSB3NetworkArchSettings
- FSB3PPOSettings
- FSB3ResumeSettings
- FSB3SACSettings
- FSB3TrainingSettings
- FScriptArgBuilder
- FScriptSettingsBase
- FSpace
- FStartRequest
- FTrainingDefinition
- FTrainingReset
- FTrainingScriptSettings
- FTrainingSettings
- FTrainingState
- FTrainingStateUpdate
- FTrainingStep
- TBaseStructure
- TBaseStructure
- FPipelinedStepperFrame
-
Enums
- Index
- EConnectorStatus
- EImitationConnectorStatus
- EAgentStatus
- EAutoResetType
- EChannels
- EComSystemState
- EEnvironmentStatus
- EAgentTrainingStatus
- ERuntimeType
- EPointType
- EFrameOfReference
- ERLlibActivationFunctionEnum
- ERLlibTrainingAlgorithm
- ESB3ActivationFunctionEnum
- ESB3TrainingAlgorithm
- EScriptType
- EPythonEnvironmentType
- ESpaceValidationResult
- ESpaceType
- ETeleportDimensionFlags
- EPythonScript
- ETrainingUpdateType
- EConnectorStatusUpdate
FSB3TrainingSettings
Configuration struct for Stable Baselines 3 (SB3) training scripts.
Contains all settings necessary to launch and configure an SB3 training session. This is a partial implementation of the available SB3 settings and is not exhaustive.
struct FSB3TrainingSettings : public FTrainingSettingsMethods
GenerateTrainingArgs
virtual void GenerateTrainingArgs(FScriptArgBuilder &ArgBuilder) constGenerate command-line arguments for the SB3 training script.
Parameters
ArgBuilder(FScriptArgBuilder)
FSB3TrainingSettings
virtual ~FSB3TrainingSettings()Virtual destructor.
Attributes
Timesteps
int Timesteps = 8000The total number of environment timesteps to train for.
LoggingSettings
FSB3LoggingSettings LoggingSettingsSettings for logging training metrics and outputs.
CheckpointSettings
FSB3CheckpointSettings CheckpointSettingsSettings for model checkpointing during training.
ResumeSettings
FSB3ResumeSettings ResumeSettingsSettings for resuming training from a checkpoint.
NetworkArchitectureSettings
FSB3NetworkArchSettings NetworkArchitectureSettingsSettings for neural network architecture (e.g.
bDisplayProgressBar
bool bDisplayProgressBar = trueWhether to display a progress bar during training.
bDisableEval
bool bDisableEval = falseWhen true, skips post-training evaluation (passes —disable-eval to the script).
Algorithm
ESB3TrainingAlgorithm Algorithm = ESB3TrainingAlgorithm::PPOThe reinforcement learning algorithm to use (e.g., SAC, PPO).
PPOSettings
FSB3PPOSettings PPOSettingsPPO specific settings.
SACSettings
FSB3SACSettings SACSettingsSAC specific settings.
Source: Source/ScholaTraining/Public/TrainingSettings/StableBaselines/SB3TrainingSettings.h