README.md

# Second Work on FairTalking-Bench: CTA / PSM / RADR

Three novel, identity-agnostic, generator-agnostic deepfake detection methods
built on top of the FairTalking-Bench dataset.

## Methods

| Name  | Core idea | Trainable? | Backbone |
|-------|-----------|------------|----------|
| CTA   | Causal Time-Arrow asymmetry (A->V vs V->A predictive loss gap) | Yes | TimeSformer / ViT + Wav2Vec2 |
| PSM   | Phoneme-Synchrony Manifold (phoneme-conditioned lip prior) | Yes | Wav2Vec2-phoneme + MediaPipe lip |
| RADR  | Reference-Anchored Diffusion Residual (external VideoMAE prior) | Adapter only | VideoMAE-base |

All three avoid "learning what real looks like on this particular dataset",
which you correctly identified as the failure mode of one-class approaches.

## Dataset layout expected

```
/apdcephfs_gy4/share_303628665/joywu/dataset/FairTalking-Bench/
├── Real/           *_Real_*.mp4
├── AniPortrait/    *_Fake_AniPortrait.mp4
├── Ditto/          *_Fake_Ditto.mp4
├── EDTalk/
├── Float/
├── Hallo/
├── Joyvasa/
├── SadTalk/
├── Sonic/
├── train.csv       basename,Label,gender,race4,age_group,...,source,basename_old
├── val.csv
└── test.csv
```

Audio is embedded inside mp4. Run `scripts/prepare_audio.sh` once to extract
wavs to `$DATA_ROOT/_audio/` for fast training.

## Quick start

```bash
# 1. deps (no conda; system python3)
pip3 install --user -r requirements.txt

# 2. preprocess audio (one-time, ~30min on 8 workers)
export DATA_ROOT=/apdcephfs_gy4/share_303628665/joywu/dataset/FairTalking-Bench
bash scripts/prepare_audio.sh

# 3. set HDTF id-paired subset csv paths (see scripts/prepare_hdtf_splits.py)
python3 scripts/prepare_hdtf_splits.py --data_root $DATA_ROOT

# 4. train each method (8xH20 DDP auto)
bash scripts/train_cta.sh    # ~12h
bash scripts/train_psm.sh    # ~18h (after CTA is verified)
bash scripts/train_radr.sh   # ~24h (adapter-only, still needs SVD download)

# 5. run all 4 protocols on a trained checkpoint
bash scripts/eval_all.sh cta  outputs/cta/checkpoints/last.ckpt
bash scripts/eval_all.sh psm  outputs/psm/checkpoints/last.ckpt
bash scripts/eval_all.sh radr outputs/radr/checkpoints/last.ckpt
```

## 联合训练:FairTalking + HDTF-paired

> 中文说明 —— 在 FairTalking-Bench 的 train 集基础上,把 HDTF-paired 的视频
> 也并入训练集。验证集仍然使用原来 FairTalking-Bench 的 `val.csv`,**不**混入 HDTF。

### 数据布局要求

```
$HDTF_PAIRED_ROOT/                      默认 /apdcephfs_gy5/share_303628665/joyewu/HDTF-paird
├── AniPortrait/  <num>_Fake_HDTF_AniPortrait.mp4
├── Ditto/
├── EDTalk/
├── Float/
├── Hallo/
├── Joyvasa/
├── Sonic/                              （注意:HDTF-paired **没有** SadTalk,代码会自动跳过）
├── Real/         <num>_Fake_HDTF.mp4
└── _audio/                             由下面的脚本生成
```

### 步骤一:抽取 HDTF-paired 的音频(只需做一次)

```bash
conda activate pytorch
cd /apdcephfs_gy4/share_303628665/joywu/research/fairtalking-second-work

# HDTF-paired 数据根。如果已写入 .env,可省略此行
export HDTF_PAIRED_ROOT=/apdcephfs_gy5/share_303628665/joyewu/HDTF-paird

# 默认 8 个并行 worker;首参数可改并发数
bash scripts/prepare_hdtf_paired_audio.sh
# 或: bash scripts/prepare_hdtf_paired_audio.sh 16
```

抽完会在 `$HDTF_PAIRED_ROOT/_audio/` 下产出与 mp4 一一对应的 16 kHz mono wav。
脚本是幂等的,中断后重跑只补抽缺失部分。

### 步骤二:启动联合训练

```bash
bash scripts/train_cta_combined.sh
```

等价于:

```bash
python3 src/train.py \
    method=cta \
    data=fairtalking_plus_hdtf \
    trainer=ddp \
    backbone=timesformer \
    experiment_name=cta_combined
```

输出目录:`outputs/cta_combined_<时间戳>/`,checkpoint 落在 `<目录>/checkpoints/`。
启动时会打印类似下面这一行,确认两路数据都进了 train loader:

```
[datamodule] train ConcatDataset sizes: FairTalkingBenchDataset=N, HDTFPairedTrainDataset=3212; total=N+3212
```

### 数据混合的实现细节

* **训练集** = `FairTalkingBenchDataset(train.csv)` ⊕ `HDTFPairedTrainDataset(HDTF-paird 整目录)`,通过 `torch.utils.data.ConcatDataset` 在 dataloader 层合并,样本格式完全一致。
* **HDTF-paired 当前可用 generator**:`AniPortrait / Ditto / EDTalk / Float / Hallo / Joyvasa / Sonic`(7 个)+ `Real`,共约 3212 条样本(约 2802 fake + 410 real)。HDTF-paired 没有 SadTalk,代码自动跳过。
* **HDTF 样本没有人口学标注**,`gender / race4 / age_group` 字段为空字符串。fairness 评估的实现只对 `ours` 测试集生效,HDTF 训练样本不会污染公平性指标。
* **验证集不变**:还是 FairTalking 的 `val.csv`,所以 best-checkpoint 选择跨实验仍可比。
* **配置开关**:`configs/data/fairtalking_plus_hdtf.yaml` 里的 `extra_train_hdtf_paired: true` 是这一切的总开关。要切换回纯 ours 训练,只需把命令里 `data=fairtalking_plus_hdtf` 换回 `data=fairtalking`(即用 `bash scripts/train_cta.sh`)。

### 训练其他方法 / 消融变体

新增的 `data=fairtalking_plus_hdtf` 与方法侧解耦,可直接搭配任意 method:

```bash
# CTA 消融(以 A1_full 为例)
python3 src/train.py method=cta_ablation method.ablation_variant=A1_full \
    data=fairtalking_plus_hdtf trainer=ddp backbone=timesformer \
    experiment_name=cta_ablation_A1_full_combined

# PSM / RADR 同理,把 method= 改一下即可
```

### 环境变量

请在 `.env` 中追加:

```
HDTF_PAIRED_ROOT=/apdcephfs_gy5/share_303628665/joyewu/HDTF-paird
```

或在每次运行前 `export HDTF_PAIRED_ROOT=...`。

## 按生成器家族训练 + Holdout 测试

> 中文说明 —— 把 FairTalking 的 8 个 generator 按家族拆开:**只用 diffusion 家族训练**,其他三个家族(3DMM / AE / Flow-Matching)留作未见家族 holdout 测试。用于评估模型的"跨家族泛化能力"。

### 家族归类

| 家族 | Generator | 用途 |
|---|---|---|
| **Diffusion**(5) | AniPortrait, Ditto, Hallo, JoyVASA, Sonic | train + val |
| **3DMM**(1) | SadTalker | test(未见家族) |
| **AE / VAE-based**(1) | EDTalk | test(未见家族) |
| **Flow-Matching**(1) | Float | test(未见家族) |

### 实现说明:不改 dataset / 方法代码,纯靠 yaml

`FairTalkingBenchDataset` 已经按 `cfg.generators` 字段过滤 fake 行了:
* `expand_fakes="random"`(train / val):每个 fake 行从 `cfg.generators` 列表里挑一个 generator
* `expand_fakes="all"`(test):每个 fake 行展开成 `len(generators)` 行

所以**只要把 yaml 里的 `generators` 列表压缩到对应家族**就能精准过滤,共享同一份 `train.csv / val.csv / test.csv`,Real 行不受影响。

### 新增的 4 个 yaml

| 文件 | `generators` 字段 | 用途 |
|---|---|---|
| `configs/data/fairtalking_diffusion_only.yaml` | 5 个 diffusion | 训练 + 验证 |
| `configs/data/fairtalking_test_sadtalker.yaml` | `[SadTalk]` | holdout 3DMM 测试 |
| `configs/data/fairtalking_test_edtalk.yaml` | `[EDTalk]` | holdout AE 测试 |
| `configs/data/fairtalking_test_float.yaml` | `[Float]` | holdout Flow-Matching 测试 |

每个 holdout 测试集的样本数:**291 real + 290 fake = 581**,1:1 类平衡,AUC 在统计上稳定。

### 步骤一:训练 CTA(diffusion-only)

```bash
bash scripts/train_cta_diffusion.sh
```

输出目录:`outputs/cta_diffusion_<时间戳>/`,checkpoint 在 `<目录>/checkpoints/`。

启动时数据装载日志会显示 train/val 都只剩 5 个 diffusion + Real。

### 步骤二:三家族 Holdout 测试

```bash
# 自动发现最新的 cta_diffusion_* 训练目录,默认 top-3 + last 共 4 ckpt
bash scripts/batch_test_diffusion_holdout.sh

# 也跑一次 in-distribution diffusion 作 reference(强烈建议加上,方便读 cross-family gap)
bash scripts/batch_test_diffusion_holdout.sh --include-diffusion

# 只测 best ckpt 快速看
bash scripts/batch_test_diffusion_holdout.sh --num-top 1

# 只测某些家族
bash scripts/batch_test_diffusion_holdout.sh --families sadtalker float
```

输出目录:`outputs/cta_test_result/diffusion_holdout_<时间戳>/results.csv`,长表格式,每行一个 `(family, ckpt)` 组合,包含 acc / auc / AP / Acc@EER + fairness。

### 解读建议

如果 CTA 真的学到了 generic 的 deepfake 特征:
* `diffusion` AUC ≈ 训练时的 val/auc(in-distribution sanity check)
* 三个 holdout 家族 AUC:
  * 越接近 diffusion AUC → 跨家族泛化越好
  * 接近 0.5 → 模型只学到了 diffusion-specific artifact
  * 介于 0.5 ~ diffusion 之间 → 部分泛化

### 加大训练量:Diffusion-only + HDTF-paired diffusion 子集

> 在上面"步骤一"的基础上,把 HDTF-paired 中**只属于 diffusion 家族**的子目录(`AniPortrait / Ditto / Hallo / Joyvasa / Sonic` + `Real`)也并入训练集。验证集和三家族 holdout 测试都不变,纯粹用更多 diffusion 训练数据来提升泛化下限。

#### 训练数据规模

| 来源 | fake | real | 子总计 |
|---|---|---|---|
| FairTalking ours train(5 diffusion) | 2372 | 2371 | 4743 |
| HDTF-paired 5 diffusion 子目录 + Real | 2029 | 410 | 2439 |
| **ConcatDataset 训练总量** | | | **7182** |

Val 仍然是 FairTalking val(diffusion + Real,604 条),**HDTF 不混入 val**,保证 best-ckpt 选择跨实验可比。

#### 实现说明

完全不动 dataset / datamodule / 方法代码。只新增一个 yaml,通过现有的 `extra_train_hdtf_paired` 和 `extra_train_hdtf_generators` 字段,把两边都限制到同样 5 个 diffusion 子集:

```yaml
# configs/data/fairtalking_diffusion_plus_hdtf.yaml(摘要)
generators:                         # ours 端
  - AniPortrait
  - Ditto
  - Hallo
  - Joyvasa
  - Sonic
extra_train_hdtf_paired: true
extra_train_hdtf_generators:        # HDTF 端,严格对齐
  - AniPortrait
  - Ditto
  - Hallo
  - Joyvasa
  - Sonic
```

注意 HDTF-paired **不能**包含 EDTalk / Float / SadTalker —— 它们是 holdout 测试集,加进训练就泄漏了。

#### 启动训练

前置:HDTF 的 wav 已经抽好(`scripts/prepare_hdtf_paired_audio.sh`,跟 `## 联合训练` 一节同一个脚本,跑过就跳过)。

```bash
bash scripts/train_cta_diffusion_combined.sh
```

输出目录:`outputs/cta_diffusion_combined_<时间戳>/`。启动时应该看到:

```
[datamodule] train ConcatDataset sizes: FairTalkingBenchDataset=4743, HDTFPairedTrainDataset=2439; total=7182
```

#### Holdout 测试(沿用 diffusion-only 那个脚本)

`batch_test_diffusion_holdout.sh` 默认自动发现最新的 `outputs/cta_diffusion_*` 训练目录。**combined 版本和原版会同时存在**,自动选最新的(很可能是 combined 这次)。如果想测某个具体版本:

```bash
# 显式指定 combined 训练目录
bash scripts/batch_test_diffusion_holdout.sh outputs/cta_diffusion_combined_<TS>/

# 或者更显式,直接传 ckpt
bash scripts/batch_test_diffusion_holdout.sh \
    --ckpt outputs/cta_diffusion_combined_<TS>/checkpoints/best.ckpt

# 加上 --include-diffusion 看 in-distribution reference,直接读 cross-family gap
bash scripts/batch_test_diffusion_holdout.sh --include-diffusion outputs/cta_diffusion_combined_<TS>/
```

#### 与已有相关流程的关系一览

| 训练脚本 | data 配置 | 训练源 | 输出目录前缀 |
|---|---|---|---|
| `train_cta.sh` | `fairtalking` | ours 全 8 generator | `outputs/cta_<TS>/` |
| `train_cta_combined.sh` | `fairtalking_plus_hdtf` | ours 8 + HDTF 7 | `outputs/cta_combined_<TS>/` |
| `train_cta_diffusion.sh` | `fairtalking_diffusion_only` | ours 5 diffusion | `outputs/cta_diffusion_<TS>/` |
| **`train_cta_diffusion_combined.sh`** | `fairtalking_diffusion_plus_hdtf` | ours 5 diffusion + HDTF 5 diffusion | `outputs/cta_diffusion_combined_<TS>/` |

四个流程互不覆盖,可以并存。

### 用于消融实验

整个家族切分流程**同样支持 31 个消融变体**。所有变体重新训练一遍(`data=fairtalking_diffusion_only`),再在三个未见家族 + 三个跨域数据集上批量测试。这套流程与原始消融流程(`run_all_ablations.sh` + `batch_test_cta_ablation_full.sh`)**互不冲突**:新训练目录加 `diffusion_` 前缀,原 31 个目录原样保留,新批量测试脚本只识别新前缀。

#### 与原消融流程的对比

| 维度 | 原消融流程 | 新 Diffusion-only 消融流程 |
|---|---|---|
| 训练 data 配置 | `data=fairtalking`(8 generator) | `data=fairtalking_diffusion_only`(5 个 diffusion + Real) |
| 训练目录 | `outputs/cta_ablation_<V>_<TS>/` | `outputs/cta_ablation_diffusion_<V>_<TS>/` |
| 测试集 | `ours / thb / ff++ / mmdf` | `ours_sadtalker / ours_edtalk / ours_float / thb / ff++ / mmdf` |
| `ours` 含义 | 8 generator 全测 | 拆成三个未见家族,各自一行 |
| Fairness 列 | 仅 `ours` | 仅三个 `ours_*` |

#### 步骤一:批量训练所有 31 个 variant(diffusion-only)

```bash
# 顺序跑全部 31 个 variant
bash scripts/run_all_ablations_diffusion.sh

# 只跑某一组(A / B / C / D / E / F / G / M)
bash scripts/run_all_ablations_diffusion.sh --group A
bash scripts/run_all_ablations_diffusion.sh --group M

# 并行(需要 GNU parallel,默认 4 个并发)
bash scripts/run_all_ablations_diffusion.sh --parallel
```

每个 variant 落到 `outputs/cta_ablation_diffusion_<VARIANT>_<时间戳>/`。
单 variant 训练入口:`bash scripts/train_cta_ablation_diffusion.sh <VARIANT>`。

#### 步骤二:批量 Holdout + 跨域测试

```bash
# 全部 31 variant × 4 ckpt × 6 数据集 ≈ 744 次推理
bash scripts/batch_test_cta_ablation_diffusion.sh

# 只跑 Group M
bash scripts/batch_test_cta_ablation_diffusion.sh --group M

# 只测三个未见家族,跳过跨域数据集
bash scripts/batch_test_cta_ablation_diffusion.sh --datasets ours_sadtalker ours_edtalk ours_float

# 缩到 best+last,加速一倍
bash scripts/batch_test_cta_ablation_diffusion.sh --num-top 1

# 只看会跑哪些组合,不真测
bash scripts/batch_test_cta_ablation_diffusion.sh --dry-run
```

输出目录:`outputs/cta_test_result/diffusion_ablation_<时间戳>/`,结构:

```
diffusion_ablation_<TS>/
├── results.csv                          ← 长表汇总,17 列,每行 (variant, ckpt, dataset)
├── logs/<variant>__<kind>__<dataset>.log
└── runs/<variant>/<kind>__<dataset>__<ts>/
    ├── test_predictions.csv             ← per-sample 预测
    ├── test_predictions_fairness.csv    ← 仅 ours_* 三家族数据集才有
    └── hydra/  tb/  wandb/
```

#### 数据集 → hydra 配置映射(参考)

| `--datasets` 名字 | 实际加载的 yaml | 样本规模 | Fairness 列 |
|---|---|---|---|
| `ours_sadtalker` | `fairtalking_test_sadtalker` | 291 real + 290 fake | ✅ |
| `ours_edtalk`    | `fairtalking_test_edtalk`    | 291 real + 290 fake | ✅ |
| `ours_float`     | `fairtalking_test_float`     | 291 real + 290 fake | ✅ |
| `thb`            | `fairtalking_thb`            | THB test split | ❌ |
| `ff++`           | `fairtalking_ffpp`           | FF++ test | ❌ |
| `mmdf`           | `fairtalking_mmdf`           | 2438 real + 2438 fake | ❌ |

#### 解读建议(消融视角)

* **A1_full 在三个未见家族 AUC** → 完整 CTA 的"跨家族泛化能力"。三个家族都 > 0.85 才说明方法不依赖 diffusion-specific artifact。
* **A4_asym_only / A5_pooled_only 对比** → 验证 asym score 是不是承担了泛化能力。如果 A4 在 holdout 上明显高于 A5,说明 asym 是泛化的真正驱动。
* **M3_intra_modal / M4_noise_target** 在 holdout 上理应**显著下降**(它们在 in-distribution 还行,但本来就没真正学跨模态预测)。如果观察到这个 pattern,说明跨模态预测设计在跨家族泛化里起到了关键作用。
* **thb / ff++ AUC** → 即使家族层面学到了通用特征,跨数据集源(不同压缩、不同分辨率)依旧难。这两个是更严苛的考验。

更详细的章节(包括 4b.1~4b.5)见 `CTA_ABLATION_README.md`。

## Project structure

```
fairtalking-second-work/
├── configs/              # Hydra configs
│   ├── train.yaml        # top-level
│   ├── data/
│   ├── method/           # cta.yaml, psm.yaml, radr.yaml
│   ├── backbone/
│   └── trainer/
├── src/
│   ├── data/             # dataset, dataloader, transforms
│   ├── models/           # backbones + method modules
│   ├── methods/          # lightning modules for cta / psm / radr
│   ├── losses/
│   ├── eval/             # 4 protocol runners
│   └── utils/
├── scripts/
│   ├── prepare_audio.sh
│   ├── prepare_hdtf_paired_audio.sh   # 联合训练前抽取 HDTF-paired 的 wav
│   ├── prepare_hdtf_splits.py
│   ├── train_cta.sh
│   ├── train_cta_combined.sh          # 联合训练:ours train + HDTF-paired
│   ├── train_cta_diffusion.sh         # diffusion-only 训练入口
│   ├── train_cta_diffusion_combined.sh # diffusion-only + HDTF diffusion 子集
│   ├── batch_test_diffusion_holdout.sh # 训完后跑 3 个未见家族 holdout 评测
│   ├── train_cta_ablation_diffusion.sh # 单 variant 的 diffusion-only 训练
│   ├── run_all_ablations_diffusion.sh  # 全 31 variant 的 diffusion-only 训练
│   ├── batch_test_cta_ablation_diffusion.sh # 全 variant × 6 数据集 holdout 评测
│   ├── train_psm.sh
│   ├── train_radr.sh
│   └── eval_all.sh
├── tools/                # small utilities, debugging
├── outputs/              # checkpoints & logs (gitignored)
├── requirements.txt
└── README.md
```

## Server notes

* No conda; everything is `pip3 install --user`.
* Server recycles every 3 days — training is always resumable via Lightning
  checkpoints (saved every epoch to `outputs/<method>/version_N/checkpoints/`).
* To resume: re-run the same `bash scripts/train_*.sh` — Hydra + Lightning
  auto-detect the last checkpoint in the run directory.

## Environment variables

Copy `.env.example` to `.env` and fill in.

```
DATA_ROOT=/apdcephfs_gy4/share_303628665/joywu/dataset/FairTalking-Bench
HDTF_PAIRED_ROOT=/apdcephfs_gy5/share_303628665/joyewu/HDTF-paird   # 联合训练用,普通训练可不设
OUTPUT_ROOT=./outputs
HF_HOME=~/.cache/huggingface
WANDB_API_KEY=
WANDB_MODE=offline          # switch to 'online' when you want sync
NUM_WORKERS=8
```