Robotics
LeRobot
Safetensors
pi05
ViVi-AI commited on
Commit
3abcf3a
·
verified ·
1 Parent(s): a36e468

Upload policy weights, train config and readme

Browse files
Files changed (4) hide show
  1. README.md +168 -0
  2. config.json +108 -0
  3. model.safetensors +3 -0
  4. train_config.json +265 -0
README.md ADDED
@@ -0,0 +1,168 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: lerobot/pi05_base
3
+ datasets: ViVi-AI/so101_grab_pink_cube_merged
4
+ library_name: lerobot
5
+ license: apache-2.0
6
+ model_name: pi05
7
+ pipeline_tag: robotics
8
+ tags:
9
+ - lerobot
10
+ - robotics
11
+ - pi05
12
+ ---
13
+
14
+ # Model Card for pi05
15
+
16
+ <!-- Provide a quick summary of what the model is/does. -->
17
+
18
+
19
+ [π₀.₅ (Pi05)](https://www.physicalintelligence.company/blog/pi05) is a Vision-Language-Action model from Physical Intelligence designed for open-world generalization: it evolves π₀ to generalize to entirely new environments and situations that were never seen during training. The LeRobot implementation is adapted from their open-source OpenPI repository.
20
+
21
+
22
+
23
+
24
+ <!-- A short demo is worth more than any description! Record a GIF/video of the policy
25
+ running on your robot, upload it to this repo, and embed it here:
26
+ <p align="center">
27
+ <img src="https://huggingface.co/<hf_user>/<policy_repo_id>/resolve/main/demo.gif" width="60%"/>
28
+ </p>
29
+ -->
30
+
31
+ This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
32
+
33
+ Learn how to train and run it in the [LeRobot pi05 guide](https://huggingface.co/docs/lerobot/main/en/pi05), or browse the [full documentation](https://huggingface.co/docs/lerobot/index).
34
+
35
+
36
+ ---
37
+
38
+ ## Model Details
39
+
40
+ - **License:** apache-2.0
41
+ - **Fine-tuned from:** [lerobot/pi05_base](https://huggingface.co/lerobot/pi05_base)
42
+ - **Robot type:** `so_follower`
43
+ - **Cameras:** `side`, `workspace`, `hand`
44
+
45
+
46
+ ## Inputs & Outputs
47
+
48
+ The policy consumes these observation features and produces these action features.
49
+
50
+ **Inputs**
51
+
52
+ | Feature | Type | Shape |
53
+ | --- | --- | --- |
54
+ | `observation.images.base_0_rgb` | VISUAL | `(3, 224, 224)` |
55
+ | `observation.images.left_wrist_0_rgb` | VISUAL | `(3, 224, 224)` |
56
+ | `observation.images.right_wrist_0_rgb` | VISUAL | `(3, 224, 224)` |
57
+ | `observation.state` | STATE | `(32,)` |
58
+
59
+ **Outputs**
60
+
61
+ | Feature | Type | Shape |
62
+ | --- | --- | --- |
63
+ | `action` | ACTION | `(6,)` |
64
+
65
+
66
+ ## Training Dataset
67
+
68
+ - **Repository:** [ViVi-AI/so101_grab_pink_cube_merged](https://huggingface.co/datasets/ViVi-AI/so101_grab_pink_cube_merged)
69
+ - **Episodes:** 140
70
+ - **Frames:** 111154
71
+ - **Frame rate:** 30 FPS
72
+ - **Task(s):** "Grab the pink cube and place it in the white square"
73
+
74
+ <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=ViVi-AI/so101_grab_pink_cube_merged">
75
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
76
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
77
+ </a>
78
+
79
+
80
+ ## Training Configuration
81
+
82
+ | Setting | Value |
83
+ | --- | --- |
84
+ | Training steps | 10000 |
85
+ | Batch size | 24 |
86
+ | Optimizer | adamw |
87
+ | Learning rate | 2.5e-05 |
88
+ | Seed | 42 |
89
+ | LeRobot version | 0.6.1 |
90
+
91
+ ---
92
+
93
+ ## How to Get Started with the Model
94
+
95
+ New to LeRobot? These guides cover the full workflow:
96
+
97
+ - **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
98
+ - **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
99
+ - **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
100
+ - **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
101
+
102
+ The short version to run and train this policy:
103
+
104
+ ### Run the policy on your robot
105
+
106
+ ```bash
107
+ lerobot-rollout \
108
+ --strategy.type=base \
109
+ --robot.type=so_follower \
110
+ --robot.port=<your_robot_port> \
111
+ --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}}" \
112
+ --policy.path=ViVi-AI/pi05_grab_pink_cube \
113
+ --task="Grab the pink cube and place it in the white square" \
114
+ --duration=60
115
+ ```
116
+
117
+ 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.
118
+
119
+ 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).
120
+
121
+ ### Train your own policy
122
+
123
+ This policy type is usually fine-tuned from the pretrained base model [lerobot/pi05_base](https://huggingface.co/lerobot/pi05_base):
124
+
125
+ ```bash
126
+ lerobot-train \
127
+ --dataset.repo_id=${HF_USER}/<dataset> \
128
+ --policy.path=lerobot/pi05_base \
129
+ --output_dir=outputs/train/<policy_repo_id> \
130
+ --job_name=lerobot_training \
131
+ --policy.device=cuda \
132
+ --policy.repo_id=${HF_USER}/<policy_repo_id> \
133
+ --wandb.enable=true
134
+ ```
135
+
136
+ _Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
137
+
138
+ ---
139
+
140
+ ## Evaluation
141
+
142
+ <!-- Report real-robot results here: run the policy several times per task and count the
143
+ successes. Delete the "No evaluation results" line and fill in this table instead:
144
+
145
+ | Task | Trials | Successes | Success rate |
146
+ | ---- | ------ | --------- | ------------ |
147
+ | pick the lego brick | 10 | 8 | 80% |
148
+
149
+ Also worth noting: anything that affects difficulty (new object positions, lighting,
150
+ distractors, a different robot of the same type, ...).
151
+ -->
152
+
153
+ _No evaluation results have been provided for this policy yet._
154
+
155
+ ---
156
+
157
+ ## Citation
158
+
159
+ If you use this policy, please cite the method linked in the description above, along with LeRobot:
160
+
161
+ ```bibtex
162
+ @misc{cadene2024lerobot,
163
+ 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},
164
+ title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
165
+ howpublished = "\url{https://github.com/huggingface/lerobot}",
166
+ year = {2024}
167
+ }
168
+ ```
config.json ADDED
@@ -0,0 +1,108 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "type": "pi05",
3
+ "n_obs_steps": 1,
4
+ "input_features": {
5
+ "observation.images.base_0_rgb": {
6
+ "type": "VISUAL",
7
+ "shape": [
8
+ 3,
9
+ 224,
10
+ 224
11
+ ]
12
+ },
13
+ "observation.images.left_wrist_0_rgb": {
14
+ "type": "VISUAL",
15
+ "shape": [
16
+ 3,
17
+ 224,
18
+ 224
19
+ ]
20
+ },
21
+ "observation.images.right_wrist_0_rgb": {
22
+ "type": "VISUAL",
23
+ "shape": [
24
+ 3,
25
+ 224,
26
+ 224
27
+ ]
28
+ },
29
+ "observation.state": {
30
+ "type": "STATE",
31
+ "shape": [
32
+ 32
33
+ ]
34
+ }
35
+ },
36
+ "output_features": {
37
+ "action": {
38
+ "type": "ACTION",
39
+ "shape": [
40
+ 6
41
+ ]
42
+ }
43
+ },
44
+ "device": "cuda",
45
+ "use_amp": false,
46
+ "use_peft": false,
47
+ "push_to_hub": true,
48
+ "repo_id": "ViVi-AI/pi05_grab_pink_cube",
49
+ "private": null,
50
+ "tags": null,
51
+ "license": null,
52
+ "pretrained_path": "lerobot/pi05_base",
53
+ "pretrained_revision": null,
54
+ "paligemma_variant": "gemma_2b",
55
+ "action_expert_variant": "gemma_300m",
56
+ "dtype": "bfloat16",
57
+ "chunk_size": 50,
58
+ "n_action_steps": 50,
59
+ "max_state_dim": 32,
60
+ "max_action_dim": 32,
61
+ "num_inference_steps": 10,
62
+ "time_sampling_beta_alpha": 1.5,
63
+ "time_sampling_beta_beta": 1.0,
64
+ "time_sampling_scale": 0.999,
65
+ "time_sampling_offset": 0.001,
66
+ "min_period": 0.004,
67
+ "max_period": 4.0,
68
+ "use_relative_actions": false,
69
+ "relative_exclude_joints": [
70
+ "gripper"
71
+ ],
72
+ "action_feature_names": [
73
+ "shoulder_pan.pos",
74
+ "shoulder_lift.pos",
75
+ "elbow_flex.pos",
76
+ "wrist_flex.pos",
77
+ "wrist_roll.pos",
78
+ "gripper.pos"
79
+ ],
80
+ "rtc_config": null,
81
+ "image_resolution": [
82
+ 224,
83
+ 224
84
+ ],
85
+ "empty_cameras": 0,
86
+ "tokenizer_max_length": 200,
87
+ "normalization_mapping": {
88
+ "VISUAL": "IDENTITY",
89
+ "STATE": "QUANTILES",
90
+ "ACTION": "QUANTILES"
91
+ },
92
+ "gradient_checkpointing": true,
93
+ "compile_model": true,
94
+ "compile_mode": "max-autotune",
95
+ "freeze_vision_encoder": true,
96
+ "train_expert_only": true,
97
+ "optimizer_lr": 2.5e-05,
98
+ "optimizer_betas": [
99
+ 0.9,
100
+ 0.95
101
+ ],
102
+ "optimizer_eps": 1e-08,
103
+ "optimizer_weight_decay": 0.01,
104
+ "optimizer_grad_clip_norm": 1.0,
105
+ "scheduler_warmup_steps": 1000,
106
+ "scheduler_decay_steps": 30000,
107
+ "scheduler_decay_lr": 2.5e-06
108
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:01d3918f76b4e03b61f62445244070498b6f3b02cfe2024194ff2d0749eec090
3
+ size 9354050752
train_config.json ADDED
@@ -0,0 +1,265 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "dataset": {
3
+ "repo_id": "ViVi-AI/so101_grab_pink_cube_merged",
4
+ "root": null,
5
+ "episodes": null,
6
+ "image_transforms": {
7
+ "enable": true,
8
+ "max_num_transforms": 4,
9
+ "random_order": false,
10
+ "tfs": {
11
+ "brightness": {
12
+ "weight": 1.0,
13
+ "type": "ColorJitter",
14
+ "kwargs": {
15
+ "brightness": [
16
+ 0.8,
17
+ 1.2
18
+ ]
19
+ }
20
+ },
21
+ "contrast": {
22
+ "weight": 1.0,
23
+ "type": "ColorJitter",
24
+ "kwargs": {
25
+ "contrast": [
26
+ 0.8,
27
+ 1.2
28
+ ]
29
+ }
30
+ },
31
+ "saturation": {
32
+ "weight": 1.0,
33
+ "type": "ColorJitter",
34
+ "kwargs": {
35
+ "saturation": [
36
+ 0.5,
37
+ 1.5
38
+ ]
39
+ }
40
+ },
41
+ "hue": {
42
+ "weight": 1.0,
43
+ "type": "ColorJitter",
44
+ "kwargs": {
45
+ "hue": [
46
+ -0.05,
47
+ 0.05
48
+ ]
49
+ }
50
+ },
51
+ "sharpness": {
52
+ "weight": 1.0,
53
+ "type": "SharpnessJitter",
54
+ "kwargs": {
55
+ "sharpness": [
56
+ 0.5,
57
+ 1.5
58
+ ]
59
+ }
60
+ },
61
+ "affine": {
62
+ "weight": 1.0,
63
+ "type": "RandomAffine",
64
+ "kwargs": {
65
+ "degrees": [
66
+ -5.0,
67
+ 5.0
68
+ ],
69
+ "translate": [
70
+ 0.05,
71
+ 0.05
72
+ ]
73
+ }
74
+ }
75
+ }
76
+ },
77
+ "revision": null,
78
+ "use_imagenet_stats": true,
79
+ "video_backend": "torchcodec",
80
+ "return_uint8": false,
81
+ "depth_output_unit": "mm",
82
+ "streaming": false,
83
+ "eval_split": 0.1
84
+ },
85
+ "env": null,
86
+ "policy": {
87
+ "type": "pi05",
88
+ "n_obs_steps": 1,
89
+ "input_features": {
90
+ "observation.images.base_0_rgb": {
91
+ "type": "VISUAL",
92
+ "shape": [
93
+ 3,
94
+ 224,
95
+ 224
96
+ ]
97
+ },
98
+ "observation.images.left_wrist_0_rgb": {
99
+ "type": "VISUAL",
100
+ "shape": [
101
+ 3,
102
+ 224,
103
+ 224
104
+ ]
105
+ },
106
+ "observation.images.right_wrist_0_rgb": {
107
+ "type": "VISUAL",
108
+ "shape": [
109
+ 3,
110
+ 224,
111
+ 224
112
+ ]
113
+ },
114
+ "observation.state": {
115
+ "type": "STATE",
116
+ "shape": [
117
+ 32
118
+ ]
119
+ }
120
+ },
121
+ "output_features": {
122
+ "action": {
123
+ "type": "ACTION",
124
+ "shape": [
125
+ 6
126
+ ]
127
+ }
128
+ },
129
+ "device": "cuda",
130
+ "use_amp": false,
131
+ "use_peft": false,
132
+ "push_to_hub": true,
133
+ "repo_id": "ViVi-AI/pi05_grab_pink_cube",
134
+ "private": null,
135
+ "tags": null,
136
+ "license": null,
137
+ "pretrained_path": "lerobot/pi05_base",
138
+ "pretrained_revision": null,
139
+ "paligemma_variant": "gemma_2b",
140
+ "action_expert_variant": "gemma_300m",
141
+ "dtype": "bfloat16",
142
+ "chunk_size": 50,
143
+ "n_action_steps": 50,
144
+ "max_state_dim": 32,
145
+ "max_action_dim": 32,
146
+ "num_inference_steps": 10,
147
+ "time_sampling_beta_alpha": 1.5,
148
+ "time_sampling_beta_beta": 1.0,
149
+ "time_sampling_scale": 0.999,
150
+ "time_sampling_offset": 0.001,
151
+ "min_period": 0.004,
152
+ "max_period": 4.0,
153
+ "use_relative_actions": false,
154
+ "relative_exclude_joints": [
155
+ "gripper"
156
+ ],
157
+ "action_feature_names": [
158
+ "shoulder_pan.pos",
159
+ "shoulder_lift.pos",
160
+ "elbow_flex.pos",
161
+ "wrist_flex.pos",
162
+ "wrist_roll.pos",
163
+ "gripper.pos"
164
+ ],
165
+ "rtc_config": null,
166
+ "image_resolution": [
167
+ 224,
168
+ 224
169
+ ],
170
+ "empty_cameras": 0,
171
+ "tokenizer_max_length": 200,
172
+ "normalization_mapping": {
173
+ "VISUAL": "IDENTITY",
174
+ "STATE": "QUANTILES",
175
+ "ACTION": "QUANTILES"
176
+ },
177
+ "gradient_checkpointing": true,
178
+ "compile_model": true,
179
+ "compile_mode": "max-autotune",
180
+ "freeze_vision_encoder": true,
181
+ "train_expert_only": true,
182
+ "optimizer_lr": 2.5e-05,
183
+ "optimizer_betas": [
184
+ 0.9,
185
+ 0.95
186
+ ],
187
+ "optimizer_eps": 1e-08,
188
+ "optimizer_weight_decay": 0.01,
189
+ "optimizer_grad_clip_norm": 1.0,
190
+ "scheduler_warmup_steps": 1000,
191
+ "scheduler_decay_steps": 30000,
192
+ "scheduler_decay_lr": 2.5e-06
193
+ },
194
+ "reward_model": null,
195
+ "output_dir": "outputs/train/pi05_grab_pink_cube",
196
+ "job_name": "pi05_grab_pink_cube",
197
+ "resume": false,
198
+ "seed": 42,
199
+ "cudnn_deterministic": false,
200
+ "num_workers": 4,
201
+ "batch_size": 24,
202
+ "prefetch_factor": 4,
203
+ "persistent_workers": true,
204
+ "steps": 10000,
205
+ "env_eval_freq": 20000,
206
+ "log_freq": 100,
207
+ "eval_steps": 500,
208
+ "max_eval_samples": 0,
209
+ "tolerance_s": 0.0001,
210
+ "save_checkpoint": true,
211
+ "save_freq": 500,
212
+ "use_policy_training_preset": true,
213
+ "optimizer": {
214
+ "type": "adamw",
215
+ "lr": 2.5e-05,
216
+ "weight_decay": 0.01,
217
+ "grad_clip_norm": 1.0,
218
+ "betas": [
219
+ 0.9,
220
+ 0.95
221
+ ],
222
+ "eps": 1e-08
223
+ },
224
+ "scheduler": {
225
+ "type": "cosine_decay_with_warmup",
226
+ "num_warmup_steps": 1000,
227
+ "num_decay_steps": 30000,
228
+ "peak_lr": 2.5e-05,
229
+ "decay_lr": 2.5e-06
230
+ },
231
+ "eval": {
232
+ "n_episodes": 50,
233
+ "batch_size": 22,
234
+ "use_async_envs": true,
235
+ "recording": false,
236
+ "recording_repo_id": null,
237
+ "recording_private": false
238
+ },
239
+ "wandb": {
240
+ "enable": true,
241
+ "disable_artifact": false,
242
+ "project": "lerobot",
243
+ "entity": null,
244
+ "notes": null,
245
+ "run_id": "j67mkzdx",
246
+ "mode": null,
247
+ "add_tags": true
248
+ },
249
+ "peft": null,
250
+ "job": {
251
+ "target": null,
252
+ "image": "huggingface/lerobot-gpu:latest",
253
+ "timeout": "2d",
254
+ "detach": false,
255
+ "tags": []
256
+ },
257
+ "save_checkpoint_to_hub": false,
258
+ "sample_weighting": null,
259
+ "rename_map": {
260
+ "observation.images.workspace": "observation.images.base_0_rgb",
261
+ "observation.images.hand": "observation.images.left_wrist_0_rgb",
262
+ "observation.images.side": "observation.images.right_wrist_0_rgb"
263
+ },
264
+ "checkpoint_path": null
265
+ }