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
FidelityFX Naming Guidelines
Cauldron Framework
AMD FSR 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
FidelityFX Naming Guidelines
Cauldron Framework
AMD FSR 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 (v2.1)
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
Index
Setup
Task 1 - Reach with Fixed Location
Task 2 - Reach with Random Location
Task 3 - Reach with Random Target, Random Location
Guides
Index
Getting Started with Schola
Running Schola
Setting Up Inference
Running with a Standalone Environment from CLI
CLI dataclass conventions
Tips and Tricks
Distributed Training with Ray and Kubernetes
Migrating from Schola V1.3 to V2.1
Testing with pytest
API Documentation
Index
Python API
Index
Core
Index
Error Manager
Index
EnvironmentException
MissingMethodError
NoAgentsException
NoEnvironmentsException
NoServerError
ScholaErrorContextManager
ScholaException
UnrealCrashedError
WrappedGrpcException
Model
Index
model.fix_slice_nodes_for_onnx
model.patch_lstm_layers_for_onnx_export
model.reshape_lstm_output_hook
ScholaModel
StatefulModelMixin
StateMetadata
Protocols
Index
Async Base Protocol
Index
AsyncBaseProtocol
AsyncBaseProtocolMixin
AsyncBaseRLProtocol
Base Protocol
Index
AutoResetType
BaseImitationProtocol
BaseProtocol
BaseProtocolMixin
BaseRLProtocol
Socket Protocol
Index
SocketProtocolMixin
Simulators
Index
Base Simulator
Index
BaseSimulator
UnsupportedProtocolException
External Simulator
Index
ExternalSimulator
Utils
Index
Dict Helpers
Index
DIterator
dict_helpers.flatten_dict
dict_helpers.flatten_dict_no_prefix
dict_helpers.flattened_key_iterator
dict_helpers.flattened_value_iterator
dict_helpers.kfilter_dict
dict_helpers.map_dict
dict_helpers.unflatten_dict
Id Manager
Index
IdManager
id_manager.nested_get
Plugins
Index
plugins.get_plugins
Ubt
Index
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
Extensions
Rllib
Index
Env
Index
BaseRayEnv
RayEnv
RayVecEnv
env.sorted_multi_agent_space
Env Runner
Index
ScholaEnvRunner
Export
Index
export.export_onnx_from_policy
RllibScholaModel
ScholaRLModule
Gym
Index
Env
Index
GymEnv
GymVectorEnv
Utils
Index
PopActionWrapper
Scripts
Index
Launch
Index
Main
Index
launch.main
Minari
Index
Collect
Index
Main
Index
collect.main
Settings
Index
MinariCollectionSettings
MinariLoggingSettings
MinariScriptSettings
Rllib
Index
Eval
Index
Eval
Index
Main
Index
eval.main
RllibEvalCommand
Settings
Index
RllibEvalScriptSettings
Settings
Index
APPOSettings
IMPALASettings
LoggingSettings
PPOSettings
ResourceSettings
RllibAlgorithmSpecificSettings
SACSettings
Train
Index
Settings
Index
NetworkArchitectureSettings
ResumeSettings
RllibScriptSettings
TrainingSettings
Train
Index
Main
Index
train.main
RllibTrainCommand
Sb3
Index
Eval
Index
Eval
Index
Main
Index
eval.main
MetaEvalSB3Command
Settings
Index
Sb3EvalScriptSettings
Settings
Index
BasePPOSettings
BaseSACSettings
Sb3BaseLoggingSettings
Train
Index
Settings
Index
BaseSb3AlgorithmSettings
PPOTrainSettings
SACTrainSettings
Sb3CheckpointSettings
Sb3LoggingSettings
Sb3NetworkArchitectureSettings
Sb3ResumeSettings
Sb3TrainingSettings
Sb3TrainScriptSettings
Train
Index
Main
Index
train.main
MetaTrainSB3Command
train.warn_if_small_image_observation
Utils
Index
CustomProgressBarCallback
RewardCallback
SingleEnvRewardCallback
Utils
Index
Build Plugin
Index
build_plugin.find_uplugin
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
Namespaces
Index
InstancedStructUtils
InstancedStructUtils::Private
ProtobufDeserializer
ProtobufSerializer
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
Select theme
Dark
Light
Auto
Gym
This module provides support for the Gymnasium API.
Env
Utils