DaivdYuan commited on
Commit
deb2de9
·
verified ·
1 Parent(s): 1c33d8d

docs: add detailed dataset card and attribution

Browse files
Files changed (1) hide show
  1. README.md +54 -152
README.md CHANGED
@@ -1,175 +1,77 @@
1
  ---
2
  license: other
3
- task_categories:
4
- - robotics
5
  tags:
6
- - LeRobot
7
  - robotics
8
  - lerobot
9
- - umi
 
10
  - nmotion-initiative
11
- configs:
12
- - config_name: default
13
- data_files: data/*/*.parquet
14
  ---
15
 
16
- This dataset was created using [LeRobot](https://github.com/huggingface/lerobot).
17
-
18
-
19
- <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=DaivdYuan/mv-umi-markers-placement-seg-lerobot">
20
- <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
21
- <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
22
- </a>
23
 
 
 
 
24
 
25
- ## Dataset Description
 
 
 
 
 
 
 
 
26
 
 
 
 
 
 
 
 
 
 
27
 
 
 
 
 
28
 
29
- - **Homepage:** [More Information Needed]
30
- - **Paper:** [More Information Needed]
31
- - **License:** other
 
32
 
33
  ## Dataset Structure
34
-
35
- [meta/info.json](meta/info.json):
36
  ```json
37
  {
38
- "codebase_version": "v3.0",
39
- "robot_type": "generic_robot",
40
- "total_episodes": 30,
41
- "total_frames": 15386,
42
- "total_tasks": 1,
43
- "chunks_size": 1000,
44
- "data_files_size_in_mb": 100,
45
- "video_files_size_in_mb": 200,
46
- "fps": 30,
47
- "splits": {
48
- "train": "0:30"
49
- },
50
- "data_path": "data/chunk-{chunk_index:03d}/file-{file_index:03d}.parquet",
51
- "video_path": "videos/{video_key}/chunk-{chunk_index:03d}/file-{file_index:03d}.mp4",
52
- "features": {
53
- "observation.state": {
54
- "dtype": "float32",
55
- "shape": [
56
- 7
57
- ],
58
- "names": [
59
- "state_0",
60
- "state_1",
61
- "state_2",
62
- "state_3",
63
- "state_4",
64
- "state_5",
65
- "state_6"
66
- ]
67
- },
68
- "action": {
69
- "dtype": "float32",
70
- "shape": [
71
- 7
72
- ],
73
- "names": [
74
- "action_0",
75
- "action_1",
76
- "action_2",
77
- "action_3",
78
- "action_4",
79
- "action_5",
80
- "action_6"
81
- ]
82
- },
83
- "observation.images.camera0_rgb": {
84
- "dtype": "video",
85
- "shape": [
86
- 224,
87
- 224,
88
- 3
89
- ],
90
- "names": [
91
- "height",
92
- "width",
93
- "channels"
94
- ],
95
- "info": {
96
- "video.height": 224,
97
- "video.width": 224,
98
- "video.codec": "h264",
99
- "video.pix_fmt": "yuv420p",
100
- "video.is_depth_map": false,
101
- "video.fps": 30,
102
- "video.channels": 3,
103
- "has_audio": false
104
- }
105
- },
106
- "observation.images.camera1_rgb": {
107
- "dtype": "video",
108
- "shape": [
109
- 224,
110
- 224,
111
- 3
112
- ],
113
- "names": [
114
- "height",
115
- "width",
116
- "channels"
117
- ],
118
- "info": {
119
- "video.height": 224,
120
- "video.width": 224,
121
- "video.codec": "h264",
122
- "video.pix_fmt": "yuv420p",
123
- "video.is_depth_map": false,
124
- "video.fps": 30,
125
- "video.channels": 3,
126
- "has_audio": false
127
- }
128
- },
129
- "timestamp": {
130
- "dtype": "float32",
131
- "shape": [
132
- 1
133
- ],
134
- "names": null
135
- },
136
- "frame_index": {
137
- "dtype": "int64",
138
- "shape": [
139
- 1
140
- ],
141
- "names": null
142
- },
143
- "episode_index": {
144
- "dtype": "int64",
145
- "shape": [
146
- 1
147
- ],
148
- "names": null
149
- },
150
- "index": {
151
- "dtype": "int64",
152
- "shape": [
153
- 1
154
- ],
155
- "names": null
156
- },
157
- "task_index": {
158
- "dtype": "int64",
159
- "shape": [
160
- 1
161
- ],
162
- "names": null
163
- }
164
- }
165
  }
166
  ```
167
 
 
 
168
 
169
  ## Citation
 
 
170
 
171
- **BibTeX:**
172
-
173
- ```bibtex
174
- [More Information Needed]
175
- ```
 
1
  ---
2
  license: other
 
 
3
  tags:
 
4
  - robotics
5
  - lerobot
6
+ - manipulation
7
+ - mv-umi
8
  - nmotion-initiative
 
 
 
9
  ---
10
 
11
+ # Markers Placement (Seg)
 
 
 
 
 
 
12
 
13
+ ## Overview
14
+ This dataset is a conversion from an upstream robotics dataset into **LeRobot v3-compatible format**.
15
+ It is intended to provide reproducible access in a unified schema.
16
 
17
+ ## Source Dataset
18
+ - Dataset ID: `mv-umi-markers-placement-seg`
19
+ - Project: `MV-UMI`
20
+ - Task: `Markers Placement (Seg)`
21
+ - Upstream download/source URL: https://huggingface.co/datasets/omarrayyann/mv-umi/resolve/main/markers_placement_data.zarr.zip?download=true
22
+ - Upstream project page: https://mv-umi.github.io
23
+ - Contact: olr7742@nyu.edu
24
+ - Original paper: Rayyan et al. 2025
25
+ - Notes: 454 demos; segmented view
26
 
27
+ ## Dataset Format
28
+ - Storage format: LeRobot v3 parquet-based dataset
29
+ - Total episodes: 30
30
+ - Total frames: 15386
31
+ - FPS: 30
32
+ - Robot type: generic_robot
33
+ - Observation feature: `observation.state` with shape `[7]`
34
+ - Action feature: `action` with shape `[7]`
35
+ - Video streams: present
36
 
37
+ ## Video Modalities
38
+ - `observation.images.camera0_rgb`: shape `[224, 224, 3]`
39
+ - `observation.images.camera1_rgb`: shape `[224, 224, 3]`
40
+ - Frame rate: `30` FPS
41
 
42
+ ## Conversion Notes
43
+ - Target schema: LeRobot v3
44
+ - Conversion path: ingest -> preprocess -> zarr probe -> convert 1 episode -> upload
45
+ - `action` fallback may be used when upstream `data/action` is missing.
46
 
47
  ## Dataset Structure
48
+ `meta/info.json`:
 
49
  ```json
50
  {
51
+ "codebase_version": "v3.0",
52
+ "robot_type": "generic_robot",
53
+ "total_episodes": 30,
54
+ "total_frames": 15386,
55
+ "fps": 30,
56
+ "splits": {"train": "0:30"},
57
+ "data_path": "data/chunk-{chunk_index:03d}/file-{file_index:03d}.parquet",
58
+ "video_path": "videos/{video_key}/chunk-{chunk_index:03d}/file-{file_index:03d}.mp4",
59
+ "features": {
60
+ "observation.state": {"dtype": "float32", "shape": [7]},
61
+ "action": {"dtype": "float32", "shape": [7]}
62
+ }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
63
  }
64
  ```
65
 
66
+ ## Data Splits
67
+ - `{'train': '0:30'}`
68
 
69
  ## Citation
70
+ This dataset was created using [LeRobot](https://github.com/huggingface/lerobot).
71
+ Please also cite the original upstream project and paper listed above.
72
 
73
+ ## Attribution
74
+ - Original dataset credit remains with upstream creators.
75
+ - Conversion and curation contribution:
76
+ - **Convertor: David Yuan, davidy02@stanford.edu, Stanford University**
77
+ - **NMotion Initiative** (opensource community): *we make embodied data accessible*