Unreal API 文档

Classes

• AAbstractScholaEnvironment - 一个代表环境的抽象类。
• AAbstractTrainer - 一个代表使用强化学习训练 NPC 的控制器抽象类。
• ABlueprintDynamicScholaEnvironment - DynamicScholaEnvironment 的可蓝图版本，它包含由环境或其他对象生成的训练器。
• ABlueprintScholaEnvironment - AbstractScholaEnvironment 的可蓝图版本。
• ABlueprintStaticScholaEnvironment - StaticScholaEnvironment 的可蓝图版本，它包含由其控制的 Pawn 生成的训练器。
• ABlueprintTrainer - AAbstractTrainer 的蓝图子类，实现了抽象方法。
• ADynamicScholaEnvironment
• AInferenceController - 实现 IInferenceAgent 接口的控制器，用于控制带有 Brain/Policy 的 Pawn。
• AInferencePawn - 实现 IInferenceAgent 接口的 Pawn。
• AStaticScholaEnvironment
• CallData - 管理通用 RPC 调用状态的类。
• ConstPointVisitor - 可以操作任何 const 点的对象基类。
• ExchangeCallData
• ExchangeRPCBackend
• ExchangeRPCWorker
• FScholaModule
• IBinaryActuatorWrapper
• IBinaryObserverWrapper
• IBlueprintBinaryActuatorWrapper
• IBlueprintBinaryObserverWrapper
• IBlueprintBoxActuatorWrapper
• IBlueprintBoxObserverWrapper
• IBlueprintDiscreteActuatorWrapper
• IBlueprintDiscreteObserverWrapper
• IBoxActuatorWrapper
• IBoxObserverWrapper
• IBrainInterface
• IComBackendInterface - 一个抽象的通信后端，可以发送字符串/字节消息，并且可以通过轮询响应或在发送消息时进行交换。
• IDiscreteActuatorWrapper
• IDiscreteObserverWrapper
• IExchangeBackendInterface - 任何可以异步用于交换 In 和 Out 类型消息的服务通用接口。
• IGymConnector - Unreal 和 gym 之间的连接器接口。
• IInferenceAgent
• IModelInstanceInterface - 通用接口，用于包装针对不同设备的 NNE ModelInstaces 的模型实例。
• IModelInterface - 通用接口，用于包装针对不同设备的 NNE Models 的模型。
• IPollingBackendInterface - 任何可以通过轮询异步接收 T 类型消息的服务通用接口。
• IProducerBackendInterface - 任何可以异步发送 T 类型消息的服务通用接口。
• IRuntimeInterface - 通用接口，用于包装针对不同设备的 NNE Runtimes 的运行时。
• IValidatable
• PointSerializer - 可以将点序列化到缓冲区的类。
• PointVisitor - 可以操作任何点的对象基类。
• PollingRPCBackend
• PollingRPCWorker
• ProducerRPCBackend
• ProducerRPCWorker
• ProtobufSerializer - 将 Points 序列化为相应 protobuf 消息的类。
• RPCBackend
• Singleton - 一个单例模板，允许您基于类型创建单例。
• UAbstractBrain - 用于子类表示不同同步策略、观测和操作方式的 AbstractBaseClass。
• UAbstractEnvironmentUtilityComponent - 为提供环境实用功能的 ActorComponent 的抽象基类。
• UAbstractGymConnector - Unreal Engine 和 gym 环境之间连接器的抽象类。
• UAbstractInteractor - 可以通过观察或执行来与环境交互的对象抽象类。
• UAbstractNormalizer
• UAbstractObserver - 代表可以收集环境状态观测的观察者抽象类。
• UAbstractPolicy - 代表 NPC 决策过程的抽象类。
• UActionClipper
• UActuatorComponent - 用于持有 Actuator 并提供一些相关实用功能的 ActorComponent。
• UActuator - Actuator 是可以附加到代理以执行操作的组件。
• UAgentUIDSubsystem - 管理为实体分配唯一编号 ID 的子系统。
• UAsyncBrain
• UBTTask_AgentStep - 一个 BTTask，它运行一个推理步骤以确定模型采取的操作。
• UBinaryActuatorWrapper
• UBinaryActuator - 执行二进制操作的执行器。
• UBinaryObserverWrapper - 包装二进制观测值的接口。
• UBinaryObserver - 收集环境状态的二进制观测值的观察者。
• UBlueprintBinaryActuatorWrapper
• UBlueprintBinaryActuator - 二进制执行器的蓝图版本。
• UBlueprintBinaryObserverWrapper - 包装二进制观测值的蓝图接口。
• UBlueprintBinaryObserver - UBinaryObserver 的可蓝图版本。
• UBlueprintBoxActuatorWrapper
• UBlueprintBoxActuator - 盒式执行器的蓝图版本。
• UBlueprintBoxObserverWrapper - 包装盒式观测值的蓝图接口。
• UBlueprintBoxObserver - UBoxObserver 的可蓝图版本。
• UBlueprintDiscreteActuatorWrapper
• UBlueprintDiscreteActuator - 离散执行器的蓝图版本。
• UBlueprintDiscreteObserverWrapper - 包装离散观测值的蓝图接口。
• UBlueprintDiscreteObserver - UDiscreteObserver 的可蓝图版本。
• UBlueprintEnvironmentUtilityComponent - AbstractEnvironmentUtilityComponent 的蓝图可实现版本。
• UBlueprintPolicy - 通过 Unreal Blueprint Class 提供实现钩子的策略。
• UBoxActuatorWrapper
• UBoxActuator - 执行连续操作的执行器，输入范围受盒式空间限制。
• UBoxObserverWrapper - 包装盒式观测值的接口。
• UBoxObserver - 收集环境状态的盒式（连续）观测值的观察者。
• UBrainInterface
• UCPUModelWrapper - NNE CPU 模型包装器。
• UCPURuntimeWrapper - NNE CPU Runtimes 包装器。
• UCameraObserver - 从环境中的摄像机收集 2D 观测值的观察者。
• UCommunicationManager - 管理运行在指定 URL 上的 gRPC 服务器的类。
• UDebugBinaryActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
• UDebugBinaryObserver - 二进制观察者的调试版本，它会生成随机观测值。
• UDebugBoxActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
• UDebugBoxObserver - 盒式观察者的调试版本，它会生成随机观测值。
• UDebugDiscreteActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
• UDebugDiscreteObserver - 离散观察者的调试版本，它会生成随机观测值。
• UDiscreteActuatorWrapper
• UDiscreteActuator - 执行离散操作的执行器。
• UDiscreteBrain
• UDiscreteObserverWrapper - 包装离散观测值的接口。
• UDiscreteObserver - 收集环境状态的离散观测值的观察者。
• UEventObserver - 可由事件触发的二进制观察者。
• UExternalGymConnector - 使用 futures 与 gym 通信的连接器的抽象类。
• UFrameStacker
• UGPUModelWrapper - NNE GPU 模型包装器。
• UGPURuntimeWrapper - NNE GPU Runtimes 包装器。
• UGymConnector - Unreal 和 gym 之间的连接器接口。
• UHardNormalizer
• UInferenceAgent - 由代表推理代理的类实现的接口。
• UInferenceComponent - 实现 IInferenceAgent 接口的组件，用于控制带有 Brain/Policy 的 Pawn。
• UInferencePolicy - 使用训练好的 NNE 模型进行决策的策略。
• UInteractionComponent - Schola 中用于与环境交互的 ActorComponent 的抽象基类。
• UInteractionManager
• UModelInstanceWrapper - 通用接口，用于包装针对不同设备的 NNE Models 的模型实例。
• UMovementInputActuator
• UObservationClipper
• UPositionObserver - 跟踪 Actor 位置的观察者。
• UPythonGymConnector - 通过 gRPC 进行通信，连接到用 Python 实现的外部 gym API。
• URayCastObserver - 投射射线并收集关于第一个命中对象的观测值的观察者。
• URotationActuator
• URotationObserver - 跟踪 Actor 旋转的观察者。
• UScholaManagerSubsystemSettings - 用于在项目设置的 Game 选项卡中提供 UERL 子系统设置的类。
• UScholaManagerSubsystem - 协调 UERL 工具包各个部分的**核心子系统**。
• USensor - 用于持有 Observer 并提供相关实用功能的 ActorComponent。
• UStatLoggerComponent
• USynchronousBrain
• UTeleportActuator
• UValidatable - 可以被验证的类。
• UVelocityObserver - 跟踪 Actor 速度的观察者。

Structs

• FActTickFunction - 代表代理 Tick 函数的 Act 部分的结构体。
• FAction - 代表代理所采取动作的结构体。
• FAgentId - 包含代理 ID 的结构体。
• FBinaryPoint
• FBinarySpace - 代表二进制空间的结构体（例如。
• FBoxPoint - 盒式（连续）空间中的一个点。
• FBoxSpaceDimension - 代表可能观测值或动作的盒式（连续）空间维度的结构体。
• FBoxSpace - 代表可能观测值或动作的盒式（连续）空间的结构体。
• FCommunicatorSettings - 用于保存与外部通信相关的设置的结构体（例如。
• FCustomTrainingSettings - 用于保存自定义训练脚本设置的结构体。
• FDictPoint - 点的字典。
• FDictSpace - 代表可能观测值或动作字典的结构体。
• FDiscretePoint
• FDiscreteSpace - 代表离散空间的结构体（例如。
• FDynamicAgentStruct
• FEnvReset - 代表环境重置更新的结构体。
• FEnvStep - 代表环境步进更新的结构体。
• FEnvUpdate - 代表环境更新（重置或步进）的结构体。
• FEnvironmentDefinition - 包含定义环境属性的结构体。
• FGenericTensorBinding - NNE TensorBinding 的包装器，允许我们以与设备无关的方式使用它。
• FInferencePolicyBuffer
• FInteractionDefinition - 包含策略输入输出定义的结构体。
• FLaunchableScript - 用于保存可启动脚本配置的结构体。
• FPoint - 可以传递给模型进行推理的数据点。
• FPolicyDecision - 代表策略所做决策的结构体。
• FRLlibAPPOSettings - 用于保存 RLLib 训练脚本的异步近邻策略优化（APPO）设置的结构体。
• FRLlibCheckpointSettings - 用于保存 RLlib 训练脚本的检查点设置的结构体。
• FRLlibIMPALASettings - 用于保存 RLLib 训练脚本的 IMPALA 设置的结构体。
• FRLlibLoggingSettings - 用于保存 RLlib 训练脚本的日志记录设置的结构体。
• FRLlibNetworkArchSettings - 用于保存 RLlib 训练脚本的网络架构设置的结构体。
• FRLlibPPOSettings - 用于保存 RLLib 训练脚本的近邻策略优化（PPO）设置的结构体。
• FRLlibResourceSettings - 用于保存 RLlib 训练脚本的资源设置的结构体。
• FRLlibResumeSettings - 用于保存 RLlib 训练脚本的恢复设置的结构体。
• FRLlibTrainingSettings - 用于保存 RLlib 训练脚本所有设置的结构体。
• FSB3CheckpointSettings - 用于保存 SB3 训练脚本的检查点设置的结构体。
• FSB3LoggingSettings - 用于保存 SB3 训练脚本的日志记录设置的结构体。
• FSB3NetworkArchSettings - 用于保存 SB3 训练脚本的网络架构设置的结构体。
• FSB3PPOSettings - 用于保存 SB3 训练脚本的 PPO 设置的结构体。
• FSB3ResumeSettings - 用于保存 SB3 训练脚本的恢复设置的结构体。
• FSB3SACSettings - 用于保存 SB3 训练脚本的 SAC 设置的结构体。
• FSB3TrainingSettings - 用于保存 SB3 训练脚本所有设置的结构体。
• FScriptArgBuilder - 用于构建 CLI 脚本参数和标志的类。
• FScriptSettings - 游戏启动时自动启动脚本的所有设置。
• FSharedEnvironmentDefinition - 包含定义环境属性的结构体。
• FSharedEnvironmentState - 代表由一组 AgentStates 给出的环境状态的结构体。
• FSharedTrainingDefinition - 包含定义训练会话属性的结构体。
• FSpace - 代表可能观测值或动作空间的类。
• FStartRequest - 代表指示连接器应启动的消息的结构体。
• FThinkTickFunction - 代表代理 Tick 函数的 Think 部分的结构体。
• FTrainerAgentPair
• FTrainerConfiguration - 包含定义训练器属性的结构体。
• FTrainerDefinition - 包含定义代理属性的结构体。
• FTrainerState - 代表由奖励、向量观测和状态给出的代理状态的结构体。
• FTrainingDefinition - 包含定义训练会话属性的结构体。
• FTrainingSettings - 任何训练设置的抽象类。
• FTrainingStateUpdate - 代表对整体训练状态更新的结构体。
• FTrainingState - 代表由一组 EnvironmentStates 给出的训练会话状态的结构体。
• FValidationResult - 包含验证结果及其失败原因（如果失败）的结构体。

Namespaces

• ProtobufDeserializer - 包含将 protobuf 消息反序列化为 Unreal Engine 类型的函数的命名空间。