API 文档
Python API 文档
Core
schola.core | Schola 的核心功能，包括主环境、空间和异常。 |
扩展
schola.sb3 | 支持 Stable Baselines 3 环境。 |
schola.ray | 支持 ray 和 rllib 环境。 |
schola.gym | 该模块支持 Gymnasium API。 |
脚本
schola.scripts | 使用 Schola 运行强化学习的示例脚本。 |
生成的 gRPC 代码
schola.generated | 由 gRPC 和 Protobuf 生成的代码。 |
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 - 抽象基类，用于表示同步策略、观察和动作的不同方法的子类。
- UAbstractEnvironmentUtilityComponent - 为提供环境实用功能的 ActorComponent 的抽象基类。
- UAbstractGymConnector - Unreal Engine 和 gym 环境之间连接器的抽象类。
- UAbstractInteractor - 可以通过观察或行动与环境交互的对象的抽象类。
- UAbstractNormalizer
- UAbstractObserver - 表示可以收集环境状态观察的观察者的抽象类。
- UAbstractPolicy - 表示 NPC 决策协议的抽象类。
- UActionClipper
- UActuatorComponent - 用于保存 Actuator 并提供一些相关实用函数的 ActorComponent。
- UActuator - 执行器是可附加到代理以执行动作的组件。
- 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 Models 的包装器。
- UCPURuntimeWrapper - NNE CPU Runtimes 的包装器。
- UCameraObserver - 从环境中的摄像头收集 2D 观察的观察者。
- UCommunicationManager - 管理指定 URL 上运行的 gRPC 服务器的类。
- UDebugBinaryActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
- UDebugBinaryObserver - 生成随机观察的 BinaryObserver 的调试版本。
- UDebugBoxActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
- UDebugBoxObserver - 生成随机观察的 BoxObserver 的调试版本。
- UDebugDiscreteActuator - 可用于从 Python 测试执行器发现和空间的调试执行器。
- UDebugDiscreteObserver - 生成随机观察的 DiscreteObserver 的调试版本。
- UDiscreteActuatorWrapper
- UDiscreteActuator - 执行离散动作的执行器。
- UDiscreteBrain
- UDiscreteObserverWrapper - 用于包装离散观察的接口。
- UDiscreteObserver - 收集环境状态离散观察的观察者。
- UEventObserver - 可由事件触发的二进制观察器。
- UExternalGymConnector - 使用 future 与 gym 通信的连接器的抽象类。
- UFrameStacker
- UGPUModelWrapper - NNE GPU Models 的包装器。
- 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 - 一个类，用于在项目设置的游戏选项卡中提供 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 类型的函数的命名空间。