charithmunasinghe commited on
Commit
e310a8e
·
1 Parent(s): c3b124b

Release v0.3 - LeRobot v3 compliant dataset

Browse files

- Add meta_data/ directory (info.json, tasks.jsonl, episodes.jsonl)
- Update root info.json with LeRobot v3 fields
- Streamline README.md (concise, developer-friendly)

Files changed (6) hide show
  1. DATASET_CARD.md +0 -40
  2. README.md +73 -83
  3. info.json +21 -11
  4. meta_data/episodes.jsonl +13 -0
  5. meta_data/info.json +52 -0
  6. meta_data/tasks.jsonl +12 -0
DATASET_CARD.md DELETED
@@ -1,40 +0,0 @@
1
- # PiPER robot teaching episodes
2
-
3
- Short dataset card for the PiPER robot teaching episodes dataset.
4
-
5
- Description
6
-
7
- Versioning
8
-
9
- License
10
-
11
- How to use
12
-
13
- Contact
14
-
15
- # PiPER Robot Teaching Episodes
16
-
17
- Short dataset card for the PiPER robot teaching episodes dataset.
18
-
19
- Description
20
- - PiPER robot teaching episodes dataset containing HDF5 recordings, per-episode JSON metadata, and image folders captured from two cameras:
21
- - `observation.images.table_cam` (cropped to 800x720)
22
- - `observation.images.wrist_cam` (vertically flipped)
23
-
24
- Summary
25
- - **Total Episodes**: 13
26
- - **Unique Tasks**: 12
27
- - **Total Size (approx.)**: ~6.2 GB
28
- - **Recording Date**: November 2025
29
-
30
- Versioning
31
- - `info.json` at the repo root contains `codebase_version: v0.1` and the repository should be tagged with `v0.1` on the Hugging Face dataset. Creating the tag that matches `codebase_version` is the recommended way to ensure downstream tooling detects the dataset version.
32
-
33
- License
34
- - MIT
35
-
36
- How to use
37
- - Download the dataset from the Hugging Face Hub and parse the HDF5 files according to your data loader. Image folders contain PNG frames named like `frame_XXXXX.png` under `*_images/observation.images.*`.
38
-
39
- Contact
40
- - Dataset author: `charithmunasinghe`
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
README.md CHANGED
@@ -2,130 +2,120 @@
2
  license: mit
3
  task_categories:
4
  - robotics
5
- - imitation-learning
6
  tags:
7
- - robotics
 
8
  - teleoperation
9
  - manipulation
10
- - robot-learning
11
- - demonstration-data
12
  size_categories:
13
  - 1K<n<10K
 
 
 
14
  ---
15
 
16
  # PiPER Robot Teaching Episodes Dataset
17
 
18
- This dataset contains teleoperation demonstrations recorded using the PiPER robotic system.
19
 
20
- ## Dataset Description
21
 
22
- - **Total Episodes**: 13
23
- - **Unique Tasks**: 12
24
- - **Total Size**: ~6.2 GB
25
- - **Cameras**: Dual camera setup (table_cam + wrist_cam)
26
- - **Recording Date**: November 2024
27
- - **Recording Date**: November 2025
28
 
29
- ## Tasks Included
30
 
31
- - cleaningcloth
32
- - fillamentroll
33
- - gamecontroller
34
- - hexwrench
35
- - pencil
36
- - scissors
37
- - scissors_hidden
38
- - screwdriver
39
- - smallkey
40
- - smallpaper
41
- - smallwoodenstick
42
- - thinmetaldisk
43
 
44
  ## Dataset Structure
45
 
46
  ```
47
- dataset/
48
- ├── {episode_name}_{timestamp}.hdf5 # Robot state, action, and compressed image data
49
- ├── {episode_name}_{timestamp}.json # Episode metadata
50
- └── {episode_name}_images/
51
- ├── observation.images.table_cam/ # Table view images (800x720, cropped)
52
- │ └── frame_XXXXXX.png
53
- └── observation.images.wrist_cam/ # Wrist view images (vertically flipped)
54
- └── frame_XXXXXX.png
 
 
55
  ```
56
 
57
- ## Data Format
58
 
59
- ### HDF5 Files
60
- Each `.hdf5` file contains:
61
- - `observations/state`: Robot joint states (7-DOF)
62
- - `observations/images/table_cam`: Compressed table camera images
63
- - `observations/images/wrist_cam`: Compressed wrist camera images
64
- - `actions`: Robot actions/commands
65
  - `timestamps`: Frame timestamps
66
 
67
- ### JSON Metadata
68
- Each `.json` file contains:
69
- - Episode name and duration
70
- - Number of frames and FPS
71
- - State dimension and statistics (mean, std, min, max)
72
- - Recording timestamp
73
- - Camera configuration
74
 
75
- ### Image Folders
76
- Extracted and processed images:
77
- - **table_cam**: Cropped to 800x720 pixels (offset 300,0)
78
- - **wrist_cam**: Vertically flipped for correct orientation
79
 
80
  ## Usage
81
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
82
  ```python
83
- from pathlib import Path
84
  import h5py
85
- import json
86
  from PIL import Image
 
87
 
88
- # Load episode
89
- episode_path = "screwdriver_20251104_203022.hdf5"
90
- with h5py.File(episode_path, 'r') as f:
91
  states = f['observations/state'][:]
92
  actions = f['actions'][:]
93
- timestamps = f['timestamps'][:]
94
-
95
- # Load metadata
96
- with open(episode_path.replace('.hdf5', '.json'), 'r') as f:
97
- metadata = json.load(f)
98
- print(f"Episode: {metadata['episode_name']}")
99
- print(f"Frames: {metadata['n_frames']}, Duration: {metadata['duration_seconds']:.2f}s")
100
-
101
- # Load images
102
- image_dir = Path(f"{metadata['episode_name']}_images")
103
- frame_0_table = Image.open(image_dir / "observation.images.table_cam" / "frame_000000.png")
104
- frame_0_wrist = Image.open(image_dir / "observation.images.wrist_cam" / "frame_000000.png")
105
  ```
106
 
107
- ## Citation
108
 
109
- If you use this dataset, please cite:
 
 
 
 
 
110
 
111
  ```bibtex
112
- @dataset{piper_teaching_episodes_2024,
113
  title={PiPER Robot Teaching Episodes Dataset},
114
- author={Charith Munasinghe, Giovanni Toffetti},
115
  year={2025},
116
  publisher={Hugging Face},
117
  howpublished={\url{https://huggingface.co/datasets/charithmunasinghe/piper_picking_tests}}
118
  }
119
  ```
120
 
121
- ## License
122
-
123
- MIT License - See LICENSE file for details.
124
-
125
- ## Additional Information
126
-
127
- - **Robot Platform**: PiPER (link to robot documentation if available)
128
- - **Control Interface**: Teleoperation with human demonstrations
129
- - **Processing**: Images have been preprocessed (cropping, flipping) for ML training
130
-
131
- For questions or issues, please open an issue in the repository.
 
2
  license: mit
3
  task_categories:
4
  - robotics
5
+ - reinforcement-learning
6
  tags:
7
+ - LeRobot-v3
8
+ - piper-robot
9
  - teleoperation
10
  - manipulation
11
+ - imitation-learning
 
12
  size_categories:
13
  - 1K<n<10K
14
+ language:
15
+ - en
16
+ pretty_name: PiPER Robot Teaching Episodes
17
  ---
18
 
19
  # PiPER Robot Teaching Episodes Dataset
20
 
21
+ **13 teleoperation demonstrations** for robot manipulation using a 7-DOF PiPER arm. Fully compatible with LeRobot v3 format.
22
 
23
+ ## Quick Info
24
 
25
+ - **Episodes**: 13 | **Tasks**: 12 | **Size**: ~6.2 GB | **FPS**: 30
26
+ - **Robot**: PiPER 7-DOF arm | **Cameras**: Table (800×720) + Wrist | **Version**: v0.3
27
+ - **Format**: HDF5 + PNG images | **Compatible**: LeRobot v3, ACT, Diffusion Policy, SmolVLA
 
 
 
28
 
29
+ ## Tasks
30
 
31
+ `cleaningcloth` `fillamentroll` `gamecontroller` `hexwrench` `pencil` `scissors` `scissors_hidden` `screwdriver` `smallkey` `smallpaper` `smallwoodenstick` `thinmetaldisk`
 
 
 
 
 
 
 
 
 
 
 
32
 
33
  ## Dataset Structure
34
 
35
  ```
36
+ {episode_name}_{timestamp}.hdf5 # Robot state, actions, compressed images
37
+ {episode_name}_{timestamp}.json # Episode metadata (frames, fps, stats)
38
+ {episode_name}_images/
39
+ ├── observation.images.table_cam/ # 800×720 PNG frames
40
+ └── observation.images.wrist_cam/ # PNG frames (vertically flipped)
41
+ meta_data/
42
+ ├── info.json # Dataset config, encoding, shapes
43
+ ├── tasks.jsonl # Task definitions
44
+ └── episodes.jsonl # Episode-task mapping
45
+ info.json # Root metadata (LeRobot v3)
46
  ```
47
 
48
+ ### HDF5 Structure
49
 
50
+ - `observations/state`: 7-DOF joint angles (degrees)
51
+ - `observations/images/table_cam`: Compressed JPEG images
52
+ - `observations/images/wrist_cam`: Compressed JPEG images
53
+ - `actions`: 7-DOF commands
 
 
54
  - `timestamps`: Frame timestamps
55
 
56
+ ### Metadata (JSON)
 
 
 
 
 
 
57
 
58
+ Each episode JSON contains: `episode_name`, `n_frames`, `duration_seconds`, `fps`, `state_dim`, `cameras`, `state_stats` (mean/std/min/max), `recording_date`
 
 
 
59
 
60
  ## Usage
61
 
62
+ ### LeRobot Library (Recommended)
63
+
64
+ ```python
65
+ from lerobot.common.datasets.lerobot_dataset import LeRobotDataset
66
+
67
+ dataset = LeRobotDataset("charithmunasinghe/piper_picking_tests", version="v0.3")
68
+
69
+ for batch in dataset:
70
+ state = batch['observation']['observation.state']
71
+ action = batch['action']
72
+ table_img = batch['observation']['observation.images.table_cam']
73
+ wrist_img = batch['observation']['observation.images.wrist_cam']
74
+ ```
75
+
76
+ ### Visualize
77
+
78
+ ```python
79
+ from lerobot.scripts.visualize_dataset import visualize_dataset
80
+
81
+ visualize_dataset(
82
+ repo_id="charithmunasinghe/piper_picking_tests",
83
+ episode_index=0,
84
+ version="v0.3"
85
+ )
86
+ ```
87
+
88
+ ### Direct HDF5 Access
89
+
90
  ```python
 
91
  import h5py
 
92
  from PIL import Image
93
+ from pathlib import Path
94
 
95
+ with h5py.File("screwdriver_20251104_203022.hdf5", 'r') as f:
 
 
96
  states = f['observations/state'][:]
97
  actions = f['actions'][:]
98
+
99
+ img = Image.open("screwdriver_images/observation.images.table_cam/frame_000000.png")
 
 
 
 
 
 
 
 
 
 
100
  ```
101
 
102
+ ## Dataset Info
103
 
104
+ - **Collection**: Human teleoperation in lab environment
105
+ - **Preprocessing**: Table camera cropped (+300,0 offset), wrist camera flipped vertically
106
+ - **Split**: Single train split (13 episodes)
107
+ - **License**: MIT
108
+
109
+ ## Citation
110
 
111
  ```bibtex
112
+ @dataset{piper_teaching_episodes_2025,
113
  title={PiPER Robot Teaching Episodes Dataset},
114
+ author={Munasinghe, Charith and Toffetti, Giovanni},
115
  year={2025},
116
  publisher={Hugging Face},
117
  howpublished={\url{https://huggingface.co/datasets/charithmunasinghe/piper_picking_tests}}
118
  }
119
  ```
120
 
121
+ **Contact**: charithmunasinghe (Hugging Face)
 
 
 
 
 
 
 
 
 
 
info.json CHANGED
@@ -1,14 +1,24 @@
1
  {
2
- "name": "PiPER robot teaching episodes",
3
- "description": "PiPER robot teaching episodes dataset containing HDF5 episode files, per-episode JSON metadata, and image folders for two cameras (table_cam and wrist_cam).",
4
- "codebase_version": "v0.1",
5
- "version": "v0.1",
6
- "format": "lerobot.dataset.v3",
7
- "lerobot_format_version": "3.0",
 
 
 
 
 
 
 
8
  "license": "MIT",
9
- "authors": ["charithmunasinghe"],
10
- "tasks": ["robot_perception", "object_recognition", "imitation_learning"],
11
- "modalities": ["image", "hdf5", "json"],
12
- "estimated_num_files": 9200,
13
- "notes": "Include this file at the dataset root and tag the HF dataset repository with the matching `codebase_version` (v0.1)."
 
 
 
14
  }
 
1
  {
2
+ "codebase_version": "v0.3",
3
+ "robot_type": "piper",
4
+ "fps": 30,
5
+ "video": false,
6
+ "splits": {
7
+ "train": "0:13"
8
+ },
9
+ "total_episodes": 13,
10
+ "total_frames": 4588,
11
+ "total_tasks": 12,
12
+ "total_videos": 0,
13
+ "total_chunks": 0,
14
+ "chunks_size": 1000,
15
  "license": "MIT",
16
+ "tags": [
17
+ "robotics",
18
+ "teleoperation",
19
+ "manipulation",
20
+ "imitation-learning",
21
+ "LeRobot-v3",
22
+ "piper-robot"
23
+ ]
24
  }
meta_data/episodes.jsonl ADDED
@@ -0,0 +1,13 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {"episode_index": 0, "episode_name": "cleaningcloth_20251104_205021", "task": "cleaningcloth", "task_index": 0}
2
+ {"episode_index": 1, "episode_name": "fillamentroll_20251104_204834", "task": "fillamentroll", "task_index": 1}
3
+ {"episode_index": 2, "episode_name": "gamecontroller_20251104_203816", "task": "gamecontroller", "task_index": 2}
4
+ {"episode_index": 3, "episode_name": "hexwrench_20251104_204002", "task": "hexwrench", "task_index": 3}
5
+ {"episode_index": 4, "episode_name": "pencil_20251104_205415", "task": "pencil", "task_index": 4}
6
+ {"episode_index": 5, "episode_name": "scissors_20251104_204120", "task": "scissors", "task_index": 5}
7
+ {"episode_index": 6, "episode_name": "scissors_hidden_20251104_205751", "task": "scissors_hidden", "task_index": 6}
8
+ {"episode_index": 7, "episode_name": "screwdriver_20251104_203022", "task": "screwdriver", "task_index": 7}
9
+ {"episode_index": 8, "episode_name": "smallkey_20251104_203257", "task": "smallkey", "task_index": 8}
10
+ {"episode_index": 9, "episode_name": "smallpaper_20251104_203636", "task": "smallpaper", "task_index": 9}
11
+ {"episode_index": 10, "episode_name": "smallwoodenstick_20251104_204353", "task": "smallwoodenstick", "task_index": 10}
12
+ {"episode_index": 11, "episode_name": "thinmetaldisk_20251104_204557", "task": "thinmetaldisk", "task_index": 11}
13
+ {"episode_index": 12, "episode_name": "thinmetaldisk_20251104_204721", "task": "thinmetaldisk", "task_index": 11}
meta_data/info.json ADDED
@@ -0,0 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "codebase_version": "v0.3",
3
+ "robot_type": "piper",
4
+ "fps": 30,
5
+ "video": false,
6
+ "encoding": {
7
+ "observation.images.table_cam": {
8
+ "type": "video_folder",
9
+ "path": "{episode_name}_images/observation.images.table_cam"
10
+ },
11
+ "observation.images.wrist_cam": {
12
+ "type": "video_folder",
13
+ "path": "{episode_name}_images/observation.images.wrist_cam"
14
+ },
15
+ "observation.state": {
16
+ "type": "hdf5",
17
+ "path": "observations/state"
18
+ },
19
+ "action": {
20
+ "type": "hdf5",
21
+ "path": "actions"
22
+ }
23
+ },
24
+ "shapes": {
25
+ "observation.images.table_cam": [720, 800, 3],
26
+ "observation.images.wrist_cam": [480, 640, 3],
27
+ "observation.state": [7],
28
+ "action": [7]
29
+ },
30
+ "names": {
31
+ "observation.state": [
32
+ "joint_1",
33
+ "joint_2",
34
+ "joint_3",
35
+ "joint_4",
36
+ "joint_5",
37
+ "joint_6",
38
+ "joint_7"
39
+ ],
40
+ "action": [
41
+ "joint_1",
42
+ "joint_2",
43
+ "joint_3",
44
+ "joint_4",
45
+ "joint_5",
46
+ "joint_6",
47
+ "joint_7"
48
+ ]
49
+ },
50
+ "license": "MIT",
51
+ "description": "PiPER robot teaching episodes dataset containing teleoperation demonstrations for object manipulation tasks. Dataset includes synchronized robot state, actions, and dual-camera observations captured at 30 FPS."
52
+ }
meta_data/tasks.jsonl ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {"task": "cleaningcloth", "task_index": 0}
2
+ {"task": "fillamentroll", "task_index": 1}
3
+ {"task": "gamecontroller", "task_index": 2}
4
+ {"task": "hexwrench", "task_index": 3}
5
+ {"task": "pencil", "task_index": 4}
6
+ {"task": "scissors", "task_index": 5}
7
+ {"task": "scissors_hidden", "task_index": 6}
8
+ {"task": "screwdriver", "task_index": 7}
9
+ {"task": "smallkey", "task_index": 8}
10
+ {"task": "smallpaper", "task_index": 9}
11
+ {"task": "smallwoodenstick", "task_index": 10}
12
+ {"task": "thinmetaldisk", "task_index": 11}