add README

README.md

@@ -0,0 +1,155 @@
+# Zarr数据集格式说明
+
+本文档详细描述了生成的Zarr数据集的格式、字段含义和数据结构。
+
+## 📁 数据集类型
+
+本工具集生成两种类型的Zarr数据集：
+
+1. **Diffusion Policy (DP) 训练数据集** - 用于扩散策略训练
+2. **Masked Action Model (MAM) 训练数据集** - 用于掩码动作模型训练
+
+## 🎯 Diffusion Policy (DP) 数据集格式
+
+### **数据组织结构**
+
+```
+0901_PushCube_points_mask_dp.zarr/
+├── data/                           # 数据组
+│   ├── img1                        # 视角0图像数据
+│   ├── img2                        # 视角1图像数据
+│   ├── state                       # 当前帧状态数据
+│   ├── action                      # 下一帧动作数据
+│   └── condition                   # 基于points mask的全局数据
+└── meta/                           # 元数据组
+    └── episode_ends                # 轨迹结束索引（上界）
+```
+
+### **字段详细说明**
+
+#### **data/img1** - 视角0图像数据
+- **维度**: `(total_frames, C, H, W)`
+- **数据类型**: `uint8`
+- **说明**: 所有轨迹的视角0图像，按帧顺序拼接
+- **示例**: `(6970, 3, 512, 512)` 表示6970帧，3通道，512x512分辨率
+
+#### **data/img2** - 视角1图像数据
+- **维度**: `(total_frames, C, H, W)`
+- **数据类型**: `uint8`
+- **说明**: 所有轨迹的视角1图像，按帧顺序拼接
+- **示例**: `(6970, 3, 512, 512)` 表示6970帧，3通道，512x512分辨率
+
+#### **data/state** - 当前帧状态数据
+- **维度**: `(total_frames, 7)`
+- **数据类型**: `float32`
+- **说明**: 每一帧对应的机器人动作状态
+- **字段含义**:
+  - `[:, 0:3]`: 位置 (x, y, z)
+  - `[:, 3:6]`: 方向 (dx, dy, dz)
+  - `[:, 6]`: 夹爪状态 (gripper)
+
+#### **data/action** - 下一帧动作数据
+- **维度**: `(total_frames, 7)`
+- **数据类型**: `float32`
+- **说明**: 每一帧对应的下一帧动作（用于预测）
+- **字段含义**: 与state相同
+- **特殊处理**: 最后一帧的action使用自身值填充
+
+#### **data/condition** - 条件数据
+- **维度**: `(total_frames, max_length, 8)`
+- **数据类型**: `float32`
+- **说明**: 每一帧对应的完整轨迹条件mask数据
+- **字段含义**:
+  - `[:, :, 0:3]`: 位置序列 (x, y, z)
+  - `[:, :, 3:6]`: 方向序列 (dx, dy, dz)
+  - `[:, :, 6]`: 夹爪状态序列 (gripper) 0/1 表示开合/关闭
+  - `[:, :, 7]`: 时间序列 (time)
+
+#### **meta/episode_ends** - 轨迹结束索引
+- **维度**: `(num_trajectories,)`
+- **数据类型**: `int64`
+- **说明**: 每个轨迹在全局数组中的结束位置（累积索引）
+- **示例**: `[157, 310, 470, ...]` 表示第1个轨迹结束于第157帧，第2个轨迹结束于第310帧
+
+
+## 🎯 Masked Action Model (MAM) 数据集格式
+
+### **数据组织结构**
+
+```
+0901_PushCube_points_mask_mam.zarr/
+├── data/                           # 数据组
+│   ├── img1                        # 第0帧视角0图像
+│   ├── img2                        # 第0帧视角1图像
+│   ├── state                       # 第0帧状态数据
+│   ├── action                      # 完整轨迹动作数据
+│   └── MAS                         # 掩码动作序列
+└── meta/                           # 元数据组
+    └── episode_ends                # 轨迹有效长度
+```
+
+### **字段详细说明**
+
+#### **data/img1** - 第0帧视角0图像
+- **维度**: `(num_episodes, C, H, W)`
+- **数据类型**: `uint8`
+- **说明**: 每个轨迹的第0帧视角0图像
+- **示例**: `(100, 3, 512, 512)` 表示100个轨迹，3通道，512x512分辨率
+
+#### **data/img2** - 第0帧视角1图像
+- **维度**: `(num_episodes, C, H, W)`
+- **数据类型**: `uint8`
+- **说明**: 每个轨迹的第0帧视角1图像
+- **示例**: `(100, 3, 512, 512)` 表示100个轨迹，3通道，512x512分辨率
+
+#### **data/state** - 第0帧状态数据
+- **维度**: `(num_episodes, 7)`
+- **数据类型**: `float32`
+- **说明**: 每个轨迹第0帧的机器人动作状态
+- **字段含义**:
+  - `[:, 0:3]`: 位置 (x, y, z)
+  - `[:, 3:6]`: 方向 (dx, dy, dz)
+  - `[:, 6]`: 夹爪状态 (gripper)
+
+#### **data/action** - 完整轨迹动作数据
+- **维度**: `(num_episodes, max_length, 8)`
+- **数据类型**: `float32`
+- **说明**: 每个轨迹的完整动作序列，包含padding
+- **字段含义**:
+  - `[:, :, 0:3]`: 位置序列 (x, y, z)
+  - `[:, :, 3:6]`: 方向序列 (dx, dy, dz)
+  - `[:, :, 6]`: 夹爪状态序列 (gripper)
+  - `[:, :, 7]`: 时间序列 (time)
+- **Padding**: 不足max_length的部分用-1填充
+
+#### **data/MAS** - 掩码动作序列
+- **维度**: `(num_episodes, max_length, 8)`
+- **数据类型**: `float32`
+- **说明**: 每个轨迹对应的掩码动作序列（条件数据）
+- **字段含义**: 与action相同
+- **用途**: 作为模型的条件输入
+
+#### **meta/episode_ends** - 轨迹有效长度
+- **维度**: `(num_episodes,)`
+- **数据类型**: `int64`
+- **说明**: 每个轨迹的实际有效长度（不含padding）
+- **示例**: `[157, 153, 160, ...]` 表示第1个轨迹有157帧，第2个轨迹有153帧
+
+### **MAM数据集特点**
+
+- **轨迹级数据**: 每个字段都是轨迹级别的数据
+- **第0帧信息**: img1、img2、state都是第0帧的信息
+- **完整序列**: action和MAS包含完整的轨迹序列
+- **Padding处理**: 短轨迹用-1填充到max_length
+- **掩码训练**: MAS作为条件，action作为预测目标
+
+## 📊 数据维度对比
+
+| 字段 | DP数据集 | MAM数据集 | 说明 |
+|------|----------|-----------|------|
+| img1 | (total_frames, C, H, W) | (num_episodes, C, H, W) | DP: 所有帧；MAM: 第0帧 |
+| img2 | (total_frames, C, H, W) | (num_episodes, C, H, W) | DP: 所有帧；MAM: 第0帧 |
+| state | (total_frames, 7) | (num_episodes, 7) | DP: 每帧；MAM: 第0帧 |
+| action | (total_frames, 7) | (num_episodes, max_length, 8) | DP: 下一帧；MAM: 完整序列 |
+| condition/MAS | (total_frames, max_length, 8) | (num_episodes, max_length, 8) | 条件数据 |
+| episode_ends | (num_trajectories,) | (num_episodes,) | 索引/长度 |