Robotics
LeRobot
Safetensors
act
krishc12345 commited on
Commit
577ac9a
·
verified ·
1 Parent(s): 75d9170

Upload model card and train config

Browse files
Files changed (2) hide show
  1. README.md +161 -0
  2. train_config.json +288 -0
README.md ADDED
@@ -0,0 +1,161 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ datasets: krishc12345/pick_and_drop_20261110_230247
3
+ library_name: lerobot
4
+ model_name: act
5
+ pipeline_tag: robotics
6
+ tags:
7
+ - robotics
8
+ - lerobot
9
+ - act
10
+ ---
11
+
12
+ # Model Card for act
13
+
14
+ <!-- Provide a quick summary of what the model is/does. -->
15
+
16
+
17
+ [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.
18
+
19
+
20
+
21
+
22
+ <!-- A short demo is worth more than any description! Record a GIF/video of the policy
23
+ running on your robot, upload it to this repo, and embed it here:
24
+ <p align="center">
25
+ <img src="https://huggingface.co/<hf_user>/<policy_repo_id>/resolve/main/demo.gif" width="60%"/>
26
+ </p>
27
+ -->
28
+
29
+ This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
30
+
31
+ 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).
32
+
33
+
34
+ ---
35
+
36
+ ## Model Details
37
+
38
+ - **License:** \[More Information Needed]
39
+ - **Robot type:** `so_follower`
40
+ - **Cameras:** `front`
41
+
42
+
43
+ ## Inputs & Outputs
44
+
45
+ The policy consumes these observation features and produces these action features.
46
+
47
+ **Inputs**
48
+
49
+ | Feature | Type | Shape |
50
+ | --- | --- | --- |
51
+ | `observation.state` | STATE | `(6,)` |
52
+ | `observation.images.front` | VISUAL | `(3, 480, 640)` |
53
+
54
+ **Outputs**
55
+
56
+ | Feature | Type | Shape |
57
+ | --- | --- | --- |
58
+ | `action` | ACTION | `(6,)` |
59
+
60
+
61
+ ## Training Dataset
62
+
63
+ - **Repository:** [krishc12345/pick_and_drop_20261110_230247](https://huggingface.co/datasets/krishc12345/pick_and_drop_20261110_230247)
64
+ - **Episodes:** 32
65
+ - **Frames:** 19364
66
+ - **Frame rate:** 30 FPS
67
+ - **Task(s):** "Pick up the item and drop it into the container."
68
+
69
+ <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=krishc12345/pick_and_drop_20261110_230247">
70
+ <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
71
+ <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
72
+ </a>
73
+
74
+
75
+ ## Training Configuration
76
+
77
+ | Setting | Value |
78
+ | --- | --- |
79
+ | Training steps | 20000 |
80
+ | Batch size | 4 |
81
+ | Optimizer | adamw |
82
+ | Learning rate | 1e-05 |
83
+ | Seed | 1000 |
84
+ | LeRobot version | 0.7.1 |
85
+
86
+ ---
87
+
88
+ ## How to Get Started with the Model
89
+
90
+ New to LeRobot? These guides cover the full workflow:
91
+
92
+ - **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
93
+ - **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
94
+ - **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
95
+ - **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
96
+
97
+ The short version to run and train this policy:
98
+
99
+ ### Run the policy on your robot
100
+
101
+ ```bash
102
+ lerobot-rollout \
103
+ --strategy.type=base \
104
+ --robot.type=so_follower \
105
+ --robot.port=<your_robot_port> \
106
+ --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}}" \
107
+ --policy.path=krishc12345/act_pick_and_drop \
108
+ --task="Pick up the item and drop it into the container." \
109
+ --duration=60
110
+ ```
111
+
112
+ 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.
113
+
114
+ 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).
115
+
116
+ ### Train your own policy
117
+
118
+ ```bash
119
+ lerobot-train \
120
+ --dataset.repo_id=${HF_USER}/<dataset> \
121
+ --policy.type=act \
122
+ --output_dir=outputs/train/<policy_repo_id> \
123
+ --job_name=lerobot_training \
124
+ --policy.device=cuda \
125
+ --policy.repo_id=${HF_USER}/<policy_repo_id> \
126
+ --trackio.enable=true
127
+ ```
128
+
129
+ _Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
130
+
131
+ ---
132
+
133
+ ## Evaluation
134
+
135
+ <!-- Report real-robot results here: run the policy several times per task and count the
136
+ successes. Delete the "No evaluation results" line and fill in this table instead:
137
+
138
+ | Task | Trials | Successes | Success rate |
139
+ | ---- | ------ | --------- | ------------ |
140
+ | pick the lego brick | 10 | 8 | 80% |
141
+
142
+ Also worth noting: anything that affects difficulty (new object positions, lighting,
143
+ distractors, a different robot of the same type, ...).
144
+ -->
145
+
146
+ _No evaluation results have been provided for this policy yet._
147
+
148
+ ---
149
+
150
+ ## Citation
151
+
152
+ If you use this policy, please cite the method linked in the description above, along with LeRobot:
153
+
154
+ ```bibtex
155
+ @misc{cadene2024lerobot,
156
+ 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},
157
+ title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
158
+ howpublished = "\url{https://github.com/huggingface/lerobot}",
159
+ year = {2024}
160
+ }
161
+ ```
train_config.json ADDED
@@ -0,0 +1,288 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "dataset": {
3
+ "repo_id": "krishc12345/pick_and_drop_20261110_230247",
4
+ "repo_type": "dataset",
5
+ "root": "/home/squid/.cache/huggingface/lerobot/krishc12345/pick_and_drop_20261110_230247",
6
+ "episodes": null,
7
+ "exclude_episodes": null,
8
+ "image_transforms": {
9
+ "enable": false,
10
+ "backend": "dataloader",
11
+ "gpu_compile": true,
12
+ "gpu_chunk_size": 32,
13
+ "max_num_transforms": 3,
14
+ "random_order": false,
15
+ "tfs": {
16
+ "brightness": {
17
+ "weight": 1.0,
18
+ "type": "ColorJitter",
19
+ "kwargs": {
20
+ "brightness": [
21
+ 0.8,
22
+ 1.2
23
+ ]
24
+ }
25
+ },
26
+ "contrast": {
27
+ "weight": 1.0,
28
+ "type": "ColorJitter",
29
+ "kwargs": {
30
+ "contrast": [
31
+ 0.8,
32
+ 1.2
33
+ ]
34
+ }
35
+ },
36
+ "saturation": {
37
+ "weight": 1.0,
38
+ "type": "ColorJitter",
39
+ "kwargs": {
40
+ "saturation": [
41
+ 0.5,
42
+ 1.5
43
+ ]
44
+ }
45
+ },
46
+ "hue": {
47
+ "weight": 1.0,
48
+ "type": "ColorJitter",
49
+ "kwargs": {
50
+ "hue": [
51
+ -0.05,
52
+ 0.05
53
+ ]
54
+ }
55
+ },
56
+ "sharpness": {
57
+ "weight": 1.0,
58
+ "type": "SharpnessJitter",
59
+ "kwargs": {
60
+ "sharpness": [
61
+ 0.5,
62
+ 1.5
63
+ ]
64
+ }
65
+ },
66
+ "affine": {
67
+ "weight": 1.0,
68
+ "type": "RandomAffine",
69
+ "kwargs": {
70
+ "degrees": [
71
+ -5.0,
72
+ 5.0
73
+ ],
74
+ "translate": [
75
+ 0.05,
76
+ 0.05
77
+ ]
78
+ }
79
+ }
80
+ }
81
+ },
82
+ "revision": null,
83
+ "use_imagenet_stats": true,
84
+ "video_backend": "torchcodec",
85
+ "return_uint8": false,
86
+ "depth_output_unit": "mm",
87
+ "streaming": false,
88
+ "streaming_episode_pool_size": null,
89
+ "streaming_sampling_strategy": "remaining",
90
+ "streaming_prefetch_episodes": 8,
91
+ "streaming_byte_budget_gb": 8.0,
92
+ "streaming_decode_threads": 2,
93
+ "streaming_decoded_queue_size": 8,
94
+ "streaming_native_http_connections": null,
95
+ "streaming_native_http_subranges": 1,
96
+ "streaming_sidecar_lock_timeout_s": 1800.0,
97
+ "video_decoder_cache_size": null,
98
+ "eval_split": 0.0
99
+ },
100
+ "env": null,
101
+ "policy": {
102
+ "type": "act",
103
+ "n_obs_steps": 1,
104
+ "input_features": {
105
+ "observation.state": {
106
+ "type": "STATE",
107
+ "shape": [
108
+ 6
109
+ ]
110
+ },
111
+ "observation.images.front": {
112
+ "type": "VISUAL",
113
+ "shape": [
114
+ 3,
115
+ 480,
116
+ 640
117
+ ]
118
+ }
119
+ },
120
+ "output_features": {
121
+ "action": {
122
+ "type": "ACTION",
123
+ "shape": [
124
+ 6
125
+ ]
126
+ }
127
+ },
128
+ "device": "cuda",
129
+ "dtype": null,
130
+ "use_amp": false,
131
+ "use_peft": false,
132
+ "push_to_hub": true,
133
+ "repo_id": "krishc12345/act_pick_and_drop",
134
+ "private": null,
135
+ "tags": null,
136
+ "license": null,
137
+ "pretrained_path": null,
138
+ "pretrained_revision": null,
139
+ "chunk_size": 100,
140
+ "n_action_steps": 100,
141
+ "normalization_mapping": {
142
+ "VISUAL": "MEAN_STD",
143
+ "STATE": "MEAN_STD",
144
+ "ACTION": "MEAN_STD"
145
+ },
146
+ "vision_backbone": "resnet18",
147
+ "pretrained_backbone_weights": "ResNet18_Weights.IMAGENET1K_V1",
148
+ "replace_final_stride_with_dilation": 0,
149
+ "pre_norm": false,
150
+ "dim_model": 512,
151
+ "n_heads": 8,
152
+ "dim_feedforward": 3200,
153
+ "feedforward_activation": "relu",
154
+ "n_encoder_layers": 4,
155
+ "n_decoder_layers": 1,
156
+ "use_vae": true,
157
+ "latent_dim": 32,
158
+ "n_vae_encoder_layers": 4,
159
+ "temporal_ensemble_coeff": null,
160
+ "dropout": 0.1,
161
+ "kl_weight": 10.0,
162
+ "optimizer_lr": 1e-05,
163
+ "optimizer_weight_decay": 0.0001,
164
+ "optimizer_lr_backbone": 1e-05,
165
+ "optimizer_fused": null
166
+ },
167
+ "reward_model": null,
168
+ "output_dir": "outputs/train/act_pick_and_drop_v1",
169
+ "job_name": "act_pick_and_drop",
170
+ "resume": true,
171
+ "seed": 1000,
172
+ "cudnn_deterministic": false,
173
+ "tf32": true,
174
+ "num_workers": 2,
175
+ "batch_size": 4,
176
+ "prefetch_factor": 4,
177
+ "persistent_workers": true,
178
+ "dataloader_multiprocessing_context": "spawn",
179
+ "steps": 20000,
180
+ "env_eval_freq": 20000,
181
+ "log_freq": 100,
182
+ "eval_steps": 0,
183
+ "max_eval_samples": 0,
184
+ "tolerance_s": 0.0001,
185
+ "save_checkpoint": true,
186
+ "save_freq": 1000,
187
+ "checkpoint_format": "safetensors",
188
+ "use_policy_training_preset": true,
189
+ "optimizer": {
190
+ "type": "adamw",
191
+ "lr": 1e-05,
192
+ "weight_decay": 0.0001,
193
+ "grad_clip_norm": 10.0,
194
+ "betas": [
195
+ 0.9,
196
+ 0.999
197
+ ],
198
+ "eps": 1e-08,
199
+ "fused": null
200
+ },
201
+ "scheduler": null,
202
+ "parallelism": {
203
+ "dp_replicate": 1,
204
+ "dp_shard": 1,
205
+ "context_parallel": {
206
+ "ring_degree": 1,
207
+ "ulysses_degree": 1
208
+ },
209
+ "cfg_parallel": 1
210
+ },
211
+ "accelerator": {
212
+ "mixed_precision": "no",
213
+ "gradient_accumulation": {
214
+ "steps": 1,
215
+ "sync_each_batch": false
216
+ },
217
+ "grad_scaler": {
218
+ "init_scale": 65536.0,
219
+ "growth_factor": 2.0,
220
+ "backoff_factor": 0.5,
221
+ "growth_interval": 2000
222
+ },
223
+ "fsdp": {
224
+ "reshard_after_forward": true,
225
+ "wrap_modules": null,
226
+ "min_num_params": null,
227
+ "cpu_offload": false,
228
+ "ignored_modules": null,
229
+ "mixed_precision_policy": {
230
+ "param_dtype": null,
231
+ "reduce_dtype": null,
232
+ "output_dtype": null,
233
+ "cast_forward_inputs": true
234
+ }
235
+ },
236
+ "ddp": {
237
+ "find_unused_parameters": true,
238
+ "gradient_as_bucket_view": false,
239
+ "static_graph": false
240
+ },
241
+ "init_process_group": {
242
+ "backend": "nccl",
243
+ "init_method": null,
244
+ "timeout": null
245
+ },
246
+ "compile": {
247
+ "enabled": false,
248
+ "backend": "inductor",
249
+ "mode": null,
250
+ "regional": true
251
+ },
252
+ "activation_checkpointing": {
253
+ "mode": "none"
254
+ }
255
+ },
256
+ "eval": {
257
+ "n_episodes": 50,
258
+ "batch_size": 16,
259
+ "use_async_envs": true,
260
+ "recording": false,
261
+ "recording_repo_id": null,
262
+ "recording_private": false,
263
+ "max_episode_steps": null
264
+ },
265
+ "ema": null,
266
+ "trackio": {
267
+ "enable": false,
268
+ "disable_artifact": true,
269
+ "project": "lerobot",
270
+ "space_id": null,
271
+ "private": null,
272
+ "run_name": null,
273
+ "resume": null,
274
+ "capture_console": true
275
+ },
276
+ "peft": null,
277
+ "job": {
278
+ "target": null,
279
+ "image": "huggingface/lerobot-gpu:latest",
280
+ "timeout": "2d",
281
+ "detach": false,
282
+ "tags": []
283
+ },
284
+ "save_checkpoint_to_hub": false,
285
+ "sample_weighting": null,
286
+ "rename_map": {},
287
+ "checkpoint_path": "outputs/train/act_pick_and_drop_v1/checkpoints/last"
288
+ }