code/README.md

# Cuphead 本地检测器：迁移、训练、评估与全量推理

这个目录是可直接迁移到另一台 Linux/NVIDIA 服务器的训练包。首选方案是用
Ultralytics YOLO26s 在 Qwen 教师标注上微调三类检测器：

- `0 player`
- `1 npc`
- `2 attack_object`

首选 YOLO26s + 960 输入，而不是 nano：攻击物体通常较小，s 模型的容量更稳；
它仍只有约 9.5M 个推理参数，单张 24GB RTX 4090 足够。先不使用 P2，原因是
官方只提供 P2 架构 YAML、没有对应的 scale-specific 预训练权重。仅当
`attack_object` 的召回率过不了质量门，才进入 P2 或 1280 输入的第二轮实验。

## 已准备内容

训练代码包（约 22MB）：

```text
/home/ch/cuphead_detector_training_bundle
```

最终 YOLO 数据集（约 888MB）：

```text
/home/ch/cuphead_annotation_artifacts/yolo_teacher_v2
```

数据集已经通过严格检查：2,500 张图、2,500 个标签文件、0 个非法框、0 个
来源泄漏；train/val 为 2,100/400。共有 8,512 个框，其中 player 1,935、
npc 3,609、attack_object 2,968。460 张是合法空标签，其中 455 张是菜单、过场、
黑屏等明确负样本。

包内已有官方 `models/yolo26s.pt`，SHA256：

```text
646f8bc3fe0a656803d95c294f7852321748cb29d13466a1af8862e2db384a1b
```

`download_checkpoint.py` 可在目标服务器重新下载并强制校验同一权重。

## 迁移

从当前机器执行，替换目标主机和目录：

```bash
rsync -a --info=progress2 \
  /home/ch/cuphead_detector_training_bundle/ \
  USER@HOST:/data/cuphead_detector_training_bundle/

rsync -a --info=progress2 \
  /home/ch/cuphead_annotation_artifacts/yolo_teacher_v2/ \
  USER@HOST:/data/yolo_teacher_v2/
```

`data.yaml` 不含当前机器的绝对路径，整个数据目录移动后仍可直接使用。

## 目标机器配置

推荐配置：

- GPU：1 × RTX 4090 24GB；训练时保证至少 18GB 空闲显存。
- CPU：8 核最低，12–16 核推荐；全量视频解码更依赖 CPU。
- 内存：32GB 最低，64GB 推荐。
- 磁盘：训练阶段至少 30GB 可用；建议 50GB NVMe。默认不展开磁盘缓存。
- 软件：Linux、Python 3.10/3.11、可用的 NVIDIA 驱动。

环境固定为 PyTorch 2.8.0 + CUDA 12.8 wheel、torchvision 0.23.0、
Ultralytics 8.4.123。若目标机器驱动不能运行 CUDA 12.8 wheel，可将环境变量
`TORCH_INDEX_URL` 改成该 PyTorch 版本提供且与驱动兼容的官方 CUDA wheel 索引。

安装：

```bash
cd /data/cuphead_detector_training_bundle
PYTHON_BIN=python3.10 ./setup_env.sh .venv
source .venv/bin/activate
```

## 一键训练、评估和可视化

```bash
cd /data/cuphead_detector_training_bundle
./run_training_pipeline.sh /data/yolo_teacher_v2/data.yaml 0
```

一键流程依次执行：数据检查、权重下载/校验、150 epoch 训练、held-out val
评估、按类别部署阈值搜索、30 张预测可视化。关键输出：

```text
runs/yolo26s_960_cuphead_v2/weights/best.pt
runs/yolo26s_960_cuphead_v2/weights/last.pt
runs/yolo26s_960_cuphead_v2_evaluation/quality_gate.json
runs/yolo26s_960_cuphead_v2_visual_qa/contact_sheet.jpg
```

质量门是每类 precision ≥ 0.85，同时 recall 分别达到 player 0.95、npc 0.90、
attack_object 0.85。评估器会在 IoU=0.5 下结合 56 张 val 空标签搜索每类置信度，
并在质量不合格时以非零状态退出，阻止误启动全量标注。

### 断点续训

Ultralytics 每个 epoch 保存 `last.pt`，并每 10 epoch 额外留档。原目录续训：

```bash
python train.py \
  --resume runs/yolo26s_960_cuphead_v2/weights/last.pt \
  --data /data/yolo_teacher_v2/data.yaml \
  --project runs --name yolo26s_960_cuphead_v2 --device 0
```

`resume` 会恢复优化器、学习率调度器和 epoch，而不是只加载模型权重。

## 4090 时间与租用建议

下列是基于 2,100 张训练图、960 输入、YOLO26s、AMP、batch 32 的保守工程估算；
真实速度受 CPU 解码、NVMe/NAS、驱动和云主机限速影响：

| 工作 | 单张 RTX 4090 预计墙钟时间 | 建议预留 |
|---|---:|---:|
| 环境安装与数据检查 | 10–25 分钟 | 30 分钟 |
| 150 epoch 基线训练 | 55–110 分钟 | 2 小时 |
| 独立评估与可视化 | 5–15 分钟 | 20 分钟 |
| 一次完整训练闭环 | 1.2–2.3 小时 | 4 小时租期 |
| 47.9 万帧全量推理（含 26.6 小时视频的 CPU 解码） | 4–10 小时 | 10–16 小时租期 |

因此：只训练和评估，租 **1 × 4090、4 小时**；训练后马上全量标注，租
**1 × 4090、12 小时起，16 小时更稳**。这个训练集很小，不建议为训练租 2–4 张
4090，DDP 通信和启动开销可能抵消收益。多卡更适合在全量推理阶段按 shard 并行。

训练开始 5 个 epoch 后，可用日志中的平均 `time/epoch × 剩余 epoch` 修正估算。
early stopping 可能让实际训练早于 150 epoch 结束。

在 80GB 显存机器上仍建议保持 `BATCH_SIZE=32`。这个数据集较小，`batch=-1`
会尝试使用约 60% 显存并可能生成过大的 batch，使每个 epoch 的更新步数过少。
若确认收敛正常，可用 `BATCH_SIZE=48 ./run_training_pipeline.sh ...` 做第二次实验。

## 全量视频标注（训练通过后才能执行）

先做 10 个视频的 smoke test：

```bash
python infer_all_videos.py \
  --model runs/yolo26s_960_cuphead_v2/weights/best.pt \
  --dataset-root /data/cuphead_dataset_converted_all \
  --inventory inventory/cuphead_inventory.jsonl \
  --quality-gate runs/yolo26s_960_cuphead_v2_evaluation/quality_gate.json \
  --output-dir /data/cuphead_yolo_predictions \
  --device 0 --imgsz 960 --batch 16 --max-videos 10
```

抽检 smoke test 结果后，去掉 `--max-videos 10` 重跑。每个视频独立原子落盘，
中断后执行同一命令会跳过已完成视频；空预测也写成
`bbox_annotation_status="annotated", objects=[]`，不会与缺失标注混淆。

双卡推理可启动两个进程，共享同一个输出目录：

```bash
python infer_all_videos.py ... --device 0 --shard-index 0 --shard-count 2
python infer_all_videos.py ... --device 1 --shard-index 1 --shard-count 2
```

全部成功后合并成单一 JSONL：

```bash
python merge_predictions.py \
  --inventory inventory/cuphead_inventory.jsonl \
  --inference-dir /data/cuphead_yolo_predictions \
  --output /data/cuphead_yolo_predictions/annotations.jsonl
```

## 是否选择 Ultralytics YOLO

选择它是合适的。当前任务是固定三类、矩形框、小教师集到大规模伪标注，Ultralytics
已经把预训练、混合精度、auto batch、断点恢复、mAP/PR/混淆矩阵、预测和导出放在
同一接口里，能明显降低工程风险。YOLO26 还专门更新了小目标标签分配，因此适合作为
第一条基线。

但需要注意两点：

1. 检测器不会真正理解“scene”。非战斗帧是否保持空标注，最终依赖负样本和置信度；
   所以本包特意纳入了 455 张非战斗负样本，并在 val 质量门里统计假阳性。
2. Ultralytics 代码/模型使用 AGPL-3.0，并提供 Enterprise 许可。研究内部使用通常容易
   管理；若未来嵌入闭源商业产品，需单独核对许可要求。