- Schola Documentation
-
Examples
-
API Documentation
- Overview
-
Python API
-
Generated (gRPC)
-
C++ API (Unreal)
-
Classes
- Overview
- Class AGymConnectorManager
- Class ConstPointVisitor
- Class ConstSpaceVisitor
- Template Class ExchangeRPCWorker
- Class FCPUModelWrapper
- Class FCPURuntimeWrapper
- Class FGPUModelWrapper
- Class FGPURuntimeWrapper
- Class FSource/Schola/Editor/Module
- Class FSource/Schola/Imitation/Module
- Class FSource/Schola/InferenceUtils/Module
- Class FSource/Schola/Interactors/Module
- Class FScholaModule
- Class FSource/Schola/NNE/Module
- Class FSource/Schola/Protobuf/Module
- Class FSource/Schola/Training/Module
- Class IAgent
- Class IBaseImitationScholaEnvironment
- Class IBaseScholaEnvironment
- Template Class IConsumerBackend
- Template Class IExchangeBackend
- Class IGymConnector
- Class IImitationScholaEnvironment
- Class IModelInstanceInterface
- Class IModelInterface
- Class IMultiAgentImitationScholaEnvironment
- Class IMultiAgentScholaEnvironment
- Class IPolicy
- Template Class IProducerBackend
- Class IProtobufBackend
- Class IRuntimeInterface
- Class IScholaActuator
- Class IScholaEnvironment
- Class IScholaSensor
- Class ISingleAgentImitationScholaEnvironment
- Class ISingleAgentScholaEnvironment
- Class IStepper
- Class PointAllocator
- Class PointVisitor
- Template Class ProducerRPCWorker
- Class ProtobufPointDeserializer
- Class ProtobufPointSerializer
- Class ProtobufSpaceDeserializer
- Class ProtobufSpaceSerializer
- Template Class SpaceTransmuter
- Class SpaceVisitor
- Template Class TCallData
- Template Class TConsumerRPCBackend
- Template Class TConsumerRPCWorker
- Template Class TExchangeCallData
- Template Class TExchangeRPCBackend
- Template Class TImitationScholaEnvironment
- Template Class TProducerRPCBackend
- Template Class TRPCBackend
- Template Class TScholaEnvironment
- Class UAbstractGymConnector
- Class UAbstractImitationConnector
- Class UActionDebugLibrary
- Class UAgent
- Class UBaseImitationScholaEnvironment
- Class UBaseScholaEnvironment
- Class UBlueprintPolicy
- Class UBoxPointBlueprintLibrary
- Class UBoxSpaceBlueprintLibrary
- Class UCameraSensor
- Class UCommunicationManager
- Class UDictPointBlueprintLibrary
- Class UDictSpaceBlueprintLibrary
- Class UDiscretePointBlueprintLibrary
- Class UDiscreteSpaceBlueprintLibrary
- Class UExternalGymConnector
- Class UGymConnector
- Class ULaunchableScriptFunctionLibrary
- Class UManualGymConnector
- Class UMovementInputActuator
- Class UMultiAgentImitationScholaEnvironment
- Class UMultiAgentScholaEnvironment
- Class UMultiBinaryPointBlueprintLibrary
- Class UMultiBinarySpaceBlueprintLibrary
- Class UMultiDiscretePointBlueprintLibrary
- Class UMultiDiscreteSpaceBlueprintLibrary
- Class UNNEPolicy
- Class UPipelinedStepper
- Class UPointBlueprintLibrary
- Class UPolicy
- Class URPCGymConnector
- Class URPCImitationConnector
- Class URayCastSensor
- Class URotationActuator
- Class UScholaActuator
- Class UScholaSensor
- Class USimpleStepper
- Class USingleAgentImitationScholaEnvironment
- Class USingleAgentScholaEnvironment
- Class USpaceBlueprintLibrary
- Class UStepper
- Class UTeleportActuator
-
Structs
- Overview
- Struct FAgentState
- Struct FBoxPoint
- Struct FBoxSpace
- Struct FBoxSpaceDimension
- Struct FCustomTrainingSettings
- Struct FDictPoint
- Struct FDictSpace
- Struct FDiscretePoint
- Struct FDiscreteSpace
- Struct FEnvReset
- Struct FEnvStep
- Struct FEnvironmentDefinition
- Struct FEnvironmentState
- Struct FExternalGymConnectorSettings
- Struct FImitationAgentState
- Struct FImitationEnvironmentState
- Struct FImitationState
- Struct FImitationTrainingState
- Struct FInitialAgentState
- Struct FInitialEnvironmentState
- Struct FInitialState
- Struct FInteractionDefinition
- Struct FLaunchableScript
- Struct FLaunchableScriptRunnable
- Struct FMultiBinaryPoint
- Struct FMultiBinarySpace
- Struct FMultiDiscretePoint
- Struct FMultiDiscreteSpace
- Struct FNNEBindingCreator
- Struct FNNEBoxBuffer
- Struct FNNEBufferAllocator
- Struct FNNEBufferVisitor
- Struct FNNEDictBuffer
- Struct FNNEDiscreteBuffer
- Struct FNNEMultiBinaryBuffer
- Struct FNNEMultiDiscreteBuffer
- Struct FNNEPointBuffer
- Struct FNNEPointCreator
- Struct FNNEPointToBufferConverter
- Struct FNNEStateBuffer
- Struct FPoint
- Struct FRLlibAPPOSettings
- Struct FRLlibCheckpointSettings
- Struct FRLlibIMPALASettings
- Struct FRLlibLoggingSettings
- Struct FRLlibNetworkArchSettings
- Struct FRLlibPPOSettings
- Struct FRLlibResourceSettings
- Struct FRLlibResumeSettings
- Struct FRLlibTrainingSettings
- Struct FRPCServerSettings
- Struct FSB3CheckpointSettings
- Struct FSB3LoggingSettings
- Struct FSB3NetworkArchSettings
- Struct FSB3PPOSettings
- Struct FSB3ResumeSettings
- Struct FSB3SACSettings
- Struct FSB3TrainingSettings
- Struct FScriptArgBuilder
- Struct FScriptSettings
- Struct FSpace
- Struct FStartRequest
- Struct FTrainingDefinition
- Struct FTrainingReset
- Struct FTrainingSettings
- Struct FTrainingState
- Struct FTrainingStateUpdate
- Struct FTrainingStep
- Template Struct TBaseStructure< FPoint >
- Template Struct TBaseStructure< FSpace >
- UPipelinedStepper::FPipelinedStepperFrame
-
train.ppo
Full path:
schola.scripts.sb3.train.ppo
schola.scripts.sb3.train.ppo
ppo
ppo(args=SB3ScriptArgs(timesteps=3000, pbar=False, disable_eval=False, logging_settings=Sb3LoggingArgs(enable_tensorboard=False, log_dir=WindowsPath('logs'), log_freq=10, callback_verbosity=0, schola_verbosity=0, sb3_verbosity=1), resume_settings=Sb3ResumeArgs(resume_from=None, load_vecnormalize=None, load_replay_buffer=None, reset_timestep=False), checkpoint_settings=Sb3CheckpointArgs(enable_checkpoints=False, checkpoint_dir=WindowsPath('ckpt'), save_freq=100000, name_prefix_override=None, export_onnx=False, save_final_policy=False, save_replay_buffer=False, save_vecnormalize=False), network_architecture_settings=Sb3NetworkArchitectureArgs(policy_parameters=[256, 256], critic_parameters=[256, 256], activation=<ActivationFunctionEnum.ReLU: 'relu'>), algorithm_settings=PPOSettings(learning_rate=0.0003, n_steps=2048, batch_size=64, n_epochs=10, gamma=0.99, gae_lambda=0.95, clip_range=0.2, normalize_advantage=True, ent_coef=0.0, vf_coef=0.5, max_grad_norm=0.5, use_sde=False, sde_sample_freq=-1), environment_settings=EnvironmentArgs(simulator=UnrealEditorSimulatorArgs(), protocol=gRPCProtocolArgs(port=None, url='localhost', environment_start_timeout=45))), simulator_type='editor', executable=UnrealExecutableCommandLinePlaceholder(executable_path=None, disable_script=True, headless=False, map=None, fps=None, display_logs=True), ppo=PPOSettings(learning_rate=0.0003, n_steps=2048, batch_size=64, n_epochs=10, gamma=0.99, gae_lambda=0.95, clip_range=0.2, normalize_advantage=True, ent_coef=0.0, vf_coef=0.5, max_grad_norm=0.5, use_sde=False, sde_sample_freq=-1), editor=UnrealEditorSimulatorArgs())Parameters
args (Annotated[SB3ScriptArgs, Parameter(name=('*',))])
simulator_type (Annotated[Literal['editor', 'executable'], Parameter(group=('Simulator (Choose One)',))])
executable (Annotated[UnrealExecutableSimulatorArgs, Parameter(name=('*',), group=('Executable Arguments',))])
ppo (Annotated[PPOSettings, Parameter(name=('*',), group=('PPO Parameters',))])
editor (Annotated[UnrealEditorSimulatorArgs, Parameter(show=False)])