schola.scripts.common.ScriptArgs
类定义
class schola.scripts.common.ScriptArgs(enable_checkpoints=False, checkpoint_dir='./ckpt', save_freq=100000, name_prefix_override=None, export_onnx=False, save_final_policy=False, launch_unreal=False, port=None, executable_path=None, headless=False, map=None, fps=None, disable_script=False)基类: object
包含脚本的参数
参数
启用检查点
类型: bool
检查点目录
类型: str
保存频率
Type: int
覆盖名称前缀
类型: str | None
导出为 ONNX
类型: bool
保存最终策略
类型: bool
启动 Unreal
类型: bool
port
类型: int | None
executable_path
类型: str | None
无头模式
类型: bool
map
类型: str | None
帧率
类型: int | None
disable_script
类型: bool
属性
检查点目录
类型: str
默认值: './ckpt'
启用保存检查点。
disable_script
类型: bool
Default: False
指示是否禁用 Unreal Engine Schola 插件中的自动启动脚本设置的标志。用于测试。
启用检查点
类型: bool
Default: False
启用保存检查点
executable_path
类型: str | None
默认值: None
独立环境启动时的独立可执行文件路径。
导出为 ONNX
类型: bool
Default: False
是仅保存检查点还是将模型导出为 ONNX 格式。
帧率
类型: int | None
默认值: None
运行独立模式时使用的固定帧率,如果为 None,则不使用固定时间步长。
无头模式
类型: bool
Default: False
标志,指示独立 Unreal Engine 进程是否应在无头模式下运行。
启动 Unreal
类型: bool
Default: False
标志,指示脚本是否应启动独立的 Unreal Engine 进程。
map
类型: str | None
默认值: None
启动独立的 Unreal Engine 进程时要加载的地图。
覆盖名称前缀
类型: str
默认值: None
覆盖检查点文件的名称前缀 (例如 SAC, PPO 等)
port
类型: int | None
默认值: None
用于连接到 Unreal Engine 进程的端口,如果为 None,则在独立运行时会自动选择一个开放端口。如果连接到现有 Unreal Engine 进程,则必须指定端口。
保存最终策略
类型: bool
Default: False
训练完成后是否保存最终策略。
保存频率
Type: int
默认值: 100000
保存检查点的频率。
方法
__init__
__init__(enable_checkpoints=False, checkpoint_dir='./ckpt', save_freq=100000, name_prefix_override=None, export_onnx=False, save_final_policy=False, launch_unreal=False, port=None, executable_path=None, headless=False, map=None, fps=None, disable_script=False)返回类型: None
make_unreal_connection
make_unreal_connection()基于脚本参数创建 Unreal Engine 连接。
返回: 用于脚本的 Unreal Engine 连接。
返回类型: UnrealConnection