通用约定#

本页给出 API 文档统一约定，便于在不同章节快速对齐参数含义与使用方式。

参数说明模板#

本文档默认使用以下参数表结构：

参数名

类型

默认值

说明

xxx

str/int/flag/path/key=value

...

参数用途、取值约束与注意事项

说明：

  • 参数名：命令参数或配置字段名（保留原始标识符）。

  • 类型：按文档中已有表达方式书写，如 路径、flag、key=value 对。

  • 默认值：仅记录现有文档中已明确给出的默认值。

  • 说明：优先说明影响范围和与其他参数的关联关系。

命名与路径约定#

配置路径#

  • 训练/评估命令中的 CONFIG 指向配置文件路径（如 configs/.../*.py）。

  • WORK_DIR 指向运行产物目录（日志、checkpoint、配置快照等）。

  • CKPT_PATH 指向用于评估或推理的 checkpoint 文件。

脚本参数#

  • 训练入口：bash scripts/train.sh [CONFIG] [WORK_DIR] [额外参数...]

  • 评估入口：bash scripts/eval.sh [CONFIG] [CKPT_PATH] [额外参数...]

  • 额外参数一般透传给 train.py / eval.py（例如 --cfg-options）。

环境变量#

分布式训练与评估均依赖 MLP_* 环境变量：

  • MLP_WORKER_GPU

  • MLP_WORKER_NUM

  • MLP_ROLE_INDEX

  • MLP_WORKER_0_HOST

  • MLP_WORKER_0_PORT

实验记录常用环境变量：

  • WANDB_PROJECT

  • WANDB_ENTITY

  • WANDB_MODE

输入输出字段约定（文档层）#

以下为文档中高频字段族，便于跨页面检索：

  • 观测相关：states、observation.state、observation.eepose、images、img_masks

  • 语言相关：lang_tokens、lang_masks、prompt、task_description

  • 动作相关：actions、action_masks、action_dim、ori_action_dim

  • 配置顶层键：model、train_dataloader、runner、inference、eval

注：本页只整理现有中文文档明确出现的字段，不扩展未公开实现细节。

最小示例#

# 训练
bash scripts/train.sh configs/xxx.py work_dirs/xxx

# 评估
bash scripts/eval.sh configs/xxx.py work_dirs/xxx/checkpoint_step_10000.pt

常见错误入口#