Upload docs/ANNOTATION_GUIDELINE.md with huggingface_hub

docs/ANNOTATION_GUIDELINE.md

@@ -0,0 +1,272 @@
+# TopoSlots 动作文本标注规范
+
+## 1. 背景与目标
+
+### 当前标注状况
+
+| 数据集 | Motions | 已有文本 | 缺失情况 |
+|--------|:-------:|:-------:|---------|
+| HumanML3D | 14,449 | 44,970 条 | ✅ 完整（多条/动作） |
+| Truebones Zoo | 1,110 | 888 条 | ⚠ 部分缺失（222条无文本），且标注来自 VLM 自动生成 |
+| LAFAN1 | 77 | 0 | ❌ 完全缺失 |
+| 100Style | 810 | 0 | ❌ 只有风格标签（如 "ShieldedRight"），无动作描述 |
+| Bandai Namco | 3,053 | 0 | ❌ 完全缺失 |
+| CMU MoCap | 2,496 | 0 | ❌ 完全缺失 |
+| Mixamo | 2,453 | 0 | ❌ 只有哈希文件名，无语义信息 |
+
+### 标注目标
+
+为缺失文本的动作补充统一格式的中文/英文双语标注，用于：
+1. **文本条件动作生成**（text-to-motion generation）
+2. **文本-动作检索**（text-motion retrieval）
+3. **跨骨架语义对齐**（cross-skeleton semantic alignment）
+
+---
+
+## 2. 标注格式规范
+
+### 2.1 文件组织
+
+每个动作对应一个 JSON 标注文件，命名与 motion npz 文件一致：
+
+```
+annotations/
+├── humanml3d/          # 已有标注，转换为统一格式
+├── lafan1/
+│   ├── 000000.json
+│   └── ...
+├── 100style/
+├── bandai_namco/
+├── cmu_mocap/
+├── mixamo/
+└── truebones_zoo/
+    ├── Dog_0000.json
+    └── ...
+```
+
+### 2.2 JSON Schema
+
+```json
+{
+  "motion_id": "000000",
+  "dataset": "lafan1",
+  "skeleton_type": "human",
+  "skeleton_id": "lafan1",
+  "species": "human",
+  "num_joints": 22,
+  "num_frames": 196,
+  "fps": 20,
+  "duration_sec": 9.8,
+
+  "captions": {
+    "short": {
+      "zh": ["一个人向前走了几步然后停下。"],
+      "en": ["A person walks forward a few steps then stops."]
+    },
+    "detailed": {
+      "zh": ["一个人从静止状态开始，先迈出左脚向前走了三步，步伐平稳，双臂自然摆动，然后逐渐减速停在原地。"],
+      "en": ["A person starts from a standing position, takes three steps forward beginning with the left foot, walks with steady pace and natural arm swing, then gradually decelerates to a stop."]
+    }
+  },
+
+  "labels": {
+    "action_category": "locomotion",
+    "action_subcategory": "walk",
+    "style": null,
+    "intensity": "normal",
+    "locomotion_type": "forward",
+    "has_contact": true,
+    "contact_type": ["foot_ground"]
+  },
+
+  "body_parts_involved": ["legs", "arms", "spine"],
+
+  "annotation_source": "manual",
+  "annotator_id": null,
+  "annotation_date": null
+}
+```
+
+### 2.3 字段说明
+
+#### 必填字段
+
+| 字段 | 类型 | 说明 | 示例 |
+|------|------|------|------|
+| `motion_id` | str | 与 npz 文件名对应 | `"000000"`, `"Dog_0000"` |
+| `dataset` | str | 数据集来源 | `"lafan1"`, `"truebones_zoo"` |
+| `skeleton_type` | str | 骨架大类 | `"human"`, `"quadruped"`, `"flying"`, `"reptile"`, `"insect"`, `"snake"`, `"fantasy"` |
+| `species` | str | 具体物种/角色 | `"human"`, `"dog"`, `"eagle"`, `"trex"` |
+| `captions.short.en` | list[str] | 英文简短描述（1-2句） | |
+| `captions.short.zh` | list[str] | 中文简短描述（1-2句） | |
+
+#### 推荐字段
+
+| 字段 | 类型 | 说明 |
+|------|------|------|
+| `captions.detailed.en` | list[str] | 英文详细描述（包含时序、身体部位、运动细节） |
+| `captions.detailed.zh` | list[str] | 中文详细描述 |
+| `labels.action_category` | str | 动作大类（见下表） |
+| `labels.action_subcategory` | str | 动作子类 |
+| `labels.style` | str | 风格标签（如 "angry", "sneaky"） |
+| `body_parts_involved` | list[str] | 参与的身体部位 |
+
+---
+
+## 3. 标注内容指南
+
+### 3.1 动作类别体系
+
+#### 人类动作类别
+
+| 大类 `action_category` | 子类 `action_subcategory` 示例 |
+|----------------------|------------------------------|
+| `locomotion` | walk, run, jog, sprint, crawl, sidestep, backward_walk |
+| `upper_body` | wave, point, reach, grab, throw, push, pull, clap |
+| `full_body` | jump, squat, lunge, stretch, bend, twist, turn |
+| `dance` | ballet, hip_hop, freestyle, waltz |
+| `sport` | kick, punch, swing, block, dodge |
+| `daily_activity` | sit_down, stand_up, pick_up, put_down, open_door |
+| `interaction` | handshake, hug, fight, carry |
+| `transition` | idle, t_pose, rest, fall, get_up |
+
+#### 动物动作类别
+
+| 大类 `action_category` | 子类示例 |
+|----------------------|---------|
+| `locomotion` | walk, run, gallop, trot, slither, fly, swim, hop, crawl |
+| `combat` | attack, bite, claw, charge, headbutt, sting |
+| `idle` | stand, sit, lie_down, sleep, breathe, look_around |
+| `expression` | roar, bark, hiss, chirp, howl, growl |
+| `interaction` | eat, drink, dig, scratch, groom, play |
+| `special` | fly_takeoff, fly_land, dive, jump, roll, shake |
+
+### 3.2 描述撰写规范
+
+#### 简短描述 (short)
+- **1-2 句话**，概括动作核心语义
+- 必须包含：**动作主体** + **核心动作** + **方向/方式**（如有）
+- 人类动作：以 "一个人..." / "A person..." 开头
+- 动物动作：以 "一只[动物]..." / "A [animal]..." 开头
+
+**好的示例**：
+```
+en: "A person walks forward steadily then turns left."
+zh: "一个人平稳地向前走然后左转。"
+
+en: "A dog leaps forward and snaps its jaws in an attack."
+zh: "一只狗向前扑跳并张嘴撕咬进行攻击。"
+```
+
+**不好的示例**：
+```
+❌ "Walking." — 太简短，缺少主体和细节
+❌ "The motion data shows a bipedal character performing locomotion in the XZ plane." — 太技术化
+❌ "一段动画" — 无信息量
+```
+
+#### 详细描述 (detailed)
+- **2-4 句话**，包含时序信息和身体部位细节
+- 描述顺序：**起始姿态 → 主要动作 → 结束状态**
+- 包含：速度、幅度、哪些身体部位参与、是否有接触
+
+**好的示例**：
+```
+en: "A person starts from a standing position with arms at their sides. They bend their knees
+and lower into a deep squat, keeping their back straight. After holding briefly, they push
+upward explosively into a small jump, landing softly on both feet."
+
+zh: "一个人从自然站立姿势开始，双臂自然下垂。然后弯曲膝盖向下蹲至深蹲位置，保持背部挺直。
+短暂停顿后，爆发性地向上推起做一个小跳跃，双脚轻柔落地。"
+```
+
+### 3.3 多条标注要求
+
+每个动作 **至少 2 条** 不同的简短描述，保持：
+- 用词不同但语义相同（如 "走路" vs "行走"，"walk" vs "stroll"）
+- 不同粒度的关注点（如一条描述整体动作，一条描述细节）
+
+参考 HumanML3D 的做法：每个动作有 3-5 条不同标注者的描述。
+
+### 3.4 跨骨架一致性
+
+**关键原则**：相同语义的动作，在不同骨架上的描述应该可以匹配。
+
+例如，"向前走" 的描述应在以下情况通用：
+- HumanML3D (22 joints, SMPL) 的人类行走
+- LAFAN1 (22 joints, Ubisoft) 的人类行走
+- Dog (55 joints, Truebones) 的狗行走
+- Horse (79 joints, Truebones) 的马行走
+
+描述应聚焦于 **语义动作**（"向前走"）而非 **关节/骨骼细节**（"left_knee flexion 45°"）。
+
+---
+
+## 4. 标注流程
+
+### 4.1 已有标注转换
+
+| 来源 | 转换方式 |
+|------|---------|
+| HumanML3D texts | 解析 `text#tokens#start#end` 格式 → JSON |
+| Truebones Zoo captions | 已有 JSON，提取 `short.original` → `captions.short.en`，缺 zh |
+| 100Style style labels | 文件名解析（如 `Angry_FW.bvh` → action=walk, style=angry） |
+
+### 4.2 缺失标注补充
+
+**推荐流程**：
+
+1. **VLM 自动标注**（初稿）
+   - 渲染动作骨架视频（stick figure）
+   - 使用 VLM（如 Qwen2.5-VL、GPT-4o）生成描述
+   - NECromancer 就是用 Qwen2.5-VL 做的自动标注
+
+2. **人工审核**（修正）
+   - 检查自动标注的准确性
+   - 补充中文翻译
+   - 修正错误描述（特别是动物动作）
+
+3. **质量控制**
+   - 每条标注由至少 1 人审核
+   - 不确定的动作标记为 `"annotation_source": "auto_vlm_unverified"`
+
+### 4.3 标注优先级
+
+| 优先级 | 数据集 | 理由 |
+|:------:|--------|------|
+| P0 | Truebones Zoo（缺失 222 条） | 论文核心卖点——多物种，且部分已有标注 |
+| P1 | LAFAN1 (77 条) | 高质量人类动画，数量少 |
+| P1 | 100Style (810 条) | 已有风格标签，只需扩展为句子 |
+| P2 | Bandai Namco (3,053 条) | 数量较多，可先自动标注 |
+| P2 | CMU MoCap (2,496 条) | 数量较多，CMU 有原始动作分类 |
+| P3 | Mixamo (2,453 条) | 文件名是哈希，需从原始 Mixamo 网站恢复动作名 |
+
+---
+
+## 5. 与相关工作的对比
+
+| 数据集 | 标注格式 | 标注方式 | 语言 | 每动作条数 |
+|--------|---------|---------|------|:---------:|
+| **HumanML3D** | `text#tokens#start#end` 纯文本 | 人工 (AMT) | 英文 | 3-5 |
+| **NECromancer UvU** | 自由文本 | VLM 自动 (Qwen2.5-VL) | 英文 | 1 |
+| **Truebones Zoo (t2m4lvo)** | JSON: short/detailed × original/paraphrase | VLM + 人工 | 英文 | 4-8 |
+| **TopoSlots (本项目)** | JSON: short/detailed × en/zh | VLM + 人工审核 | **中英双语** | ≥ 2 |
+
+### 我们的改进点
+1. **中英双语**：方便中文团队使用，也支持多语言检索
+2. **结构化标签**：`action_category` + `subcategory` + `style` 便于分类分析
+3. **骨架元信息**：`skeleton_type` + `species` 支持跨物种检索
+4. **标注来源追踪**：`annotation_source` 区分人工/自动标注质量
+
+---
+
+## 6. 验证标准
+
+标注完成后，需验证：
+
+- [ ] 每个动作至少 2 条 `short.en` 描述
+- [ ] 每个动作至少 1 条 `short.zh` 描述
+- [ ] `action_category` 字段填充率 > 95%
+- [ ] 动物动作的 `species` 字段全部正确
+- [ ] 随机抽样 100 条，人工检查描述与动作的一致性 > 90%
+- [ ] 文本-动作检索实验（TMR 评估）验证标注质量