README.zh-CN.md

# SMP-FSAVC 数据划分与语义提示

[English](README.md) · [SMP 代码](https://github.com/DennisHgj/SMP_FSAVC) · [论文](https://ieeexplore.ieee.org/abstract/document/11352954) · [DOI](https://doi.org/10.1109/TASLPRO.2026.3654246)

本仓库公开论文 **Semantic Modulated Prompting for Few-Shot Audio-Visual
Classification**（SMP-FSAVC）使用的源域/目标域类别划分、训练测试样本列表，以及
由 mPLUG-2 生成的语义提示。仓库可以同时发布到 GitHub 和 Hugging Face Hub：
保留无表头的原始 CSV 供训练代码直接读取，并提供等价的 Parquet 文件用于
Hugging Face Dataset Viewer 在线预览。

本仓库不包含视频、音频或抽取后的图像帧。使用者需要从各原始数据集获取媒体，
并遵守其许可和使用条款。

## 数据规模

| 数据集 | 样本数 | 源域类别 | 目标域类别 | 说明 |
| --- | ---: | ---: | ---: | --- |
| AVE | 4,051 | 16 | 12 | 共定义 28 类 |
| Kinetics-Sounds | 22,908 | 19 | 13 | 共定义 32 类 |
| VGGSound100 | 59,795 | 定义 60 类 / 实际 59 类 | 40 | 源域标签 14 在本快照中无可获取媒体 |
| **合计** | **86,754** |  |  |  |

研究目录中的 VGGSound100 `train_caption.csv` 和 `test_caption.csv` 分别是四个
正式划分文件的精确并集，因此不再重复发布。

## 划分含义

| CSV 文件 | Hugging Face split | 用途 |
| --- | --- | --- |
| `pretrain.csv` | `source_train` | 源域预训练 |
| `pretrain_test.csv` | `source_test` | 源域测试 |
| `fewshot.csv` | `target_train_pool` | 目标域支持集采样池 |
| `fewshot_test.csv` | `target_test` | 目标域查询/测试集 |

`fewshot.csv` 不是一个固定的 K-shot episode；论文协议会从该池中多次抽取
N-way K-shot 支持集。

## 文件结构与格式

`csv/` 保存原始无表头 CSV；`viewer/` 保存逐行等价的 Parquet；`metadata/`
保存标签映射、统计、caption 生成配置和 SHA-256 校验值。

AVE 的 CSV 每行三列：

```text
clip_id,integer_label,semantic_prompt
```

Kinetics-Sounds 和 VGGSound100 每行四列：

```text
clip_id,integer_label,semantic_prompt,class_name
```

当 caption 或类别名包含逗号时，CSV 使用标准引号转义。Parquet 统一提供
`clip_id`、`label`、`semantic_prompt`、`class_name` 四个具名字段；AVE 的
`class_name` 由 `clip_id` 的类别后缀推导。完整类别映射见
[`metadata/label_maps.json`](metadata/label_maps.json)。

## 语义提示

公开的 `semantic_prompt` 使用
[mPLUG-2](https://github.com/X-PLUG/mPLUG-2) 的 MSVD 视频 caption checkpoint
从视觉帧生成。保留的主要设置为：16 帧、224×224、ViT-L/14、beam size 5、
输出长度 4–20、随机种子 42。完整的重建配置及复现限制见
[`metadata/generation_config.yaml`](metadata/generation_config.yaml)。

SMP 同时允许使用静态提示。使用者可将每条样本的第三列替换为：

```python
static_prompt = "a video of [label]"
```

这里的 `[label]` 是固定的字面文本，不会替换成样本标签或类别名；每个样本使用的
字符串完全相同。

为避免数据重复，本仓库只发布论文实验使用的生成式 caption，不另存一份静态提示文件。

## 加载与校验

克隆仓库后，可直接加载 Parquet：

```python
from datasets import load_dataset

ave = load_dataset(
    "parquet",
    data_files={
        "source_train": "viewer/AVE/pretrain.parquet",
        "source_test": "viewer/AVE/pretrain_test.parquet",
        "target_train_pool": "viewer/AVE/fewshot.parquet",
        "target_test": "viewer/AVE/fewshot_test.parquet",
    },
)
```

校验所有发布文件：

```bash
python scripts/verify_release.py
```

重新验证 CSV 并生成 Parquet 和元数据：

```bash
python -m pip install -r requirements-build.txt
python scripts/build_release.py
```

构建脚本会检查行数、列数、空字段、重复 ID、标签覆盖、类别名一致性及四个划分之间
的数据泄漏；脚本不会改写原始 CSV。

## 局限性

- caption 是模型生成的描述，不是真值标注，可能出现幻觉、遗漏、偏见，或与类别标签不一致。
- 样本数反映研究时可获得并完成处理的媒体快照。YouTube 视频可能失效，后来重新下载时不一定能得到相同媒体集合。
- VGGSound100 源域标签 `14`（`subway, metro`）因原始视频无法获取而没有样本；
  为兼容训练代码，源域标签空间仍保留为 `0..59`。
- 原始 caption 数据加载器在均匀选帧前没有显式排序帧文件名，因此公开的配置能说明流程，
  但不能保证在新的文件系统快照上逐字节复现 caption。
- 在敏感应用中使用前，请人工检查模型生成文本与原始媒体是否适用。

纠错或移除请求请参见 [DATA_REMOVAL.md](DATA_REMOVAL.md)。

## 许可

本仓库只发布派生标注和标识符，不发布媒体。完整的分层许可说明见
[LICENSE_DATA.md](LICENSE_DATA.md)：在作者拥有权利的范围内，发布者创建的数据划分、
生成式提示与元数据采用 CC BY 4.0；原始标识符和标签仍受上游数据集条款约束，视频版权
仍属于原始权利人。

## 引用

如使用这些划分或语义提示，请引用 SMP 论文，并引用实验涉及的原始数据集。

```bibtex
@ARTICLE{11352954,
  author={Huang, Guanjie and Cui, Yawen and Tsang, Danny H.K. and Wang, Wenwu and Liu, Li},
  journal={IEEE Transactions on Audio, Speech and Language Processing},
  title={Semantic Modulated Prompting for Few-Shot Audio-Visual Classification},
  year={2026},
  volume={34},
  pages={723-736},
  doi={10.1109/TASLPRO.2026.3654246}
}
```

AVE、Kinetics/Kinetics-Sounds、VGGSound 和 mPLUG-2 的 BibTeX 已集中放在
[英文 README](README.md#citation) 中。