docs/af3_spatial_design.md

# AF3 + Spatial-BEATs 设计说明

本目录下的四份新文件实现了把 Spatial-Qwen 的 Spatial 接入范式迁移到
NVIDIA Audio Flamingo 3 (AF3) 上。

## 核心结论

| 维度 | Spatial-Qwen | Spatial-AF3 |
|---|---|---|
| Base LLM hidden | 3584 | **3584**（相同，projector 无需调） |
| 基座 | Qwen2.5-Omni Thinker/Talker | AF3 = Whisper Enc + **Qwen2-7B Dec** |
| Spatial 注入机制 | `inputs_embeds.masked_scatter` | 同 |
| 占位符 | `<\|spatial\|>` | `<spatial>`（新加，token id=151672） |
| RoPE 定制 | 需要（M-RoPE 3 段） | **不需要**（AF3 用标准 1D RoPE） |
| Audio 占位符 | `<\|AUDIO\|>` | `<sound>`（AF3 原生） |
| LoRA 前缀 | `thinker.model` | `language_model.model` |

## 新增文件

| 路径 | 作用 |
|---|---|
| `spatial_qwen/model/modeling_spatial_af3.py` | `AudioFlamingo3SpatialForConditionalGeneration`：AF3 子类，新增 `spatial_beats_encoder` + `spatial_beats_projector`，重写 `forward` 按 `<sound>` → `<spatial>` 两次 `masked_scatter` 注入 |
| `spatial_qwen/model/processing_spatial_af3.py` | `AudioFlamingo3SpatialProcessor`：AF3 Processor 子类，接受 FOA 4ch，W 通道走 Whisper、全 4 通道送给 BEATs，扩展 `<spatial>` 占位符 |
| `train_spatial_af3_qa.py` | 三阶段训练入口（projector_only / encoder_lora / beats_lora），重用 `train_spatial_beats_qa.py` 里所有与模型无关的工具 |
| `scripts/bench_test_generate_af3.py` | test split 生成脚本，predictions.jsonl 与 Qwen 路径完全同格式，可直接喂给 `score_test_predictions.py` |
| `shell/launch_train_spatial_af3_qa.sh` | 启动脚本，默认环境变量 + 分布式包装 |

## 关键设计决策

### 1. transformers fork 依赖
AF3 需要 NVIDIA 本地 fork（版本 5.0.0rc1，在 spur env 的 4.52.0 下不兼容）。
训练脚本在 `main()` 起始就把 fork 路径插到 `sys.path` 最前面（`ensure_af3_on_path`），
确保后续所有 `import transformers.*` 走 fork 版。

启动脚本也会导出 `PYTHONPATH`，并强烈建议**独立 conda env**（`af3`），见 shell 脚本 comment。

### 2. FOA → Whisper 只喂 W 通道
AF3 的 Whisper encoder 是单声道的，无法直接吃 4ch FOA。Processor 内部对 FOA 样本取
W（第一声道）送给 Whisper，同时把全 4 通道保留给 Spatial-BEATs encoder。

### 3. 不子类化 `AudioFlamingo3Config`
`AutoConfig.from_pretrained` 通过 `model_type` 字符串做 registry 查找；
子类化会导致 registry 冲突。改用**运行时往 config 对象上 attach 字段**的方式
（与 Qwen 路径的 `tc.spatial_beats_*` 完全同模式）。

### 4. `<sound>` 与 `<spatial>` 两次独立 masked_scatter
`forward()` 里先跑 AF3 原生的 `<sound>` 注入（抄自 parent），再跑 `<spatial>` 注入。
两次操作写入不同的 token 位，互不干扰。

### 5. KV-cache decode 时跳过空间编码器
`prepare_inputs_for_generation` 只在 `cache_position[0] == 0`（prefill）时把
`spatial_audio` / `spatial_tokens` 挂上，decode 阶段剥离，避免每解码一个 token
就重跑一遍 BEATs（那会让 generate 变得无法用）。

### 6. Checkpoint 格式与 Qwen 完全一致
`trainable_state_dict` + optimizer + scheduler + metrics，`score_test_predictions.py`
不需要任何改动。

## 使用方法

### 1. 准备环境
```bash
# 建议独立 env，避免和 Spatial-Qwen 的 transformers 4.52 冲突
conda create -n af3 python=3.10 -y
conda activate af3
cd /apdcephfs_cq10/.../model/transformers && pip install -e .
pip install peft torch numpy soundfile tensorboard tqdm
```

### 2. 训练
```bash
conda activate af3
bash shell/launch_train_spatial_af3_qa.sh
# 只跑 stage2
START_STAGE=2 bash shell/launch_train_spatial_af3_qa.sh
# 也要跑 stage3（BEATs 解冻）
START_STAGE=3 RUN_STAGE3=1 bash shell/launch_train_spatial_af3_qa.sh
```

### 3. 评测（test split）
```bash
torchrun --nproc_per_node=8 scripts/bench_test_generate_af3.py \
    --run-dir runs/v13d_easy_llmqa_af3/stage2_encoder_lora \
    --checkpoint-tags best \
    --qa-root /apdcephfs_cq10/.../easy_filtered \
    --split test
python scripts/score_test_predictions.py \
    --predictions-jsonl runs/v13d_easy_llmqa_af3/stage2_encoder_lora/bench/test/best/predictions.jsonl \
    --azimuth-threshold-deg 20 --elevation-threshold-deg 10
```

## 已知 gotcha / 待验证项

1. **Processor 的 `save_pretrained()`**：`AudioFlamingo3Processor` 可能不支持
   额外的 spatial 字段持久化；训练时已 try/except。读回时 `AutoProcessor` 不会
   恢复 `spatial_token` 设置，**评测脚本每次重新构造 processor 是正确做法**。

2. **`resize_token_embeddings` 初始化**：新增的 `<spatial>` embedding 行随机初始化。
   与 Qwen 路径一致；实际推理时会被 BEATs 投影立即覆盖，所以随机值无影响。

3. **BEATs → AF3 可能需要独立的 projector 初始化**：AF3 embed 分布与
   Qwen2.5-Omni 不同，从 Spatial-Qwen easy 训好的 projector 热启动可能不稳定。
   首次训练建议**从头 stage1**，跑 ~1 epoch 看 loss 曲线。

4. **长音频 vs `max_audio_len=600`**：AF3 processor 默认支持最长 600s（20 个 30s
   窗口），但 Spatial-Qwen 的约定是 20s / 16kHz。我们保持 20s 上限（见
   `spatial_audio_max_seconds=20.0`），`<sound>` 的 token 数对应 ~375 个 token。

## 冒烟测试

建议第一次跑先做 128 个样本的小规模验证：
```bash
torchrun --nproc_per_node=1 train_spatial_af3_qa.py \
    --max-train-samples 128 --max-valid-samples 32 \
    --epochs 1 --projector-only \
    --qa-root /apdcephfs_cq10/.../easy_filtered \
    --output-dir runs/af3_smoke
```