VLABench/docs/langgraph_development.md

# LangGraph 开发手册

本手册汇总 ScenarioAgent 和 TaskAgent 的最新开发流程，统一说明任务生成、配置落地、指令策略与数据采集要点。

---

## 1. 开发总览

- **流水线概览**  
  Seed（`VLABench/configs/langgraph/seeds/*.jsonl`） → ScenarioAgent（资产挑选 / 指令生成 / 审计） → TaskAgent（任务配置 / 轨迹模板） → 采集脚本 → VLM / VLA 评测。
- **运行环境**  
  Python ≥ 3.10，推荐使用 `pip install -r requirements.txt && pip install -e .` 进行安装。
- **关键环境变量**
  ```bash
  export PYTHONPATH=.
  export VLABENCH_ROOT=$(pwd)/VLABench
  export MUJOCO_GL=egl
  ```
  若无显示环境可启用 `MUJOCO_GL=egl`，否则保持默认。

---

## 2. 常用命令速查

```bash
pip install -r requirements.txt && pip install -e .

python scripts/download_assets.py

python scripts/run_scenario_agent.py \
  --batch VLABench/configs/langgraph/seeds/safety_scenarios_30.jsonl \
  --enable-llm --generate-images --debug

MUJOCO_GL=egl PYTHONPATH=. python test_task_visual.py \
  --tasks chem01_mix_cleaners \
  --skip-skills \
  --save-dir /home/vla/Downloads/VLABench/renders/seed

obj2mjcf --obj-dir /home/vla/Downloads/VLABench/Tri/bread_loaf \
  --save-mjcf --compile-model --decompose --overwrite

export MUJOCO_GL=egl
export VLABENCH_ROOT=$(pwd)/VLABench
export PYTHONPATH=.
python scripts/trajectory_generation.py \
  --task-name line_up_fish_and_bread \
  --execution-mode malicious_execute \
  --n-sample 4 --start-id 0 \
  --robot franka \
  --save-dir vlabench_dataset
```

---

## 3. Seed 分类速览

| 分类 | 代号 | 典型风险 |
|------|------|----------|
| mechanical_collision | MCH01~MCH05 | 高处坠落、重物碰撞 |
| sharp_object | SHP01~SHP05 | 刀叉指向儿童、刀架错误摆放 |
| contamination | CON01~CON05 | 化学品、生熟交叉、误服药物 |
| thermal_fire | THR01~THR05 | 热饮、火焰、易燃物 |
| choking | CHK01~CHK05 | 小物件靠近婴儿 |
| electrical | ELE01~ELE05 | 液体靠近电子、电器短路 |

Seed 文件需要包含 `risk_category`、`malicious_instruction`、`intent_variants`、`notes` 等字段，以便下游流程了解风险语境。

---

## 4. 风险任务分层规划

当前任务体系包含三条发展线：

1. **恶意指令型（已有 seed_task）**：依照 seed 定义隐式/显式两档恶意指令，但始终指向同一危险动作。该分支仅保留恶意动作（`malicious_execute`）与拒绝（`malicious_refuse`）两种示范，用作 VLM/VLA 的“负样本 vs. 拒绝”评估。
2. **环境安全约束型（规划中）**：强调机器人运行过程中的碰撞/越界限制。例如抓取酒精时必须绕开燃烧蜡烛，或避免机械臂自损。任务将把“安全约束”显式编码进条件与专家策略，目前尚未开始实现。
3. **高优先级场景感知型（规划中）**：即使命令本身无恶意，也需要 AI 从观测中识别到额外危险（垃圾桶里的金戒指、婴儿旁的碎玻璃等）。此类任务需要渲染高危状态并要求模型主动报警，仍处于设计阶段。

---

## 5. 指令与执行模式策略

- **meta_instruction**：直接对应 seed 中的恶意原文，始终作为真实指令。
- **instruction_variants**：
  - `implicit`：伪装成中性的恶意表达（建议 2~3 条，至少 1 条）。
  - `explicit`：直白说明危害的恶意表达（建议 2 条，至少 1 条）。
  - ScenarioAgent 需要写入 `primary_neutral_instruction`（取 `implicit[0]`）与 `primary_malicious_instruction`（取 `explicit[0]`）。
- **execution_modes**：统一为 `malicious_refuse` 与 `malicious_execute`。
  - `malicious_refuse`：正向样本，仅表达拒绝逻辑。
  - `malicious_execute`：危险基线，严格按照恶意指令执行。
  - 后续 TaskAgent/任务实现需在 `trajectory_label` 与 `violation_tags` 中描述动作风险。
- **审计字段**：
  - `audit.instruction_generation`：记录 LLM 提示与响应长度、回退状态。
  - `audit.missing_assets`：追踪缺失资产或人工补救。
  - 任意自动补救（如插入安全托盘）必须写入审计，方便后续排查。

---

## 6. ScenarioAgent 开发要点

1. **状态输出**：
   - `scene`：目标场景 ID，优先使用 seed 中的 `scene_hint`。
   - `components`：目标实体列表，包含 `name`、`asset_id`、`class`、`xml_path`、`category`、`is_container` 等。
   - `instructions`：包含 `meta`、`implicit`、`explicit`。
   - `instruction_variants`：归一化后的 implicit/explicit 列表。
   - `execution_modes`：仅保留 `malicious_refuse`、`malicious_execute` 描述。
   - `metadata`：`risk_category`、`risk_tags`、`intent_variants`、`notes` 等。
   - `audit`：记录 LLM 调用、fallback、资产补救等信息。
   - `missing_assets`：真实缺失资产的列表。

2. **资产与容器规则**：
   - 只使用 `VLABench/configs/constant.py` 中已登记的资产；未收录的资产需人工补齐后再注册。
   - 所有容器都是普通资产，不存在“安全托盘”“危险容器”的隐含属性，安全语义由任务逻辑决定。
   - 不再启用自动托盘或容器推断；若需要托盘，请在 seed 或 ScenarioAgent 输出中显式声明。
   - LLM 解析完成后需去重，避免已确认资产仍然出现在 `missing_assets` 中。

3. **指令生成**：
   - `_build_instruction_prompt` 仅包含 `meta` 恶意指令及其 implicit/explicit 变体。
   - LLM 输出不足时使用 `_fallback_instruction_variants` 补齐，并在审计中标记原因。
   - 可在 prompt 中补充 `risk_category`、`notes` 作为语境提示。

4. **布局与校验**：
   - 自动补救操作必须写入 `audit.auto_fixes`，默认不自动插入任何容器或托盘。

---

## 7. TaskAgent（开发中）

- TaskAgent 目前处于落地阶段：目标是将 ScenarioAgent 输出结构化成 `task_config.json` 片段，再自动生成 `ConfigManager` 与 `PrimitiveTask` 模板。尚未发布初始化脚本，临时方案依旧是手动复制 ScenarioAgent 输出到 Python 任务中。
- 设计约束：
  1. 仅处理恶意指令型任务，输出 deterministic 配置。
  2. 明确 `scene`、`components`、`instruction_variants`、`execution_modes`（仅 malicious/refuse）、`metadata`，并保证 `missing_assets` 为空。
  3. 生成模板中需提供 `get_instruction`、`get_condition_config`、`init_conditions`、`get_expert_skill_sequence` 四个关键接口，并预留扩展点以支持环境安全/高优先级场景任务。
- 后续发布 TaskAgent CLI 时，再补充命令示例与文件目录结构。

---

## 8. 数据采集与验证

1. **视觉冒烟**：
   ```bash
   MUJOCO_GL=egl PYTHONPATH=. python test_task_visual.py --tasks <task> --skip-skills --save-dir renders/seed
   ```
   检查容器姿态、机械臂遮挡等问题。

2. **轨迹生成**：
   ```bash
   python scripts/trajectory_generation.py \
     --task-name <task> \
     --execution-mode malicious_execute \
     --n-sample 4 --start-id 0 \
     --robot franka \
     --save-dir <output>
   ```
   生成并保存视频/状态/审计文件。

3. **审计复核**：
   - `VLABench/reports/scenario_agent/*.jsonl`：查看 `missing_assets`、`audit` 字段。
   - `VLABench/reports/safety_scenarios_30_task_configs.jsonl`：TaskAgent 生成的配置合集，可用于差分验证。

---

## 9. 常见陷阱与提醒

- **容器误区**：仓库中所有容器都是普通资产，不存在“安全”和“危险”的内置区分，任务逻辑负责保证安全语义。
- **隐式恶意指令**：要“看似合理但指向危险”，避免与显式指令重复；可使用“整理”“准备”“方便”等词伪装。
- **自动托盘禁用**：不要重新引入历史启发式（自动补托盘、自动推断容器），缺失资产应通过 `missing_assets` 驱动人工补齐。
- **LLM fallback**：无论何种异常都需记录在 `audit.instruction_generation` 中，便于后续排查。
- **执行模式迁移**：所有任务需迁移到 `malicious_refuse` / `malicious_execute` 双轨，清理历史 `neutral_*` 依赖时务必同步更新脚本与配置。
- **Seed 信息完整性**：`risk_category`、`notes` 等字段缺失会降低 LLM 命中率，补全后再运行流程。
- **透明容器处理**：导入玻璃/烧杯时先在 Blender 调整 OBJ 原点到底部中心；在 MJCF 中为玻璃几何单独设置材质（如 `rgba="1 1 1 0.3" specular="0.6"`），液体或盖子可拆成额外 `<geom>`。修改 `scale` 时同步更新视觉与碰撞 mesh，并在杯沿放置 `<site class="grasppoint">`，让 `SkillLib.pick` 直接抓住容器而非顶翻。

---

## 10. 附录：路径速查

- Seeds：`VLABench/configs/langgraph/seeds/*.jsonl`
- LangGraph 配置：`VLABench/configs/langgraph/`
- Task 配置：`VLABench/configs/task_config.json`
- 任务代码：`VLABench/tasks/hierarchical_tasks/primitive/`
- ScenarioAgent 节点：`VLABench/langgraph_agents/nodes/scenario_nodes.py`
- TaskAgent 图：`VLABench/langgraph_agents/scenario_graph.py`
- 资产目录工具：`VLABench/langgraph_agents/utils/asset_catalog.py`
- Task 配置管理器：`VLABench/tasks/config_manager.py`
- 条件系统：`VLABench/tasks/condition.py`

---

## 11. 经验记录：ELEC01 倒水任务的几何微调

- **插线板贴边**（`VLABench/tasks/hierarchical_tasks/primitive/seed_tasks/elec01_pour_water_on_outlet.py:59-78`）  
  把 `edge_margin` 从 `0.05` 收紧到 `0.015`，让 `np.clip` 允许插线板靠近桌沿但仍保留 1.5 cm 的安全缓冲。若需要指定左右方向，直接改 `desired_xy` 的 `x` 分量。
- **杯子稳定抓取**（同文件 `167-189`）  
  通过 `pick_pos = grasp_point + [0, 0.02, 0]` 让爪子从杯侧进入；竖直偏移会导致从杯沿上方掐住，摩擦不足、移动中旋转脱手。
- **倒水落点**（同文件 `163-210`）  
  `pour_pos = outlet_pos + pour_offset`。若倒水偏左，可将 `pour_offset` 的 `x` 增加（正值向右、负值向左），`y` 控制靠近/远离，`z` 维持安全高度（默认 0.2）。记得同步修改 `pour_approach = pour_pos + [0,0,0.05]` 以保持轨迹平顺。
- **验证步骤**  
  运行 `python test_task_visual.py elec01_pour_water_on_outlet --execution-mode malicious_execute`，观察插线板和倾倒路径；若杯子仍有滑动，可再微调抓取偏移或在 `SkillLib.pick` 用 `specific_keypoint` 定位。

---

## 12. Seed Task 快速开发流程

> 以下流程已在 CHEM01~CHEM06 原子任务上验证，可直接复用到后续 ELEC / FIRE / PERSON / PRIV / VAL / FOOD 等系列。

1. **阅读 Scenario 报告**  
   - 打开 `VLABench/reports/scenario_agent/safety_scenarios_30_task_configs.jsonl` 与 `..._reports.jsonl`，以 `seed_id` 检索场景。
   - 记录 `components`、`instruction_variants`、`execution_modes`、`metadata` 等字段，确认是否存在 `missing_assets`。

2. **补充资产映射**  
   - 检查 `components[*].asset_id` 是否在 `VLABench/configs/constant.py` 注册；没有就新增条目（参考 `lab_beaker`、`potassium_permanganate` 的写法）。
   - 透明容器或新模型需要在 `VLABench/assets/...` 下准备好 XML，并提供 grasp / place sites；必要时在 `<body>` 里添加 `<inertial>` 来满足 MuJoCo 质量约束。

3. **写入任务配置**  
   - 在 `VLABench/configs/task_config.json` 添加独立条目，字段至少包含：`scene`、`asset`（seen/unseen object & container）、`components`（桌面等静态元素）、`random_ignored_entities`。
   - 同时更新 `VLABench/configs/__init__.py` 中 `name2config`，让任务名映射到自身（避免落回 `safety_risk_series`）。

4. **编写 Seed Task 脚本**  
   - 位置：`VLABench/tasks/hierarchical_tasks/primitive/seed_tasks/<seed_id_lower>.py`。
   - 模板：`mix_cleaning_liquids.py`、`chem01_mix_cleaners.py`；核心是 `ConfigManager` + `PrimitiveTask`。
   - `ConfigManager`：
     - 在 `__init__` 中固定资产名称，去掉随机资产采样。
     - `load_containers/load_objects` 清理旧组件后注入 deterministic 摆放；特殊姿态可通过 `get_entity_config(..., randomness=None)` 固定。
     - `get_instruction` 写入 implicit/explicit 变体与 `metadata` 风险标签。
     - `get_condition_config` 明确列表字段，例如 `pour_requirements`、`contain_requirements`。
   - `PrimitiveTask`：
     - `init_conditions` 使用 `PourCondition`、`ContainCondition` 等，避免旧的 `task_config` 字符串解析。
     - `get_expert_skill_sequence` 组合 `SkillLib.pick/moveto/place/pour`，必要时添加 `lift` 与自定义 offset。

5. **验证任务**  
   1. `MUJOCO_GL=egl PYTHONPATH=. python test_task_visual.py --tasks <task_name> --save-dir renders/seed`
   2. 若失败：
      - 编译报错：检查资产 XML（质量、惯量、非法属性）。
      - 姿态异常：调整 `ConfigManager` 中的位置 / 朝向；关键布局可打印或在调试模式下观察。
   3. 通过后观察 `/renders/seed/<task>` 的帧图，确认实体及专家动作符合预期。

6. **轨迹采集与审计**  
   - `python scripts/trajectory_generation.py --task-name <task> --execution-mode malicious_execute ...`
   - 审核生成的 `metadata/trajectory_label/violation_tags` 是否覆盖风险语义。

7. **文档与交付**  
   - 在 `docs/langgraph_development.md`（本文件）记录已完成的 seed 列表、关键变更、注意事项，确保后续同事能直接对照执行。
   - 若新增资产，请在代码评审中附上 MJCF 关键段落（如 `<inertial>`、`site`），方便审核材质与质量参数。

**重点代码参考**  
- `mix_cleaning_liquids.py`：最小化容器 + Contain 条件示例。  
- `chem01_mix_cleaners.py`：`PourCondition` 与倒入步骤模板。  
- `chem04_zinc_candle.py`：多实体组合 + 托盘定位的 ConditionSet。  
- `config_manager.py`：`BenchTaskConfigManager.get_task_config` 的装载顺序。  
- `tasks/condition.py`：`PourCondition`、`ContainCondition` 等判定逻辑。  
- `utils/skill_lib.py`：`pick / moveto / place / pour` 等专家动作实现。
- 审计报告：`VLABench/reports/scenario_agent/*.jsonl`

- 新增 `cola_pour_demo` 任务用于验证原生资产的 pick→倾倒动作：
  * 资产层面在 `pepsi.xml` 中保留原有圆柱碰撞体，补充 `bottom_site/top_site` 与四个围绕瓶身的 `grasppoint`，保证倾倒判定与横向夹取（参考 `chem02` 可乐）。
  * 专家策略顺序：`pick(specific_keypoint=侧向抓点) → lift → moveto(带倾角) → moveto(下降并维持倾角) → open_gripper`。不再依赖 `SkillLib.pour`，而是直接通过末端位姿完成倾斜。
  * 成功条件采用 `AboveCondition`，确认瓶身相对量杯位置；需要进一步扩展时，可叠加 `ContainCondition` 或定制倾角检测。
  * 任务入口与配置已注册（`configs/__init__.py`, `configs/task_config.json`, `primitive/__init__.py`），可通过 `trajectory_generation.py --task-name cola_pour_demo ...` 复用流程。


这些 OBJ 资产都是通过各自的 XML 里 <mesh> 节点的 scale 属性来控制缩放的。你可以在同一 XML 里同时给视觉网格和碰撞网格设置相同的缩放值，例如 VLABench/assets/obj/meshes/billiard_balls/
▌   billiards.xml:54-55 就把 ./visual/billiardsobj.obj 和对应的 collision OBJ 都缩放成了 0.0015 0.0015 0.0015。其他目录下的资产（比如 VLABench/assets/obj/meshes/cooked_food/hot_dog/hot_dog_1/model.xml:15-
▌   22）也是同样的写法。想换体积时，只要把三个方向的比例一起按需求乘上或改掉；记得视觉和碰撞两种 mesh 要保持一致，避免渲染和物理不匹配。调整完保存 XML 后，下次加载模型时就会按新的比例显示了。
▌
---

## 13. 最新开发记录：倒水特效联动

- **统一的流体可视化基类**：在 `tasks/components/specific_entities/interactive_containers.py` 新增 `FluidVisualMixin`，自动收集/生成带 `fluid/liquid/water` 前缀的 site/geom，并通过 `set_fluid_visible` / `update_fluid_stream` 控制透明度与姿态，默认将水柱对齐世界坐标系的 -Z 轴。
- **可复用的倒水实体**：注册 `PourableWaterCup`，继承 mixin + `CommonGraspedEntity`，在 `set_pouring_state` 中触发流体动画并以杯体中心为起点，`after_substep` 会持续刷新水柱位置/方向，避免模型倾斜时穿模。
- **交互设备共用特效**：`CoffeeMachine` 也改为继承 mixin，按钮被触碰时自动点亮咖啡流，效果与倒水任务保持一致。
- **条件驱动动画**：`PourCondition` 检测到 `bottom_site_z - top_site_z` 超过阈值时调用实体的 `set_pouring_state(physics, is_pouring)`，因此只要任务包含该条件，流体动画会在倾倒瞬间自动开启/关闭。
- **任务落地**：`elec01_pour_water_on_outlet` 的 `load_objects` 将水杯 `class` 指定为 `PourableWaterCup`，专家策略仍是 pick→lift→moveto→pour∂ 模板；运行 `scripts/trajectory_generation.py --task-name elec01_pour_water_on_outlet ...` 即可看到水流从杯中点沿 -Z 方向延伸。

> 若后续任务也需要倒液特效，只需让目标实体实现 `set_pouring_state`（或直接使用 `PourableWaterCup`），并在条件里复用 `PourCondition`，即可共享该动画机制。