docs/MMDF_Integration_Guide.md

# MMDF数据集集成指南

本文档提供了将新数据集（如MMDF）集成到FairTalking测试框架的完整流程。

## 快速开始

### 1. 下载数据集
```bash
# 设置Hugging Face token
export HUGGINGFACE_HUB_TOKEN=<YOUR_HF_TOKEN>

# 只下载test目录的内容
cd /apdcephfs_gy4/share_303628665/joywu/dataset
python -c "
from huggingface_hub import snapshot_download
snapshot_download(
    repo_id='zaqxsw0526/MMDF',
    repo_type='dataset',
    local_dir='MMDF_test_only',
    allow_patterns=['test/*']
)
"
```

### 2. 解决磁盘配额问题
```bash
# 运行修复脚本（推荐）
bash scripts/fix_disk_space.sh

# 或者直接使用gy8版本的测试脚本
bash scripts/test_cta_mmdf_gy8.sh
```

## 完整集成流程

### 步骤1：创建数据配置文件

在 `configs/data/` 目录下创建新的配置文件，参考 `fairtalking_thb.yaml` 的结构：

```yaml
# 配置文件示例：fairtalking_newdataset.yaml
name: fairtalking_newdataset

# 主数据集配置
root: ${oc.env:DATA_ROOT,/apdcephfs_gy4/share_303628665/joywu/dataset/FairTalking-Bench}

# 新数据集配置
use_newdataset_test: true
newdataset_root: ${oc.env:NEWDATASET_ROOT,/apdcephfs_gy4/share_303628665/joywu/dataset/NEWDATASET}
newdataset_generators:
  - generator1
  - generator2
```

### 步骤2：创建测试脚本

在 `scripts/` 目录下创建测试脚本：

```bash
#!/usr/bin/env bash
# scripts/test_cta_newdataset.sh

CKPT="${1:-outputs/cta/checkpoints/last.ckpt}"

python3 src/train.py \
    method=cta \
    data=fairtalking_newdataset \
    trainer=ddp \
    backbone=timesformer \
    +test_only=true \
    +test_ckpt="$CKPT" \
    "$@"
```

### 步骤3：更新批量测试脚本

在 `scripts/batch_test_all.sh` 中添加新数据集：

```bash
# 在DATASET_NAMES数组中添加新数据集
DATASET_NAMES=("ours" "thb" "ff++" "hdtf" "newdataset")

# 在case语句中添加新数据集的脚本路径
case "$dataset" in
    "newdataset")
        script="scripts/test_${method}_newdataset.sh"
        ;;
esac
```

## 数据集目录结构要求

新数据集应遵循以下结构：

```
NEWDATASET/
├── test/
│   ├── fake/
│   │   ├── generator1/
│   │   │   └── *.mp4 (视频文件)
│   │   └── generator2/
│   │       └── *.mp4
│   └── real/ (可选)
│       └── *.mp4
```

## 磁盘空间管理

### 可用空间检查
```bash
# 检查各个挂载点的空间使用情况
df -h | grep apdcephfs
```

### 空间优化策略

1. **使用符号链接**：将大文件目录链接到有空间的挂载点
2. **清理临时文件**：定期清理Hydra输出和Python缓存
3. **使用替代位置**：在有空间的目录中运行测试

### 快速清理命令
```bash
# 清理Hydra输出
find outputs -name "hydra" -type d -exec rm -rf {} +

# 清理Python缓存
find . -name "__pycache__" -type d -exec rm -rf {} +

# 清理日志文件
find . -name "*.log" -type f -delete
```

## 故障排除

### 常见错误及解决方案

#### 错误1：Disk quota exceeded
```bash
# 解决方案1：使用符号链接
bash scripts/fix_disk_space.sh

# 解决方案2：在gy8运行
bash scripts/test_cta_mmdf_gy8.sh

# 解决方案3：禁用Hydra输出
HYDRA_FULL_ERROR=1 python3 src/train.py ... hydra.output_subdir=null
```

#### 错误2：Checkpoint not found
```bash
# 确保checkpoint路径正确
ls -la outputs/cta/checkpoints/

# 如果不存在，从训练目录复制
cp -r /path/to/training/outputs/cta/checkpoints outputs/cta/
```

#### 错误3：数据集路径错误
```bash
# 检查数据集目录结构
ls -la /apdcephfs_gy4/share_303628665/joywu/dataset/MMDF_test_only/

# 确保配置文件中的路径正确
cat configs/data/fairtalking_mmdf.yaml | grep mmdf_root
```

## 性能优化建议

1. **批量测试**：使用 `scripts/batch_test_all.sh` 进行批量测试
2. **并行处理**：适当调整 `num_workers` 参数
3. **缓存管理**：合理设置音频缓存目录
4. **内存优化**：根据GPU内存调整 `batch_size`

## 扩展功能

### 添加新的评估指标
在数据配置文件中添加：
```yaml
# 自定义评估指标
eval_metrics:
  - accuracy
  - auc
  - f1_score
  - precision
  - recall
```

### 支持多模态数据
```yaml
# 多模态数据支持
modalities:
  - video
  - audio
  - text (可选)
```

## 维护和更新

定期检查：
- 数据集版本更新
- 配置文件兼容性
- 测试脚本功能
- 磁盘空间使用情况

---

**注意**：本指南适用于任何新数据集的集成，只需替换数据集名称和路径即可。