jeremyhx commited on
Commit
0e934a7
·
verified ·
1 Parent(s): 2d78a85

model card: tasks / rig / provenance / training stats (auto)

Browse files
Files changed (1) hide show
  1. README.md +39 -139
README.md CHANGED
@@ -1,164 +1,64 @@
1
  ---
2
- datasets: VibeCuisine/vibepi3-grab-poseexpert-curated-081826
 
3
  library_name: lerobot
4
- license: apache-2.0
5
- model_name: act
6
  pipeline_tag: robotics
7
  tags:
8
- - lerobot
9
  - act
10
- - robotics
 
11
  ---
12
 
13
- # Model Card for act
 
14
 
15
- <!-- Provide a quick summary of what the model is/does. -->
16
 
 
17
 
18
- [Action Chunking with Transformers (ACT)](https://huggingface.co/papers/2304.13705) is an imitation-learning method that predicts short action chunks instead of single steps. It learns from teleoperated data and often achieves high success rates.
 
 
 
 
 
 
 
 
 
 
19
 
 
20
 
 
21
 
 
 
 
22
 
23
- <!-- A short demo is worth more than any description! Record a GIF/video of the policy
24
- running on your robot, upload it to this repo, and embed it here:
25
- <p align="center">
26
- <img src="https://huggingface.co/<hf_user>/<policy_repo_id>/resolve/main/demo.gif" width="60%"/>
27
- </p>
28
- -->
29
 
30
- This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
 
 
 
31
 
32
- Learn how to train and run it in the [LeRobot act guide](https://huggingface.co/docs/lerobot/main/en/act), or browse the [full documentation](https://huggingface.co/docs/lerobot/index).
33
 
 
 
 
34
 
35
- ---
36
-
37
- ## Model Details
38
-
39
- - **License:** apache-2.0
40
- - **Robot type:** `vibeboard_follower_tilt`
41
- - **Cameras:** `corner`, `top`, `wrist`
42
-
43
-
44
- ## Inputs & Outputs
45
-
46
- The policy consumes these observation features and produces these action features.
47
-
48
- **Inputs**
49
-
50
- | Feature | Type | Shape |
51
- | --- | --- | --- |
52
- | `observation.state` | STATE | `(7,)` |
53
- | `observation.images.corner` | VISUAL | `(3, 480, 640)` |
54
- | `observation.images.top` | VISUAL | `(3, 480, 640)` |
55
- | `observation.images.wrist` | VISUAL | `(3, 480, 640)` |
56
-
57
- **Outputs**
58
-
59
- | Feature | Type | Shape |
60
- | --- | --- | --- |
61
- | `action` | ACTION | `(7,)` |
62
-
63
-
64
- ## Training Dataset
65
-
66
- - **Repository:** [VibeCuisine/vibepi3-grab-poseexpert-curated-081826](https://huggingface.co/datasets/VibeCuisine/vibepi3-grab-poseexpert-curated-081826)
67
- - **Episodes:** 39
68
- - **Frames:** 2112
69
- - **Frame rate:** 20 FPS
70
- - **Task(s):** "Grab the cucumber at the one-third point"
71
-
72
- <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=VibeCuisine/vibepi3-grab-poseexpert-curated-081826">
73
- <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
74
- <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
75
- </a>
76
-
77
-
78
- ## Training Configuration
79
-
80
- | Setting | Value |
81
- | --- | --- |
82
- | Training steps | 30000 |
83
- | Batch size | 8 |
84
- | Optimizer | adamw |
85
- | Learning rate | 1e-05 |
86
- | Seed | 1000 |
87
- | LeRobot version | 0.6.0 |
88
-
89
- ---
90
 
91
- ## How to Get Started with the Model
92
-
93
- New to LeRobot? These guides cover the full workflow:
94
-
95
- - **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
96
- - **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
97
- - **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
98
- - **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
99
-
100
- The short version to run and train this policy:
101
-
102
- ### Run the policy on your robot
103
-
104
- ```bash
105
- lerobot-rollout \
106
- --strategy.type=base \
107
- --robot.type=vibeboard_follower_tilt \
108
- --robot.port=<your_robot_port> \
109
- --robot.cameras="{ <camera_1>: {type: opencv, index_or_path: <index_or_path>, width: 640, height: 480, fps: 30}, <camera_2>: {type: opencv, index_or_path: <index_or_path>, width: 640, height: 480, fps: 30}}" \
110
- --policy.path=VibeCuisine/vibepi3-grab-act-aug-081826 \
111
- --task="Grab the cucumber at the one-third point" \
112
- --duration=60
113
  ```
114
-
115
- Replace the remaining `<...>` placeholders with your own values: `--robot.port` and the camera names/indices are specific to your machine, and the camera names must match the observation keys this policy was trained on.
116
-
117
- When `--strategy.type=base` is used the script doesn't record the episodes. Skipping duration will make the policy run indefinitely. For more information look at [rollout documentation](https://huggingface.co/docs/lerobot/main/en/inference).
118
-
119
- ### Train your own policy
120
-
121
- ```bash
122
- lerobot-train \
123
- --dataset.repo_id=${HF_USER}/<dataset> \
124
- --policy.type=act \
125
- --output_dir=outputs/train/<policy_repo_id> \
126
- --job_name=lerobot_training \
127
- --policy.device=cuda \
128
- --policy.repo_id=${HF_USER}/<policy_repo_id> \
129
- --wandb.enable=true
130
  ```
131
 
132
- _Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
133
 
134
- ---
135
-
136
- ## Evaluation
137
-
138
- <!-- Report real-robot results here: run the policy several times per task and count the
139
- successes. Delete the "No evaluation results" line and fill in this table instead:
140
-
141
- | Task | Trials | Successes | Success rate |
142
- | ---- | ------ | --------- | ------------ |
143
- | pick the lego brick | 10 | 8 | 80% |
144
-
145
- Also worth noting: anything that affects difficulty (new object positions, lighting,
146
- distractors, a different robot of the same type, ...).
147
- -->
148
-
149
- _No evaluation results have been provided for this policy yet._
150
 
151
  ---
152
-
153
- ## Citation
154
-
155
- If you use this policy, please cite the method linked in the description above, along with LeRobot:
156
-
157
- ```bibtex
158
- @misc{cadene2024lerobot,
159
- author = {Cadene, Remi and Alibert, Simon and Soare, Alexander and Gallouedec, Quentin and Zouitine, Adil and Palma, Steven and Kooijmans, Pepijn and Aractingi, Michel and Shukor, Mustafa and Aubakirova, Dana and Russi, Martino and Capuano, Francesco and Pascal, Caroline and Choghari, Jade and Moss, Jess and Wolf, Thomas},
160
- title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
161
- howpublished = "\url{https://github.com/huggingface/lerobot}",
162
- year = {2024}
163
- }
164
- ```
 
1
  ---
2
+ datasets:
3
+ - VibeCuisine/vibepi3-grab-poseexpert-curated-081826
4
  library_name: lerobot
 
 
5
  pipeline_tag: robotics
6
  tags:
 
7
  - act
8
+ - vibe-data-studio
9
+ - hardware:vibeboard_v3
10
  ---
11
 
12
+ <!-- vibedata:model-card -->
13
+ # vibepi3-grab-act-aug-081826
14
 
15
+ act policy trained via Vibe Data Studio on 39 teleop episodes.
16
 
17
+ ## At a glance
18
 
19
+ | | |
20
+ |---|---|
21
+ | **Architecture** | act (from scratch) |
22
+ | **Dataset** | [vibepi3-grab-poseexpert-curated-081826](https://huggingface.co/datasets/VibeCuisine/vibepi3-grab-poseexpert-curated-081826) @ `aa2bd373` |
23
+ | **Scale** | 39 episodes · 2,112 frames @ 20 fps |
24
+ | **Steps / batch / seed** | 30,000 / 8 / 1000 |
25
+ | **lerobot** | `b6d46c40` |
26
+ | **Provider / GPU** | site-gpu / site GPU host |
27
+ | **Duration** | 1h 16m |
28
+ | **Final train loss** | 0.043 |
29
+ | **W&B** | [vds47-9284ef15](https://wandb.ai/jeremyhx-freelance/lerobot/runs/vds47-9284ef15) |
30
 
31
+ ## Tasks
32
 
33
+ Language-conditioned — pass one of these instructions at inference:
34
 
35
+ | Instruction | Episodes |
36
+ |---|---:|
37
+ | Grab the cucumber at the one-third point | 39 |
38
 
39
+ **Episodes per task per recording rig** (derived from the nested collection manifests down to leaf recorded datasets):
 
 
 
 
 
40
 
41
+ | Task | vibepi3 | **Total** |
42
+ |---|---:|---:|
43
+ | Grab the cucumber at the one-third point | 39 | **39** |
44
+ | **Total** | **39** | **39** |
45
 
46
+ ## Rig
47
 
48
+ - **Action/state** (7-dim): shoulder_pan, shoulder_lift, elbow_flex, wrist_flex, wrist_roll, gripper, tilt
49
+ - **Cameras** @ 20 fps: corner 640×480, top 640×480, wrist 640×480
50
+ - **Consumed image inputs** (the checkpoint's resolved VISUAL features, from its `config.json`): `observation.images.corner`, `observation.images.top`, `observation.images.wrist`
51
 
52
+ <details>
53
+ <summary><b>Reproduce</b> — exact training command</summary>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
54
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
  ```
56
+ lerobot-train --policy.type=act --policy.repo_id=VibeCuisine/vibepi3-grab-act-aug-081826 --dataset.repo_id=VibeCuisine/vibepi3-grab-poseexpert-curated-081826 --dataset.revision=aa2bd3738231994b7a3ccba2918f1eacbc3a0dd2 --batch_size=8 --steps=30000 --save_freq=5000 --output_dir=outputs/train/vibepi3-grab-act-aug-081826 --job_name=vibepi3-grab-act-aug-081826 --policy.device=cuda --wandb.enable=true --wandb.disable_artifact=true --wandb.project=lerobot --wandb.run_id=vds47-9284ef15 --wandb.entity=jeremyhx-freelance --seed=1000 --dataset.eval_split=0.1 --eval_steps=600 --dataset.image_transforms.enable=true --policy.chunk_size=40 --policy.n_action_steps=40
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
  ```
58
 
59
+ `--num_workers` is appended host-side (clamped to the host's allocation).
60
 
61
+ </details>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
62
 
63
  ---
64
+ *Card generated by Vibe Data Studio on run completion.*