embodied_dataset/README.md

embodied_dataset

本目录用于存放具身智能机器人采集数据。当前数据集采用 LeRobot v3.0 格式，后续新增采集批次、任务或机器人数据时，应尽量沿用本 README 定义的目录结构、字段命名、采样频率和质量检查标准，保证其他人可以按同一规范复现采集和训练。

当前数据集

• 任务：抓取桌面上的网球，并放入目标区域。
• 任务文本：Pick up the tennis ball and place it in the target area.
• 机器人类型：so_follower
• 数据格式：LeRobot v3.0
• episode 数量：100
• 总帧数：21187
• 采样频率：30 FPS
• 图像分辨率：480 x 640 x 3
• 视频视角：observation.images.overhead、observation.images.wrist
• 动作维度：6
• 状态维度：6

目录结构

embodied_dataset/
├── data/
├── meta/
└── videos/
    └── observation.images.wrist/

路径模板必须和 meta/info.json 保持一致：

data_path  = embodied_dataset/data/chunk-{chunk_index:03d}/file-{file_index:03d}.parquet
video_path = embodied_dataset/videos/{video_key}/chunk-{chunk_index:03d}/file-{file_index:03d}.mp4

帧数据格式

data/chunk-xxx/file-xxx.parquet 保存逐帧机器人数据。当前 schema 如下：

字段	类型	形状	含义
action	float32 list	[6]	当前帧对应的控制动作
observation.state	float32 list	[6]	当前帧机器人观测状态
timestamp	float32	[1]	当前 episode 内的时间戳，单位为秒
frame_index	int64	[1]	当前 episode 内的帧序号，从 0 开始
episode_index	int64	[1]	全数据集 episode 序号，从 0 开始
index	int64	[1]	全数据集全局帧序号
task_index	int64	[1]	任务编号，对应 meta/tasks.parquet

action 和 observation.state 的 6 个关节字段顺序必须固定：

shoulder_pan.pos
shoulder_lift.pos
elbow_flex.pos
wrist_flex.pos
wrist_roll.pos
gripper.pos

后续采集必须保持相同的字段顺序、单位和数值含义。若更换机器人、关节数量、单位或控制模式，必须新建清晰的字段名，并同步更新 meta/info.json、stats.json 和 README。

视频数据格式

当前数据集包含两个视频观测键：

video key	分辨率	FPS	编码	说明
observation.images.overhead	480 x 640	30	AV1 / MP4	顶部视角，观察桌面、目标物和目标区域
observation.images.wrist	480 x 640	30	AV1 / MP4	腕部视角，观察夹爪附近目标

采集时必须保证：

• 每个 episode 的视频和 Parquet 帧时间对齐。
• 同一个 episode 下所有相机的起止时间一致，或在 meta/episodes 中明确记录 from_timestamp 和 to_timestamp。
• 视频不包含音频。
• 图像方向、相机安装位置、曝光和焦距尽量固定；如果调整相机位置，需要记录在新增数据说明中。

元数据格式

meta/info.json 是数据集入口配置，必须记录：

• codebase_version：当前为 v3.0
• robot_type：当前为 so_follower
• total_episodes
• total_frames
• total_tasks
• fps
• splits
• data_path
• video_path
• features

meta/tasks.parquet 保存任务索引。每个任务必须有稳定的 task_index 和任务文本。当前只有一个任务：

task_index = 0
task = Pick up the tennis ball and place it in the target area.

meta/episodes/chunk-xxx/file-xxx.parquet 保存 episode 级索引和统计信息，至少应包含：

• episode_index
• tasks
• length
• data/chunk_index
• data/file_index
• dataset_from_index
• dataset_to_index
• 每个视频 key 对应的 chunk_index、file_index、from_timestamp、to_timestamp
• 每个关键字段的 episode 级统计值，例如 min、max、mean、std、q01、q10、q50、q90、q99

meta/stats.json 保存全数据集统计信息。新增或删除 episode 后必须重新生成。

采集标准

按以下流程采集新数据：

1. 确定任务定义。

   • 每个任务写成一句明确的英文指令，便于后续直接用于模仿学习或多任务训练。
   • 同一任务不要频繁改写文本；如果任务目标变化，应新增 task_index。

2. 固定硬件和场景。

   • 记录机器人型号、相机视角、相机分辨率、FPS、目标物、桌面布局和目标区域。
   • 当前标准为 SO101 follower、30 FPS、两路 480 x 640 RGB 视频。

3. 逐 episode 采集。

   • 每个 episode 从任务开始前的稳定状态开始录制。
   • 操作完成或失败后停止录制。
   • frame_index 在每个 episode 内从 0 开始递增。
   • timestamp 应从 0 附近开始，按 30 FPS 时间基准递增。
   • index 在整个数据集内全局连续递增。

4. 保存数据。

   • 机器人状态和动作保存到 data/chunk-xxx/file-xxx.parquet。
   • 视频保存到 videos/{video_key}/chunk-xxx/file-xxx.mp4。
   • episode 索引保存到 meta/episodes/chunk-xxx/file-xxx.parquet。
   • 大文件必须通过 Git LFS 管理。

5. 生成元数据。

   • 更新 meta/info.json 中的总数、路径模板和 features。
   • 更新 meta/tasks.parquet。
   • 更新 meta/episodes/。
   • 重新计算 meta/stats.json。

6. 做质量检查。

   • 视频能正常打开，画面方向正确，没有黑屏、严重卡顿或错位。
   • 每个 episode 的帧数、timestamp、视频时长基本匹配。
   • action 和 observation.state 没有 NaN、空数组或维度错误。
   • episode 成功/失败情况应在新增说明中记录；不要把明显损坏的数据混入正式训练集。

使用示例

from lerobot.datasets.lerobot_dataset import LeRobotDataset

dataset = LeRobotDataset(
    repo_id="vvzc/ChenLong_Embodied_Intelligence_Dataset",
)

print(dataset.num_episodes)
print(dataset.num_frames)

sample = dataset[0]
print(sample.keys())
print(sample["action"].shape)
print(sample["observation.state"].shape)

提交规范

• 新增 .parquet、.mp4、.pt、.png 等大文件前，确认仓库根目录 .gitattributes 已包含对应 LFS 规则。
• 每次新增采集数据时，README、meta/info.json、meta/stats.json、meta/tasks.parquet 和 meta/episodes/ 必须同步更新。
• 提交信息建议写清楚任务、批次和变更内容，例如 Add tennis ball collection episodes 48-60。