yxma commited on
Commit
6429adf
·
verified ·
1 Parent(s): 83b8758

Add tasks.json registry; README per-task configs and task-first schema

Browse files
Files changed (2) hide show
  1. README.md +35 -15
  2. tasks.json +12 -0
README.md CHANGED
@@ -14,7 +14,11 @@ pretty_name: React (Tactile-Visual Manipulation)
14
  size_categories:
15
  - 10K<n<100K
16
  configs:
17
- - config_name: mode1_v1
 
 
 
 
18
  data_files:
19
  - split: train
20
  path: processed/mode1_v1/**/episode_*.pt
@@ -35,22 +39,27 @@ Multimodal manipulation recordings from a bimanual setup with vision-based tacti
35
 
36
  All streams share a common monotonic timestamp axis recorded under `timestamps`. Per-tracker OptiTrack streams carry their own higher-rate timestamps under `optitrack/<body>/timestamps`.
37
 
38
- ## Tasks recorded
 
 
 
 
 
 
39
 
40
- - **`motherboard`** bimanual insertion / placement on a computer motherboard.
41
 
42
  ## Repository layout
43
 
44
  ```
 
45
  processed/
46
  └─ mode1_v1/
47
- 2026-03-23/ # 3 episodes (2,141 / 1,948 / 2,109 frames)
48
- 2026-05-10/ # 12 episodes ( 763 – 10,476 frames each)
49
- 2026-05-11/ # 17 episodes ( 263 – 33,739 frames each)
50
- ├─ episode_000.pt
51
- episode_000.contact.json
52
- ├─ episode_002.pt # episode_001 missing (corrupt at recording time)
53
- └─ ...
54
  ```
55
 
56
  The `processed/mode1_v1/` view is a **task-specific slice** of the underlying raw recordings, not the full sensor suite. It was produced by `twm/preprocess.py` + `twm/contact_index.py` from a private raw HDF5 mirror.
@@ -89,6 +98,16 @@ For each tactile sensor independently:
89
 
90
  ## Quick start
91
 
 
 
 
 
 
 
 
 
 
 
92
  ```python
93
  import torch
94
  from huggingface_hub import hf_hub_download
@@ -96,21 +115,21 @@ from huggingface_hub import hf_hub_download
96
  path = hf_hub_download(
97
  repo_id="yxma/React",
98
  repo_type="dataset",
99
- filename="processed/mode1_v1/2026-05-11/episode_000.pt",
100
  )
101
  ep = torch.load(path, weights_only=False)
102
  print(ep["view"].shape, ep["tactile_left_intensity"].shape)
103
  # torch.Size([263, 3, 128, 128]) torch.Size([263])
104
  ```
105
 
106
- To load contact metadata only (much smaller — useful for filtering):
107
 
108
  ```python
109
  import json
110
  path = hf_hub_download(
111
  repo_id="yxma/React",
112
  repo_type="dataset",
113
- filename="processed/mode1_v1/2026-05-11/episode_000.contact.json",
114
  )
115
  meta = json.load(open(path))
116
  print(meta["drift_left"], meta["drift_right"], meta["drift_warning"])
@@ -118,7 +137,7 @@ print(meta["drift_left"], meta["drift_right"], meta["drift_warning"])
118
 
119
  ## Known caveats
120
 
121
- - **Missing episode**: `2026-05-11/episode_001` was lost at recording time (HDF5 superblock never finalized when the writer was killed mid-write). It is intentionally absent.
122
  - **Lossy resize**: the 128×128 `view` and tactile fields are downsampled from native 480×640. Native resolution is **not** preserved in this release.
123
  - **Single camera**: only `realsense/cam0/color` is included. The other two RealSense views and all depth streams are not in `processed/mode1_v1/`.
124
  - **OptiTrack alignment**: the per-step poses are nearest-neighbor matched to camera ticks. The full ~120 Hz pose streams are not preserved here.
@@ -126,7 +145,8 @@ print(meta["drift_left"], meta["drift_right"], meta["drift_warning"])
126
 
127
  ## Roadmap
128
 
129
- A **LeRobot-format full-fidelity** variant (`lerobot/v1.0/`) is planned. It will include all three RealSense color and depth streams, GelSight at native resolution (FFV1 lossless), full-rate OptiTrack pose tracks for all three rigid bodies, and HF-native browser previews. The current `processed/mode1_v1/` slice will remain as a stable training-task view.
 
130
 
131
  ## Citation
132
 
 
14
  size_categories:
15
  - 10K<n<100K
16
  configs:
17
+ - config_name: motherboard
18
+ data_files:
19
+ - split: train
20
+ path: processed/mode1_v1/motherboard/**/episode_*.pt
21
+ - config_name: all
22
  data_files:
23
  - split: train
24
  path: processed/mode1_v1/**/episode_*.pt
 
39
 
40
  All streams share a common monotonic timestamp axis recorded under `timestamps`. Per-tracker OptiTrack streams carry their own higher-rate timestamps under `optitrack/<body>/timestamps`.
41
 
42
+ ## Tasks
43
+
44
+ The dataset is organized **task-first** so new tasks can be added without renaming or recompute. Current tasks:
45
+
46
+ | Task | Description | Dates | Episodes |
47
+ |---|---|---|---|
48
+ | `motherboard` | Bimanual manipulation of components on a computer motherboard | 2026-03-23, 2026-05-10, 2026-05-11 | 32 |
49
 
50
+ `tasks.json` at the repo root is the source of truth for the task registry.
51
 
52
  ## Repository layout
53
 
54
  ```
55
+ tasks.json # registry
56
  processed/
57
  └─ mode1_v1/
58
+ <task>/
59
+ <date>/
60
+ episode_000.pt
61
+ ├─ episode_000.contact.json
62
+ ─ ...
 
 
63
  ```
64
 
65
  The `processed/mode1_v1/` view is a **task-specific slice** of the underlying raw recordings, not the full sensor suite. It was produced by `twm/preprocess.py` + `twm/contact_index.py` from a private raw HDF5 mirror.
 
98
 
99
  ## Quick start
100
 
101
+ Load one task via `datasets`:
102
+
103
+ ```python
104
+ from datasets import load_dataset
105
+ ds = load_dataset("yxma/React", "motherboard", split="train")
106
+ # Each row is one .pt file path; the actual tensors live inside.
107
+ ```
108
+
109
+ Or load a single episode directly:
110
+
111
  ```python
112
  import torch
113
  from huggingface_hub import hf_hub_download
 
115
  path = hf_hub_download(
116
  repo_id="yxma/React",
117
  repo_type="dataset",
118
+ filename="processed/mode1_v1/motherboard/2026-05-11/episode_000.pt",
119
  )
120
  ep = torch.load(path, weights_only=False)
121
  print(ep["view"].shape, ep["tactile_left_intensity"].shape)
122
  # torch.Size([263, 3, 128, 128]) torch.Size([263])
123
  ```
124
 
125
+ Load contact metadata only (much smaller — useful for filtering):
126
 
127
  ```python
128
  import json
129
  path = hf_hub_download(
130
  repo_id="yxma/React",
131
  repo_type="dataset",
132
+ filename="processed/mode1_v1/motherboard/2026-05-11/episode_000.contact.json",
133
  )
134
  meta = json.load(open(path))
135
  print(meta["drift_left"], meta["drift_right"], meta["drift_warning"])
 
137
 
138
  ## Known caveats
139
 
140
+ - **Missing episode**: `motherboard/2026-05-11/episode_001` was lost at recording time (HDF5 superblock never finalized when the writer was killed mid-write). It is intentionally absent.
141
  - **Lossy resize**: the 128×128 `view` and tactile fields are downsampled from native 480×640. Native resolution is **not** preserved in this release.
142
  - **Single camera**: only `realsense/cam0/color` is included. The other two RealSense views and all depth streams are not in `processed/mode1_v1/`.
143
  - **OptiTrack alignment**: the per-step poses are nearest-neighbor matched to camera ticks. The full ~120 Hz pose streams are not preserved here.
 
145
 
146
  ## Roadmap
147
 
148
+ - **More tasks** registry in `tasks.json` will grow.
149
+ - **LeRobot-format full-fidelity** variant (`lerobot/v1.0/`) is planned. It will include all three RealSense color and depth streams, GelSight at native resolution (FFV1 lossless), full-rate OptiTrack pose tracks for all three rigid bodies, and HF-native browser previews. The current `processed/mode1_v1/` slice will remain as a stable training-task view.
150
 
151
  ## Citation
152
 
tasks.json ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "tasks": {
3
+ "motherboard": {
4
+ "language": "Bimanual manipulation of components on a computer motherboard.",
5
+ "dates": ["2026-03-23", "2026-05-10", "2026-05-11"],
6
+ "n_episodes": 32,
7
+ "notes": "Episode 2026-05-11/episode_001 lost at recording time (HDF5 superblock not finalized)."
8
+ }
9
+ },
10
+ "schema_version": "mode1_v1",
11
+ "layout": "processed/mode1_v1/<task>/<date>/episode_*.{pt,contact.json}"
12
+ }