docs: propose v3.0 tag for default LeRobot loading

#1
by sovrasov - opened
Files changed (1) hide show
  1. README.md +44 -0
README.md ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - lerobot
4
+ - robotics
5
+ ---
6
+
7
+ # Intel Assembly
8
+
9
+ This dataset uses the LeRobot v3.0 format and contains 101 episodes,
10
+ 55,675 frames, and 3 tasks recorded at 30 fps. It includes 7-dimensional
11
+ actions and robot states, plus top and wrist camera videos.
12
+
13
+ ## LeRobot Compatibility
14
+
15
+ The existing `meta/info.json` declares `codebase_version: v3.0`.
16
+ LeRobot requires a matching version tag for default loading on a fresh cache.
17
+ A repository maintainer must add the tag separately from merging this card:
18
+
19
+ ```python
20
+ from huggingface_hub import HfApi
21
+
22
+ HfApi().create_tag(
23
+ repo_id="samet-akcay/Intel-assembly",
24
+ repo_type="dataset",
25
+ tag="v3.0",
26
+ revision="fd614b6b0274ae865580c1874dc5c4cf8b75e462",
27
+ )
28
+ ```
29
+
30
+ After the tag is added, Physical AI Studio can resolve the dataset without
31
+ an explicit revision:
32
+
33
+ ```python
34
+ from physicalai.data import LeRobotDataModule
35
+
36
+ l_dm = LeRobotDataModule(
37
+ repo_id="samet-akcay/Intel-assembly",
38
+ train_batch_size=8,
39
+ )
40
+ ```
41
+
42
+ Until then, use `revision="main"` explicitly. Metadata loading with this
43
+ revision has been verified; video decoding and full training batches have
44
+ not been tested.