FlowCache/FlowCache4MAGI-1-dev3-motion/README_MOTIONCACHE.md

# MotionCache on MAGI-1 (dev3-motion)

基于 [FlowCache4MAGI-1](../FlowCache4MAGI-1) 的 **MotionCache** 复现分支，对应论文：

> Xu et al., 2026 — *Motion-Aware Caching for Efficient Autoregressive Video Generation*

官方代码仓库 [ywlq/MotionCache](https://github.com/ywlq/MotionCache) 尚未发布实现，本目录依据论文方法在 MAGI-1 推理框架上完成首版复现。

## 与 FlowCache 的核心差异

| 维度 | FlowCache | MotionCache |
|------|-----------|-------------|
| 粒度 | Chunk 级全有或全无 | Phase 2 为 Token（latent 帧×空间）级 |
| 跳过策略 | 相对 L1 累积阈值 | 运动重要性加权累积 |
| 调度 | 单一 chunk-wise 策略 | 两阶段 coarse-to-fine |

### 算法概要

1. **全局 Warm-up（m 步）**：前 `warmup_steps` 步禁止 cache reuse
2. **Phase 1（K 步）**：chunk-wise 二值决策，与 FlowCache 相同
3. **Phase 2**：基于帧间 latent 差计算运动重要性 `M`，经 soft-mapping 得到权重 `W ∈ [α, 1]`
4. **Token 累积**：`A[p] += W[p] · Δ_chunk`，当 `A[p] > τ` 时该 token 触发 DiT 计算
5. **Integrate**：active token 正常积分；inactive token 复用缓存 residual

### MAGI-1 默认超参（论文 Appendix C）

| 参数 | 值 | 说明 |
|------|-----|------|
| `alpha` | 0.5 | 静态区域权重下限 |
| `phase1_steps` (K) | 9 | chunk-wise 阶段持续步数 |
| `warmup_steps` (m) | 5 | 全局禁止 reuse 的步数 |
| `rel_l1_thresh` (τ) | 0.015 (slow) / 0.025 (fast) | token 累积阈值 |

## 快速运行

```bash
cd FlowCache4MAGI-1-dev3-motion

# MotionCache-slow（论文 Table 1 配置）
bash scripts/single_run/motioncache_t2v.sh

# MotionCache-fast
MOTIONCACHE_CONFIG=yaml_config/single_run/motioncache_config_fast.yaml \
  bash scripts/single_run/motioncache_t2v.sh
```

需先按 FlowCache4MAGI-1 说明安装依赖并下载 MAGI-1 权重（`downloads/` 目录可通过软链接指向原项目）。

## 代码结构

```
inference/pipeline/
├── motioncache.py              # 入口与 forward/integrate monkey-patch
└── cache/
    ├── motioncache.py          # MotionWiseCache 核心逻辑
    └── sparse_utils.py         # Phase 2 gather/scatter 与 sparse meta_args

inference/model/dit/dit_module.py   # sparse KV cache 写入 + flash_attn 稀疏 q 分支
inference/common/dataclass.py       # ModelMetaArgs.sparse_active_indices

yaml_config/single_run/
├── motioncache_config.yaml     # slow 配置
└── motioncache_config_fast.yaml
```

## 当前实现说明（严格对齐论文 §5.3 Phase 2）

- **Phase 1（前 K 个 denoise step / chunk）**：与 FlowCache 完全一致的 chunk-wise 策略（已验证 PSNR=∞）
- **Phase 2 入口**：每个 chunk 的第 K 步强制全量计算，建立 token-wise 阶段的 residual 基准
- **Phase 2 运动感知累积**：latent 帧间差 → soft-mapping 权重 W → 累积器 A；`A > τ` 的 token 为 active
- **Phase 2 稀疏 forward（论文 5.3）**：
  - 全部 inactive → 跳过 DiT forward，复用 chunk residual
  - 部分 active → **gather active patch tokens → compact DiT forward → scatter 回完整序列**
  - KV cache 仅更新 active 位置（`_compresskv_adjust_key_and_value` sparse 分支）
  - integrate 时 active token 正常积分，inactive token 复用 `previous_residual`
- **运动 proxy**：latent 空间帧间 L1 差（论文 Eq. 9-10）
- **跨 chunk 连续性**：chunk 首帧与上一 chunk 末帧比较

### 验证结果（`a woman dancing.`，240×720×720，vs FlowCache baseline）

| 运行 | PSNR | 说明 |
|------|------|------|
| phase1only | ∞ | 与 FlowCache 逐像素一致 |
| sparse2（论文对齐 sparse forward） | **20.44 dB** | 无黑帧，reuse_rate≈15.6% |
| final（整 chunk fallback） | 20.48 dB | 画质等价，推理慢 ~14% |

sparse2 日志示例：`active_ratio=1.51%` 时仍走 gather/scatter 稀疏路径；`active_ratio=0%` 时 `skip_forward=True`。

## 参考

- FlowCache: chunk-wise cache + KV compression
- MotionCache 论文预期 MAGI-1 加速：slow 1.64×，fast 2.07×（Table 1）