File size: 10,843 Bytes
1bca0f8 9a42d4d 1bca0f8 6a98878 1bca0f8 87c5771 1bca0f8 0343241 1bca0f8 707d526 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 0343241 ba73931 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 87c5771 1bca0f8 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
---
license: cc-by-nc-sa-4.0
task_categories:
- robotics
tags:
- LeRobot
configs:
- config_name: default
data_files: FlattenFold/base/data/chunk-000/episode_000000.parquet
---
# KAI0
<div align="center">
<a href="">
<img src="https://img.shields.io/badge/GitHub-grey?logo=GitHub" alt="GitHub Badge">
</a>
<a href="https://mmlab.hk/research/kai0">
<img src="https://img.shields.io/badge/Research_Blog-grey?style=flat" alt="Research Blog Badge">
</a>
</div>
# TODO
- [ ] The advantage label will be coming soon.
## Contents
- [About the Dataset](#about-the-dataset)
- [Load the Dataset](#get-started)
- [Download the Dataset](#download-the-dataset)
- [Dataset Structure](#dataset-structure)
- [Folder hierarchy](#folder-hierarchy)
- [Details](#details)
- [License and Citation](#license-and-citation)
## [About the Dataset](#contents)
- **~134 hours** real world scenarios
- **Main Tasks**
- ***FlattenFold***
- Single task
- Initial state: T-shirts are randomly tossed onto the table, presenting random crumpled configurations
- Manipulation task: Operate the robotic arm to unfold the garment, then fold it
- ***HangCloth***
- Single task
- Initial state: Hanger is randomly placed, garment is randomly positioned on the table
- Manipulation task: Operate the robotic arm to thread the hanger through the garment, then hang it on the rod
- ***TeeShirtSort***
- Garment classification and arrangement task
- Initial state: Randomly pick a garment from the laundry basket
- Classification: Determine whether the garment is a T-shirt or a dress shirt
- Manipulation task:
- If it is a T-shirt, fold the garment
- If it is a dress shirt, expose the collar, then push it to one side of the table
- **Count of the dataset**
| Task | Base (episodes count/hours) | DAgger (episodes count/hours) | Total(episodes count/hours) |
|------|-----------------------------|-------------------------------|-----------------------------|
| FlattenFold | 3,055/~42 hours | 3,457/ ~13 Hours | 6,512 /~55 hours |
| HangCloth | 6954/~61 hours | 686/~12 hours | 7640/~73 hours |
| TeeShirtSort | 5988/~31 hours | 769/~22 hours | 6757/~53 hours |
| **Total** | **15,997/~134 hours** | **4,912/~47 hours** | **20,909/~181 hours** |
## [Load the dataset](#contents)
- This dataset was created using [LeRobot](https://github.com/huggingface/lerobot)
- The dataset's version is LeRobotDataset v2.1
### For LeRobot version < 0.4.0
Choose the appropriate import based on your version:
| Version | Import Path |
|------------------------|-------------|
| `<= 0.1.0` | `from lerobot.common.datasets.lerobot_dataset import LeRobotDataset` |
| `> 0.1.0` and `< 0.4.0` | `from lerobot.datasets.lerobot_dataset import LeRobotDataset` |
```python
# For version <= 0.1.0
from lerobot.common.datasets.lerobot_dataset import LeRobotDataset
# For version > 0.1.0 and < 0.4.0
from lerobot.datasets.lerobot_dataset import LeRobotDataset
# Load the dataset
dataset = LeRobotDataset(repo_id='where/the/dataset/you/stored')
```
### For LeRobot version >= 0.4.0
You need to migrate the dataset from v2.1 to v3.0 first. See the official documentation: [Migrate the dataset from v2.1 to v3.0](https://huggingface.co/docs/lerobot/lerobot-dataset-v3)
```bash
python -m lerobot.datasets.v30.convert_dataset_v21_to_v30 --repo-id=<HF_USER/DATASET_ID>
```
## [Download the Dataset](#contents)
### Python Script
```python
from huggingface_hub import hf_hub_download, snapshot_download
from datasets import load_dataset
# Download a single file
hf_hub_download(
repo_id="OpenDriveLab-org/kai0",
filename="episodes.jsonl",
subfolder="meta",
repo_type="dataset",
local_dir="where/you/want/to/save"
)
# Download a specific folder
snapshot_download(
repo_id="OpenDriveLab-org/kai0",
local_dir="/where/you/want/to/save",
repo_type="dataset",
allow_patterns=["data/*"]
)
# Load the entire dataset
dataset = load_dataset("OpenDriveLab-org/kai0")
```
### Terminal (CLI)
```bash
# Download a single file
hf download OpenDriveLab-org/kai0 \
--include "meta/info.json" \
--repo-type dataset \
--local-dir "/where/you/want/to/save"
# Download a specific folder
hf download OpenDriveLab-org/kai0 \
--repo-type dataset \
--include "meta/*" \
--local-dir "/where/you/want/to/save"
# Download the entire dataset
hf download OpenDriveLab-org/kai0 \
--repo-type dataset \
--local-dir "/where/you/want/to/save"
```
## [Dataset Structure](#contents)
### [Folder hierarchy](#contents)
Under each task directory, data is partitioned into two subsets: base and dagger.
- base
contains
original demonstration trajectories of robotic arm manipulation for garment arrangement tasks.
- dagger
contains on-policy recovery trajectories collected via iterative DAgger, designed to populate failure recovery modes absent in static demonstrations.
```text
Kai0-data/
├── FlattenFold/
│ ├── base/
│ │ ├── data/
│ │ │ ├── chunk-000/
│ │ │ │ ├── episode_000000.parquet
│ │ │ │ ├── episode_000001.parquet
│ │ │ │ └── ...
│ │ │ └── ...
│ │ ├── videos/
│ │ │ ├── chunk-000/
│ │ │ │ ├── observation.images.hand_left/
│ │ │ │ │ ├── episode_000000.mp4
│ │ │ │ │ ├── episode_000001.mp4
│ │ │ │ │ └── ...
│ │ │ │ ├── observation.images.hand_right/
│ │ │ │ │ ├── episode_000000.mp4
│ │ │ │ │ ├── episode_000001.mp4
│ │ │ │ │ └── ...
│ │ │ │ ├── observation.images.top_head/
│ │ │ │ │ ├── episode_000000.mp4
│ │ │ │ │ ├── episode_000001.mp4
│ │ │ │ │ └── ...
│ │ │ │ └── ...
│ │ │ └── ...
│ │ └── meta/
│ │ ├── info.json
│ │ ├── episodes.jsonl
│ │ ├── tasks.jsonl
│ │ └── episodes_stats.jsonl
│ └── dagger/
├── HangCloth/
│ ├── base/
│ └── dagger/
├── TeeShirtSort/
│ ├── base/
│ └── dagger/
└── README.md
```
<a id='Details'></a>
### [Details](#contents)
#### info.json
the basic struct of the [info.json](#meta/info.json)
```json
{
"codebase_version": "v2.1",
"robot_type": "agilex",
"total_episodes": ..., # the total episodes in the dataset
"total_frames": ..., # The total number of video frames in any single camera perspective
"total_tasks": ..., # Total number of tasks
"total_videos": ..., # The total number of videos from all camera perspectives in the dataset
"total_chunks": ..., # The number of chunks in the dataset
"chunks_size": ..., # The max number of episodes in a chunk
"fps": ..., # Video frame rate per second
"splits": { # how to split the dataset
"train": ...
},
"data_path": "data/chunk-{episode_chunk:03d}/episode_{episode_index:06d}.parquet",
"video_path": "videos/chunk-{episode_chunk:03d}/{video_key}/episode_{episode_index:06d}.mp4",
"features": {
"observation.images.top_head": { # the camera perspective
"dtype": "video",
"shape": [
480,
640,
3
],
"names": [
"height",
"width",
"channel"
],
"info": {
"video.height": 480,
"video.width": 640,
"video.codec": "av1",
"video.pix_fmt": "yuv420p",
"video.is_depth_map": false,
"video.fps": 30,
"video.channels": 3,
"has_audio": false
}
},
"observation.images.hand_left": { # the camera perspective
...
},
"observation.images.hand_right": { # the camera perspective
...
},
"observation.state": {
"dtype": "float32",
"shape": [
14
],
"names": null
},
"action": {
"dtype": "float32",
"shape": [
14
],
"names": null
},
"timestamp": {
"dtype": "float32",
"shape": [
1
],
"names": null
},
"frame_index": {
"dtype": "int64",
"shape": [
1
],
"names": null
},
"episode_index": {
"dtype": "int64",
"shape": [
1
],
"names": null
},
"index": {
"dtype": "int64",
"shape": [
1
],
"names": null
},
"task_index": {
"dtype": "int64",
"shape": [
1
],
"names": null
}
}
}
```
#### [Parquet file format](#contents)
| Field Name | shape | Meaning |
|------------|-------------|-------------|
| observation.state | [N, 14] |left `[:, :6]`, right `[:, 7:13]`, joint angle<br> left`[:, 6]`, right `[:, 13]` , gripper open range|
| action | [N, 14] |left `[:, :6]`, right `[:, 7:13]`, joint angle<br>left`[:, 6]`, right `[:, 13]` , gripper open range |
| timestamp | [N, 1] | Time elapsed since the start of the episode (in seconds) |
| frame_index | [N, 1] | Index of this frame within the current episode (0-indexed) |
| episode_index | [N, 1] | Index of the episode this frame belongs to |
| index | [N, 1] | Global unique index across all frames in the dataset |
| task_index | [N, 1] | Index identifying the task type being performed |
### [tasks.jsonl](#FlattenFold/meta/tasks.jsonl)
Contains task language prompts (natural language instructions) that specify the manipulation task to be performed. Each entry maps a task_index to its corresponding task description, which can be used for language-conditioned policy training.
# License and Citation
All the data and code within this repo are under [](). Please consider citing our project if it helps your research.
```BibTeX
@misc{,
title={},
author={},
howpublished={\url{}},
year={}
} |