X-EraAI commited on
Commit
2ff599e
·
verified ·
1 Parent(s): 8324b87

Publish e05 resource, usage instructions and provenance

Browse files
Files changed (2) hide show
  1. README.md +79 -0
  2. THIRD_PARTY_NOTICES.md +32 -0
README.md ADDED
@@ -0,0 +1,79 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ language:
3
+ - en
4
+ tags:
5
+ - robotics
6
+ - e05
7
+ - vggt
8
+ ---
9
+
10
+ # E05 processed RoboTwin data
11
+
12
+ - Robot benchmark tasks: 50; episodes: 2,500 (50/task).
13
+ - Frames: 549,787; LeRobot format: v2.1; robot: aloha-agilex.
14
+ - Metadata FPS: 15. This is the processed dataset's timing metadata, not a claim
15
+ about the simulator's internal physics/control rate.
16
+ - Language table: 158,984 entries. LeRobot `total_tasks` counts language entries,
17
+ not the 50 robot benchmark tasks.
18
+ - Cameras, in order: cam_high, cam_left_wrist, cam_right_wrist; RGB 240×320.
19
+ - State/action: 14 joint/gripper components in the existing dataset order.
20
+ Preserve left-arm joints/gripper followed by right-arm joints/gripper as consumed
21
+ by RoboTwin's joint-action interface. Do not interpret this as end-effector delta.
22
+ - Source modality metadata records state[t]=joint[t], action[t]=joint[t+1].
23
+ - Geometry cache: depth in metres, valid pixels, intrinsics [3,3,3], and OpenCV
24
+ world-to-camera extrinsics [3,3,4]. Future target offset: 32 frames; targets
25
+ beyond an episode are excluded by the existing padding mask.
26
+
27
+ All 2,500 episodes are used for training; there is no internal held-out loss split.
28
+ Normalization uses the exact source run's statistics, verified equal to the named
29
+ dataset statistics file. Geometric diagnostics on these frames are training-set
30
+ diagnostics, not held-out generalization measurements.
31
+
32
+ The code expects data that have already been processed. The dataset and caches
33
+ are external resources and are not included in the Git repository.
34
+ RGB/Parquet/meta files retain their content
35
+ and indexing. Cache shards contain original `.pt` files compressed losslessly;
36
+ ZIP readers return the same bytes. There is no raw-data reconstruction pipeline.
37
+ Only language entries referenced by this dataset are included; unrelated experimental
38
+ text caches and incomplete temporary files are excluded. Novel inference instructions
39
+ use the public text encoder online, without modifying the published cache.
40
+
41
+ The reference layout contains RGB/action files and metadata in the LeRobot
42
+ directory, geometry cache shards by global-frame ranges of 1,000, and text cache
43
+ shards by SHA256 prefix. Each cache manifest records sizes and hashes; ZIP shards
44
+ retain their companion JSON entry manifests.
45
+ `scripts/validate_data.py --full` verifies complete coverage and cache archive
46
+ hashes after the data are placed in the configured directory. See the
47
+ [resource layout](https://github.com/X-EraAI/e05#data-and-checkpoints) for the expected paths.
48
+
49
+ The processed-data shards in this Hub repository can be installed with
50
+ `scripts/install_data.py`; no raw-data regeneration is required.
51
+
52
+ Provenance: processed from the locally supplied RobotTwin2.0-Depth
53
+ `aloha-agilex_clean_50` dataset. This is a project-specific derivative, not the
54
+ upstream official dataset release. Upstream data, language and asset terms must
55
+ be retained; the source code MIT license does not relicense these materials.
56
+
57
+ ## Download and install
58
+
59
+ The download contains about 378 GiB of losslessly compressed data and caches. Allow space for both the download and installed copy. Preserve the repository layout. Run from the e05 code repository:
60
+
61
+ ```bash
62
+ source scripts/env.sh
63
+ hf download X-EraAI/e05-robotwin-data --repo-type dataset --local-dir downloads/robotwin-data
64
+ python scripts/install_data.py downloads/robotwin-data --output data
65
+ python scripts/validate_data.py --data-root data --full
66
+ ```
67
+
68
+ The root manifest records 1,665 payload files and their SHA256 checksums: 51 RGB/action/metadata ZIPs, 1,101 reconstruction cache files, and 513 text cache files. Cache files include ZIPs, entry JSONs, and manifests. Use the e05 installer and loader, not `datasets.load_dataset`.
69
+
70
+ ## Resources
71
+
72
+ - [e05 code and instructions](https://github.com/X-EraAI/e05)
73
+ - [RoboTwin 109k policy](https://huggingface.co/X-EraAI/e05-robotwin)
74
+ - [Embodied-pretrained VGGT](https://huggingface.co/X-EraAI/e05-embodied-vggt)
75
+ - [Processed RoboTwin training data](https://huggingface.co/datasets/X-EraAI/e05-robotwin-data)
76
+
77
+ ## Terms
78
+
79
+ See [third-party notices](THIRD_PARTY_NOTICES.md). The code repository's MIT license does not relicense weights or data.
THIRD_PARTY_NOTICES.md ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Third-party materials
2
+
3
+ E05 retains the FastWAM copyright and MIT license for code covered by that license.
4
+ This does not override the terms on vendored code, upstream model weights, data,
5
+ or simulator assets.
6
+
7
+ - VGGT-Omega: facebookresearch/vggt-omega, pinned source commit documented in
8
+ `third_party/vggt-omega/README.vendor.md`. Preserve its FAIR Noncommercial Research
9
+ License and acceptable-use terms in `third_party/vggt-omega/LICENSE`.
10
+ - The public initialization mirror model card declares CC-BY-NC-4.0; retain the
11
+ model card and applicable upstream terms. Do not label the complete E05 model
12
+ unrestricted MIT or commercially licensed.
13
+ - Vendored official geometry loss and augmentation retain their LICENSE and
14
+ PROVENANCE files under `src/fastwam`.
15
+ - RoboTwin source: MIT, commit `bf44be51cf5717a5595ce59447f2cf5263d2aa95`;
16
+ see `third_party/RoboTwin/LICENSE` and README.vendor.md.
17
+ - cuRobo: preserve the NVIDIA notices and LICENSE in `third_party/curobo`.
18
+ - Wan/T5 components retain their upstream model terms. The component manifest
19
+ identifies their repositories and SHA256; no Wan video model is required.
20
+ - Processed Xera/RoboTwin data, language and simulation assets are separate
21
+ third-party-derived materials. Retain their source attribution and terms;
22
+ RoboTwin's code license alone does not establish their redistribution license.
23
+
24
+ Local adaptations: portable configuration and entrypoints, isolated execution,
25
+ lossless cache shard loading, non-writing inference text cache, smoke evidence,
26
+ release packaging, and worker/cache lifecycle fixes for NFS. Model architecture and checkpoint serialization are retained.
27
+
28
+ Embodied-pretrained VGGT resource: extracted from the VGGT branch of the e05
29
+ step-260000 checkpoint. The aggregator, language projector and geometry heads
30
+ retain applicable VGGT-Omega upstream model/code terms. This extraction does
31
+ not change those terms or apply the repository MIT code license to the weights.
32
+ Resource identity is recorded in `artifacts/checkpoint_manifest.json`.