Robotics
LeRobot
Safetensors
act
marioguzzzman commited on
Commit
ffd4885
·
verified ·
1 Parent(s): 3bfb6b0

Upload policy weights, train config and readme

Browse files
Files changed (4) hide show
  1. README.md +162 -0
  2. config.json +63 -0
  3. model.safetensors +3 -0
  4. train_config.json +195 -0
README.md ADDED
@@ -0,0 +1,162 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets: marioguzzzman/shell_pick_test_20260614_164827
3
+ library_name: lerobot
4
+ license: apache-2.0
5
+ model_name: act
6
+ pipeline_tag: robotics
7
+ tags:
8
+ - act
9
+ - robotics
10
+ - lerobot
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:** `so_follower`
41
+ - **Cameras:** `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 | `(6,)` |
53
+ | `observation.images.wrist` | VISUAL | `(3, 480, 640)` |
54
+
55
+ **Outputs**
56
+
57
+ | Feature | Type | Shape |
58
+ | --- | --- | --- |
59
+ | `action` | ACTION | `(6,)` |
60
+
61
+
62
+ ## Training Dataset
63
+
64
+ - **Repository:** [marioguzzzman/shell_pick_test_20260614_164827](https://huggingface.co/datasets/marioguzzzman/shell_pick_test_20260614_164827)
65
+ - **Episodes:** 5
66
+ - **Frames:** 3000
67
+ - **Frame rate:** 30 FPS
68
+ - **Task(s):** "Pick the shell from the red disc and place it on the orange disc"
69
+
70
+ <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=marioguzzzman/shell_pick_test_20260614_164827">
71
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
72
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
73
+ </a>
74
+
75
+
76
+ ## Training Configuration
77
+
78
+ | Setting | Value |
79
+ | --- | --- |
80
+ | Training steps | 5000 |
81
+ | Batch size | 8 |
82
+ | Optimizer | adamw |
83
+ | Learning rate | 1e-05 |
84
+ | Seed | 1000 |
85
+ | LeRobot version | 0.5.2 |
86
+
87
+ ---
88
+
89
+ ## How to Get Started with the Model
90
+
91
+ New to LeRobot? These guides cover the full workflow:
92
+
93
+ - **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
94
+ - **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
95
+ - **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
96
+ - **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
97
+
98
+ The short version to run and train this policy:
99
+
100
+ ### Run the policy on your robot
101
+
102
+ ```bash
103
+ lerobot-rollout \
104
+ --strategy.type=base \
105
+ --robot.type=so_follower \
106
+ --robot.port=<your_robot_port> \
107
+ --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}}" \
108
+ --policy.path=marioguzzzman/shell_pick_act \
109
+ --task="Pick the shell from the red disc and place it on the orange disc" \
110
+ --duration=60
111
+ ```
112
+
113
+ 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.
114
+
115
+ 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).
116
+
117
+ ### Train your own policy
118
+
119
+ ```bash
120
+ lerobot-train \
121
+ --dataset.repo_id=${HF_USER}/<dataset> \
122
+ --policy.type=act \
123
+ --output_dir=outputs/train/<policy_repo_id> \
124
+ --job_name=lerobot_training \
125
+ --policy.device=cuda \
126
+ --policy.repo_id=${HF_USER}/<policy_repo_id> \
127
+ --wandb.enable=true
128
+ ```
129
+
130
+ _Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
131
+
132
+ ---
133
+
134
+ ## Evaluation
135
+
136
+ <!-- Report real-robot results here: run the policy several times per task and count the
137
+ successes. Delete the "No evaluation results" line and fill in this table instead:
138
+
139
+ | Task | Trials | Successes | Success rate |
140
+ | ---- | ------ | --------- | ------------ |
141
+ | pick the lego brick | 10 | 8 | 80% |
142
+
143
+ Also worth noting: anything that affects difficulty (new object positions, lighting,
144
+ distractors, a different robot of the same type, ...).
145
+ -->
146
+
147
+ _No evaluation results have been provided for this policy yet._
148
+
149
+ ---
150
+
151
+ ## Citation
152
+
153
+ If you use this policy, please cite the method linked in the description above, along with LeRobot:
154
+
155
+ ```bibtex
156
+ @misc{cadene2024lerobot,
157
+ 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},
158
+ title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
159
+ howpublished = "\url{https://github.com/huggingface/lerobot}",
160
+ year = {2024}
161
+ }
162
+ ```
config.json ADDED
@@ -0,0 +1,63 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "type": "act",
3
+ "n_obs_steps": 1,
4
+ "input_features": {
5
+ "observation.state": {
6
+ "type": "STATE",
7
+ "shape": [
8
+ 6
9
+ ]
10
+ },
11
+ "observation.images.wrist": {
12
+ "type": "VISUAL",
13
+ "shape": [
14
+ 3,
15
+ 480,
16
+ 640
17
+ ]
18
+ }
19
+ },
20
+ "output_features": {
21
+ "action": {
22
+ "type": "ACTION",
23
+ "shape": [
24
+ 6
25
+ ]
26
+ }
27
+ },
28
+ "device": "cuda",
29
+ "use_amp": false,
30
+ "use_peft": false,
31
+ "push_to_hub": true,
32
+ "repo_id": "marioguzzzman/shell_pick_act",
33
+ "private": null,
34
+ "tags": null,
35
+ "license": null,
36
+ "pretrained_path": null,
37
+ "chunk_size": 100,
38
+ "n_action_steps": 100,
39
+ "normalization_mapping": {
40
+ "VISUAL": "MEAN_STD",
41
+ "STATE": "MEAN_STD",
42
+ "ACTION": "MEAN_STD"
43
+ },
44
+ "vision_backbone": "resnet18",
45
+ "pretrained_backbone_weights": "ResNet18_Weights.IMAGENET1K_V1",
46
+ "replace_final_stride_with_dilation": false,
47
+ "pre_norm": false,
48
+ "dim_model": 512,
49
+ "n_heads": 8,
50
+ "dim_feedforward": 3200,
51
+ "feedforward_activation": "relu",
52
+ "n_encoder_layers": 4,
53
+ "n_decoder_layers": 1,
54
+ "use_vae": true,
55
+ "latent_dim": 32,
56
+ "n_vae_encoder_layers": 4,
57
+ "temporal_ensemble_coeff": null,
58
+ "dropout": 0.1,
59
+ "kl_weight": 10.0,
60
+ "optimizer_lr": 1e-05,
61
+ "optimizer_weight_decay": 0.0001,
62
+ "optimizer_lr_backbone": 1e-05
63
+ }
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3ea2d79b6fcbeebc228d817fbc626d3b79cea31a057f9692ad4dac2bffdccb55
3
+ size 206699736
train_config.json ADDED
@@ -0,0 +1,195 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "dataset": {
3
+ "repo_id": "marioguzzzman/shell_pick_test_20260614_164827",
4
+ "root": "/mnt/c/Users/mario/.cache/huggingface/lerobot/marioguzzzman/shell_pick_test_20260614_164827",
5
+ "episodes": null,
6
+ "image_transforms": {
7
+ "enable": false,
8
+ "max_num_transforms": 3,
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
+ "streaming": false
82
+ },
83
+ "env": null,
84
+ "policy": {
85
+ "type": "act",
86
+ "n_obs_steps": 1,
87
+ "input_features": {
88
+ "observation.state": {
89
+ "type": "STATE",
90
+ "shape": [
91
+ 6
92
+ ]
93
+ },
94
+ "observation.images.wrist": {
95
+ "type": "VISUAL",
96
+ "shape": [
97
+ 3,
98
+ 480,
99
+ 640
100
+ ]
101
+ }
102
+ },
103
+ "output_features": {
104
+ "action": {
105
+ "type": "ACTION",
106
+ "shape": [
107
+ 6
108
+ ]
109
+ }
110
+ },
111
+ "device": "cuda",
112
+ "use_amp": false,
113
+ "use_peft": false,
114
+ "push_to_hub": true,
115
+ "repo_id": "marioguzzzman/shell_pick_act",
116
+ "private": null,
117
+ "tags": null,
118
+ "license": null,
119
+ "pretrained_path": null,
120
+ "chunk_size": 100,
121
+ "n_action_steps": 100,
122
+ "normalization_mapping": {
123
+ "VISUAL": "MEAN_STD",
124
+ "STATE": "MEAN_STD",
125
+ "ACTION": "MEAN_STD"
126
+ },
127
+ "vision_backbone": "resnet18",
128
+ "pretrained_backbone_weights": "ResNet18_Weights.IMAGENET1K_V1",
129
+ "replace_final_stride_with_dilation": false,
130
+ "pre_norm": false,
131
+ "dim_model": 512,
132
+ "n_heads": 8,
133
+ "dim_feedforward": 3200,
134
+ "feedforward_activation": "relu",
135
+ "n_encoder_layers": 4,
136
+ "n_decoder_layers": 1,
137
+ "use_vae": true,
138
+ "latent_dim": 32,
139
+ "n_vae_encoder_layers": 4,
140
+ "temporal_ensemble_coeff": null,
141
+ "dropout": 0.1,
142
+ "kl_weight": 10.0,
143
+ "optimizer_lr": 1e-05,
144
+ "optimizer_weight_decay": 0.0001,
145
+ "optimizer_lr_backbone": 1e-05
146
+ },
147
+ "reward_model": null,
148
+ "output_dir": "outputs/train/shell_pick_test_act",
149
+ "job_name": "shell_pick_test_act",
150
+ "resume": false,
151
+ "seed": 1000,
152
+ "cudnn_deterministic": false,
153
+ "num_workers": 4,
154
+ "batch_size": 8,
155
+ "prefetch_factor": 4,
156
+ "persistent_workers": true,
157
+ "steps": 5000,
158
+ "eval_freq": 20000,
159
+ "log_freq": 100,
160
+ "tolerance_s": 0.0001,
161
+ "save_checkpoint": true,
162
+ "save_freq": 1000,
163
+ "use_policy_training_preset": true,
164
+ "optimizer": {
165
+ "type": "adamw",
166
+ "lr": 1e-05,
167
+ "weight_decay": 0.0001,
168
+ "grad_clip_norm": 10.0,
169
+ "betas": [
170
+ 0.9,
171
+ 0.999
172
+ ],
173
+ "eps": 1e-08
174
+ },
175
+ "scheduler": null,
176
+ "eval": {
177
+ "n_episodes": 50,
178
+ "batch_size": 16,
179
+ "use_async_envs": true
180
+ },
181
+ "wandb": {
182
+ "enable": false,
183
+ "disable_artifact": false,
184
+ "project": "lerobot",
185
+ "entity": null,
186
+ "notes": null,
187
+ "run_id": null,
188
+ "mode": null,
189
+ "add_tags": true
190
+ },
191
+ "peft": null,
192
+ "sample_weighting": null,
193
+ "rename_map": {},
194
+ "checkpoint_path": null
195
+ }