iFaz commited on
Commit
3f51d62
ยท
verified ยท
1 Parent(s): 7b90c61

Add auto-generated model card from override dicts

Browse files
Files changed (1) hide show
  1. README.md +64 -36
README.md CHANGED
@@ -1,62 +1,90 @@
1
  ---
2
- datasets: lerobot/pusht
 
 
3
  library_name: lerobot
4
  license: apache-2.0
5
- model_name: diffusion
6
- pipeline_tag: robotics
7
  tags:
8
- - diffusion
9
- - lerobot
10
  - robotics
 
 
 
 
11
  ---
12
 
13
- # Model Card for diffusion
 
 
 
 
 
 
14
 
15
- <!-- Provide a quick summary of what the model is/does. -->
16
 
 
 
 
17
 
18
- [Diffusion Policy](https://huggingface.co/papers/2303.04137) treats visuomotor control as a generative diffusion process, producing smooth, multi-step action trajectories that excel at contact-rich manipulation.
19
 
 
20
 
21
- This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
22
- See the full documentation at [LeRobot Docs](https://huggingface.co/docs/lerobot/index).
 
 
 
 
 
 
 
 
 
23
 
24
  ---
25
 
26
- ## How to Get Started with the Model
27
 
28
- For a complete walkthrough, see the [training guide](https://huggingface.co/docs/lerobot/il_robots#train-a-policy).
29
- Below is the short version on how to train and run inference/eval:
 
 
30
 
31
- ### Train from scratch
32
 
33
- ```bash
34
- lerobot-train \
35
- --dataset.repo_id=${HF_USER}/<dataset> \
36
- --policy.type=act \
37
- --output_dir=outputs/train/<desired_policy_repo_id> \
38
- --job_name=lerobot_training \
39
- --policy.device=cuda \
40
- --policy.repo_id=${HF_USER}/<desired_policy_repo_id>
41
- --wandb.enable=true
42
- ```
43
 
44
- _Writes checkpoints to `outputs/train/<desired_policy_repo_id>/checkpoints/`._
 
 
 
 
 
 
 
45
 
46
- ### Evaluate the policy/run inference
47
 
48
- ```bash
49
- lerobot-record \
50
- --robot.type=so100_follower \
51
- --dataset.repo_id=<hf_user>/eval_<dataset> \
52
- --policy.path=<hf_user>/<desired_policy_repo_id> \
53
- --episodes=10
54
- ```
55
 
56
- Prefix the dataset repo with **eval\_** and supply `--policy.path` pointing to a local or hub checkpoint.
 
 
 
 
 
 
57
 
58
  ---
59
 
60
- ## Model Details
61
 
62
- - **License:** apache-2.0
 
 
 
 
 
 
 
 
1
  ---
2
+ datasets:
3
+ - lerobot/pusht
4
+ language: en
5
  library_name: lerobot
6
  license: apache-2.0
 
 
7
  tags:
 
 
8
  - robotics
9
+ - imitation-learning
10
+ - diffusion
11
+ - mujoco
12
+ - pytorch_model_hub_mixin
13
  ---
14
 
15
+ # DIFFUSION Policy โ€” diffusion_pusht_seed3
16
+
17
+ Trained with [LeRobot](https://github.com/huggingface/lerobot).
18
+ Date: `2026-05-29 02:01`
19
+ Policy type: `diffusion` | Device: `cuda`
20
+
21
+ ---
22
 
23
+ ## ๐Ÿ“ฆ Dataset
24
 
25
+ | Parameter | Value |
26
+ |---|---|
27
+ | `dataset.repo_id` | `lerobot/pusht` |
28
 
29
+ ---
30
 
31
+ ## ๐Ÿ‹๏ธ Training Config
32
 
33
+ | Parameter | Value |
34
+ |---|---|
35
+ | `steps` | `70000` |
36
+ | `batch_size` | `8` |
37
+ | `eval_freq` | `0` |
38
+ | `save_freq` | `20000` |
39
+ | `num_workers` | `4` |
40
+ | `seed` | `3` |
41
+ | `eval.n_episodes` | `1` |
42
+ | `eval.batch_size` | `1` |
43
+ | `eval.use_async_envs` | `True` |
44
 
45
  ---
46
 
47
+ ## ๐Ÿ“ Policy Architecture
48
 
49
+ | Parameter | Value |
50
+ |---|---|
51
+ | `noise_scheduler_type` | `DDIM` |
52
+ | `num_inference_steps` | `15` |
53
 
54
+ ---
55
 
56
+ ## ๐ŸŽฏ Eval Config
 
 
 
 
 
 
 
 
 
57
 
58
+ | Parameter | Value |
59
+ |---|---|
60
+ | `env.type` | `pusht` |
61
+ | `env.task` | `PushT-v0` |
62
+ | `eval.n_episodes` | `8` |
63
+ | `eval.batch_size` | `4` |
64
+ | `eval.use_async_envs` | `False` |
65
+ | `policy.path` | `/kaggle/working/outputs/train/pusht_seed3/checkpoints/last/pretrained_model` |
66
 
67
+ ---
68
 
69
+ ## ๐Ÿ“Š Eval Results
 
 
 
 
 
 
70
 
71
+ | Metric | Value |
72
+ |---|---|
73
+ | Episodes | `8` |
74
+ | Success rate | `12.5%` |
75
+ | Avg sum reward | `84.67` |
76
+ | Avg max reward | `0.66` |
77
+ | Eval time (s) | `48.2` |
78
 
79
  ---
80
 
81
+ ## Citation
82
 
83
+ ```bibtex
84
+ @misc{cadene2024lerobot,
85
+ author = {Cadene, Remi and Alibert, Simon and others},
86
+ title = {LeRobot},
87
+ year = {2024},
88
+ url = {https://github.com/huggingface/lerobot}
89
+ }
90
+ ```