Upload README.md with huggingface_hub

README.md

@@ -1,16 +1,30 @@
 ---
+license: mit
 task_categories:
 - robotics
 tags:
 - LeRobot
+configs:
+- config_name: default
+  data_files: data/*/*.parquet
 ---
+
 This dataset was created using [LeRobot](https://github.com/huggingface/lerobot).
 
-[meta/info.json](meta/info.json)
+## Dataset Description
+
+
+
+- **Homepage:** https://uscresl.github.io/dmfd/
+- **Paper:** https://arxiv.org/abs/2207.10148
+- **License:** mit
+
+## Dataset Structure
+
+[meta/info.json](meta/info.json):
 ```json
 {
     "codebase_version": "v2.0",
-    "data_path": "data/chunk-{episode_chunk:03d}/episode_{episode_index:06d}.parquet",
     "robot_type": "unknown",
     "total_episodes": 1000,
     "total_frames": 100000,
@@ -22,46 +36,128 @@ This dataset was created using [LeRobot](https://github.com/huggingface/lerobot)
     "splits": {
         "train": "0:1000"
     },
-    "keys": [
-        "observation.state",
-        "action"
-    ],
-    "video_keys": [
-        "observation.images.image"
-    ],
-    "image_keys": [],
-    "shapes": {
-        "observation.state": 1,
-        "action": 4,
-        "observation.images.image": {
-            "width": 64,
-            "height": 64,
-            "channels": 3
-        }
-    },
-    "names": {
-        "observation.state": [
-            "motor_0"
-        ],
-        "action": [
-            "motor_0",
-            "motor_1",
-            "motor_2",
-            "motor_3"
-        ]
-    },
-    "videos": {
-        "videos_path": "videos/chunk-{episode_chunk:03d}/{video_key}/episode_{episode_index:06d}.mp4",
+    "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.image": {
-            "video.fps": 10.0,
-            "video.width": 64,
-            "video.height": 64,
-            "video.channels": 3,
-            "video.codec": "av1",
-            "video.pix_fmt": "yuv420p",
-            "video.is_depth_map": false,
-            "has_audio": false
+            "dtype": "video",
+            "shape": [
+                64,
+                64,
+                3
+            ],
+            "names": [
+                "height",
+                "width",
+                "channel"
+            ],
+            "video_info": {
+                "video.fps": 10.0,
+                "video.codec": "av1",
+                "video.pix_fmt": "yuv420p",
+                "video.is_depth_map": false,
+                "has_audio": false
+            }
+        },
+        "language_instruction": {
+            "dtype": "string",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "observation.state": {
+            "dtype": "float32",
+            "shape": [
+                1
+            ],
+            "names": {
+                "motors": [
+                    "motor_0"
+                ]
+            }
+        },
+        "action": {
+            "dtype": "float32",
+            "shape": [
+                4
+            ],
+            "names": {
+                "motors": [
+                    "motor_0",
+                    "motor_1",
+                    "motor_2",
+                    "motor_3"
+                ]
+            }
+        },
+        "timestamp": {
+            "dtype": "float32",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "episode_index": {
+            "dtype": "int64",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "frame_index": {
+            "dtype": "int64",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "next.reward": {
+            "dtype": "float32",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "next.done": {
+            "dtype": "bool",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "index": {
+            "dtype": "int64",
+            "shape": [
+                1
+            ],
+            "names": null
+        },
+        "task_index": {
+            "dtype": "int64",
+            "shape": [
+                1
+            ],
+            "names": null
         }
     }
 }
+```
+
+
+## Citation
+
+**BibTeX:**
+
+```bibtex
+@article{salhotra2022dmfd,
+    author={Salhotra, Gautam and Liu, I-Chun Arthur and Dominguez-Kuhne, Marcus and Sukhatme, Gaurav S.},
+    journal={IEEE Robotics and Automation Letters},
+    title={Learning Deformable Object Manipulation From Expert Demonstrations},
+    year={2022},
+    volume={7},
+    number={4},
+    pages={8775-8782},
+    doi={10.1109/LRA.2022.3187843}
+}
 ```