Skip to content
GPUOpen
Search
Ctrl
K
Cancel
AMD FSR™
AMD FSR SDK
AMD FSR Upscaling
AMD FSR Frame Generation
AMD FSR Ray Regeneration
AMD FSR Radiance Caching
AMD FidelityFX SDK
Super Resolution 3 (FSR 3)
Super Resolution 2 (FSR 2)
Super Resolution 1 (FSR 1)
AMD FidelityFX SDK v1
Blur
Breadcrumbs library
Brixelizer/GI
Ambient Occlusion (CACAO)
Contrast Adaptive Sharpening (CAS)
Denoiser
Depth of Field (DoF)
Lens
HDR Mapper (LPM)
Parallel Sort
Downsampler (SPD)
Screen Space Reflections (SSSR)
Variable Shading
TressFX
Developer testimonials
Cauldron Framework
FidelityFX Naming Guidelines
Hybrid Shadows
Hybrid Stochastic Reflections
Tools
What Tools Do We Have?
Radeon Developer Tool Suite
Radeon™ GPU Detective
Radeon™ Raytracing Analyzer
Radeon™ GPU Profiler
Radeon™ GPU Analyzer
Radeon™ Memory Visualizer
Radeon™ Developer Panel
GPU Reshape
Compressonator
Frame Latency Meter
OCAT
SDKs
What SDKs Do We Have?
AMD Radeon Anti-Lag 2 SDK
AMD Driver/Hardware SDKs
AMD GPU Services
AMD Device Library eXtra
Advanced Media Framework
Streaming SDK
GPU Performance API
Content Creation
Radeon™ ProRender Suite
Radeon™ ProRender SDK
GPUOpen MaterialX Library
Radeon™ Rays
Vulkan® Memory Allocator
Direct3D®12 Memory Allocator
HIP Ray Tracing
Orochi
Capsaicin Framework (GI-1.0)
Render Pipeline Shaders
Brotli-G SDK
Dense Geometry Format SDK
Platform Support
Unreal Engine
FSR Unreal Engine 5 plugin
Unreal Engine Performance Guide
AMD Schola (Unreal NPCs)
Unity
Unity CPU Profiling Guide
Vulkan®
Radeon™ Vulkan® Drivers Version Table
Developing Vulkan® Applications
DirectX®12
DirectX®12 Ultimate
Developing DirectX®12 Applications
Docs/Research
Meet all our blogs
Getting Started
Getting Started with our Software
Getting Started with Development
How to Become a Graphics Programmer
General Developer Tech Articles
Popular articles
Integrating Anti-Lag 2 SDK
Matrix Compendium
Mesh Shaders
Work Graphs
Crash Course in Deep Learning (Graphics)
Our Publications
Advanced Rendering Research Group
AMD Lab Notes (HPC)
AMD RDNA™ Performance Guide
AMD GPU Architecture
Machine-readable ISAs
AMD Ryzen™ Performance Guide
CPU Performance and Optimization
Software Manuals
Presentations
Samples
News/Events
Latest Developer News
Recent Software Releases
Hot new articles
AMD FSR 'Redstone' SDK + the neural rendering future
Introducing AMD FSR SDK v2.1
AMD Schola v2: Next-gen RL for Unreal Engine
Tool Suite updated for Radeon RX 9060 XT
Generative AI model for GI effects
Neural Networks for Geometric Representation
Generative AI on AMD Radeon GPUs
Events
All Events
GDC
Digital Dragons
Other events
Watch Our Videos
AMD FSR™
AMD FSR SDK
AMD FSR Upscaling
AMD FSR Frame Generation
AMD FSR Ray Regeneration
AMD FSR Radiance Caching
AMD FidelityFX SDK
Super Resolution 3 (FSR 3)
Super Resolution 2 (FSR 2)
Super Resolution 1 (FSR 1)
AMD FidelityFX SDK v1
Blur
Breadcrumbs library
Brixelizer/GI
Ambient Occlusion (CACAO)
Contrast Adaptive Sharpening (CAS)
Denoiser
Depth of Field (DoF)
Lens
HDR Mapper (LPM)
Parallel Sort
Downsampler (SPD)
Screen Space Reflections (SSSR)
Variable Shading
TressFX
Developer testimonials
Cauldron Framework
FidelityFX Naming Guidelines
Hybrid Shadows
Hybrid Stochastic Reflections
Tools
What Tools Do We Have?
Radeon Developer Tool Suite
Radeon™ GPU Detective
Radeon™ Raytracing Analyzer
Radeon™ GPU Profiler
Radeon™ GPU Analyzer
Radeon™ Memory Visualizer
Radeon™ Developer Panel
GPU Reshape
Compressonator
Frame Latency Meter
OCAT
SDKs
What SDKs Do We Have?
AMD Radeon Anti-Lag 2 SDK
AMD Driver/Hardware SDKs
AMD GPU Services
AMD Device Library eXtra
Advanced Media Framework
Streaming SDK
GPU Performance API
Content Creation
Radeon™ ProRender Suite
Radeon™ ProRender SDK
GPUOpen MaterialX Library
Radeon™ Rays
Vulkan® Memory Allocator
Direct3D®12 Memory Allocator
HIP Ray Tracing
Orochi
Capsaicin Framework (GI-1.0)
Render Pipeline Shaders
Brotli-G SDK
Dense Geometry Format SDK
Platform Support
Unreal Engine
FSR Unreal Engine 5 plugin
Unreal Engine Performance Guide
AMD Schola (Unreal NPCs)
Unity
Unity CPU Profiling Guide
Vulkan®
Radeon™ Vulkan® Drivers Version Table
Developing Vulkan® Applications
DirectX®12
DirectX®12 Ultimate
Developing DirectX®12 Applications
Docs/Research
Meet all our blogs
Getting Started
Getting Started with our Software
Getting Started with Development
How to Become a Graphics Programmer
General Developer Tech Articles
Popular articles
Integrating Anti-Lag 2 SDK
Matrix Compendium
Mesh Shaders
Work Graphs
Crash Course in Deep Learning (Graphics)
Our Publications
Advanced Rendering Research Group
AMD Lab Notes (HPC)
AMD RDNA™ Performance Guide
AMD GPU Architecture
Machine-readable ISAs
AMD Ryzen™ Performance Guide
CPU Performance and Optimization
Software Manuals
Presentations
Samples
News/Events
Latest Developer News
Recent Software Releases
Hot new articles
AMD FSR 'Redstone' SDK + the neural rendering future
Introducing AMD FSR SDK v2.1
AMD Schola v2: Next-gen RL for Unreal Engine
Tool Suite updated for Radeon RX 9060 XT
Generative AI model for GI effects
Neural Networks for Geometric Representation
Generative AI on AMD Radeon GPUs
Events
All Events
GDC
Digital Dragons
Other events
Watch Our Videos
Schola
Schola Documentation
Guides
Overview
Getting Started with Schola
Running Schola
Setting Up Inference
Running with a Standalone Environment from CLI
Static vs Dynamic Environments
Distributed Training with RayCluster
Extending launch.py for Sb3 and Ray
Tips and Tricks
Behaviour Cloning
Migrating from Schola V1.3 to V2
Examples
Overview
Training NPCs to Play Tag
X-ARM 5 Robotic Arm
Overview
Setup
Task 1 – Fixed Target
Task 2 – Random Location
Task 3 – Random Target & Location
API Documentation
Overview
Python API
Core
schola.core
error_manager
core.error_manager
EnvironmentException
MissingMethodError
NoAgentsException
NoEnvironmentsException
NoServerError
ScholaErrorContextManager
ScholaException
UnrealCrashedError
WrappedGRPCException
model
core.model
panel
core.panel
protocols
core.protocols
base
protocols.base
AutoResetType
BaseImitationProtocol
BaseProtocol
BaseProtocolMixin
BaseRLProtocol
protobuf
protocols.protobuf
deserialize
protobuf.deserialize
deserialize.dtype_from_proto
deserialize.from_proto
grpc
gRPC
gRPCProtocol
offlinegrpc
offlinegRPC
gRPCImitationProtocol
serialize
protobuf.serialize
serialize.dtype_to_proto
serialize.fill_generic
serialize.make_generic
serialize.space_to_proto
serialize.to_proto
socket
protocols.socket
SocketProtocolMixin
simulators
core.simulators
base
simulators.base
BaseSimulator
UnsupportedProtocolException
unreal
simulators.unreal
base
unreal.base
BaseUnrealSimulator
editor
unreal.editor
UnrealEditor
executable
unreal.executable
UnrealExecutable
utils
core.utils
id_manager
utils.id_manager
IdManager
id_manager.nested_get
plugins
utils.plugins
plugins.get_plugins
ubt
utils.ubt
ubt.build_executable
ubt.get_editor_executable_path
ubt.get_engine_path_from_sln
ubt.get_project_file
ubt.get_sln_file_from_project
ubt.get_ubt_path
ubt.get_ue_version
ubt.get_unreal_platform
ubt.quick_build_unreal_project
UBTCommand
Gym Environments
schola.gym
env
gym.env
GymEnv
GymVectorEnv
utils
gym.utils
PopActionWrapper
Ray (RLlib)
schola.rllib
env
rllib.env
BaseRayEnv
RayEnv
RayVecEnv
env.sorted_multi_agent_space
imitation
rllib.imitation
imitation.convert_to_rllib_format
imitation.read_expert_from_json
utils
rllib.utils
utils.export_onnx_from_policy
Stable-Baselines3
schola.sb3
env
sb3.env
VecEnv
utils
sb3.utils
utils.convert_ckpt_to_onnx_for_unreal
utils.get_scholasb3_model
RenderImagesWrapper
utils.save_model_as_onnx
VecMergeDictActionWrapper
VecMergeDictObservationWrapper
Generated (gRPC)
schola.generated
definitions_pb2
Definitions_pb2
definitions_pb2_grpc
Definitions_pb2_grpc
dtype_pb2
DType_pb2
dtype_pb2_grpc
DType_pb2_grpc
gymconnector_pb2
GymConnector_pb2
gymconnector_pb2_grpc
GymConnector_pb2_grpc
add_GymServiceServicer_to_server
GymService
GymServiceServicer
GymServiceStub
imitationconnector_pb2
ImitationConnector_pb2
imitationconnector_pb2_grpc
ImitationConnector_pb2_grpc
add_ImitationConnectorServiceServicer_to_server
ImitationConnectorService
ImitationConnectorServiceServicer
ImitationConnectorServiceStub
imitationstate_pb2
ImitationState_pb2
imitationstate_pb2_grpc
ImitationState_pb2_grpc
points_pb2
Points_pb2
points_pb2_grpc
Points_pb2_grpc
spaces_pb2
Spaces_pb2
spaces_pb2_grpc
Spaces_pb2_grpc
state_pb2
State_pb2
state_pb2_grpc
State_pb2_grpc
stateupdates_pb2
StateUpdates_pb2
stateupdates_pb2_grpc
StateUpdates_pb2_grpc
Scripts (CLI)
Overview
Common
scripts.common
ActivationFunctionEnum
CheckpointArgs
EnvironmentArgs
common.get_activation_function
gRPCProtocolArgs
RLLibLauncherExtension
Sb3LauncherExtension
UnrealEditorSimulatorArgs
UnrealExecutableCommandLinePlaceholder
UnrealExecutableSimulatorArgs
Launch
scripts.launch
launch.main
Panel
scripts.panel
panel.print_error
panel.print_info
panel.print_panel
panel.print_warning
RLlib Scripts
scripts.rllib
launch_imitation
rllib.launch_imitation
launch_imitation.bc
BCScriptArgs
BehaviourCloningSettings
launch_imitation.main
rllib_to_onnx
rllib.rllib_to_onnx
rllib_to_onnx.export
settings
rllib.settings
APPOSettings
IMPALASettings
LoggingSettings
NetworkArchitectureSettings
PPOSettings
ResourceSettings
ResumeSettings
RLLibAlgorithmSpecificSettings
RLlibScriptArgs
SACSettings
TrainingSettings
train
rllib.train
train.debug_main_from_cli
train.impala
train.main
train.ppo
train.sac
SB3 Scripts
scripts.sb3
sb3_to_onnx
sb3.sb3_to_onnx
sb3_to_onnx.export
settings
sb3.settings
BaseSb3AlgorithmArgs
PPOSettings
SACSettings
Sb3CheckpointArgs
Sb3LoggingArgs
Sb3NetworkArchitectureArgs
Sb3ResumeArgs
SB3ScriptArgs
train
sb3.train
train.main
train.ppo
train.sac
train.warn_if_small_image_observation
utils
sb3.utils
CustomProgressBarCallback
RewardCallback
SingleEnvRewardCallback
Utilities
scripts.utils
build_docs
utils.build_docs
main
build_docs.main
build_plugin
utils.build_plugin
find_uplugin
build_plugin.find_uplugin
main
build_plugin.main
compile_proto
utils.compile_proto
add_api_macro
compile_proto.add_api_macro
default_warnings
compile_proto.default_warnings
disable_warnings
compile_proto.disable_warnings
fix_imports
compile_proto.fix_imports
get_files
compile_proto.get_files
get_generated_cpp_file_types
compile_proto.get_generated_cpp_file_types
get_generated_python_file_types
compile_proto.get_generated_python_file_types
get_proto_files
compile_proto.get_proto_files
main
compile_proto.main
make_grpc_files
compile_proto.make_grpc_files
make_proto_files
compile_proto.make_proto_files
move_files
compile_proto.move_files
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
Namespaces
Overview
ProtobufDeserializer
Select theme
Dark
Light
Auto
State_pb2
Full path:
schola.generated.State_pb2
schola.generated.State_pb2
Generated protocol buffer code.