CarolinePascal HF Staff maximellerbach HF Staff commited on
Commit
d1e1f93
·
1 Parent(s): f24f9d7

Add model card from LeRobot template (#1)

Browse files

- Add model card from LeRobot template (d1395f9d66844e4d01602f2fe8c49423bff2a116)


Co-authored-by: Maxime Ellerbach <maximellerbach@users.noreply.huggingface.co>

Files changed (1) hide show
  1. README.md +136 -0
README.md ADDED
@@ -0,0 +1,136 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ library_name: lerobot
3
+ license: apache-2.0
4
+ model_name: lingbot_va
5
+ pipeline_tag: robotics
6
+ tags:
7
+ - lerobot
8
+ - lingbot_va
9
+ - robotics
10
+ ---
11
+
12
+ # Model Card for lingbot_va
13
+
14
+ <!-- Provide a quick summary of what the model is/does. -->
15
+
16
+
17
+ [LingBot-VA](https://github.com/Robbyant/lingbot-va) is an autoregressive video-action world-model policy built on the Wan2.2 video-diffusion stack. It interleaves the prediction of future video latents and robot actions in a single autoregressive sequence, feeding observed keyframes back into its KV cache for closed-loop world modeling.
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 lingbot_va guide](https://huggingface.co/docs/lerobot/main/en/lingbot_va), or browse the [full documentation](https://huggingface.co/docs/lerobot/index).
32
+
33
+
34
+ ---
35
+
36
+ ## Model Details
37
+
38
+ - **License:** apache-2.0
39
+
40
+
41
+ ## Inputs & Outputs
42
+
43
+ The policy consumes these observation features and produces these action features.
44
+
45
+ **Inputs**
46
+
47
+ | Feature | Type | Shape |
48
+ | --- | --- | --- |
49
+ | `observation.images.head_camera` | VISUAL | `(3, 256, 256)` |
50
+ | `observation.images.left_camera` | VISUAL | `(3, 256, 256)` |
51
+ | `observation.images.right_camera` | VISUAL | `(3, 256, 256)` |
52
+
53
+ **Outputs**
54
+
55
+ | Feature | Type | Shape |
56
+ | --- | --- | --- |
57
+ | `action` | ACTION | `(16,)` |
58
+
59
+
60
+
61
+ ---
62
+
63
+ ## How to Get Started with the Model
64
+
65
+ New to LeRobot? These guides cover the full workflow:
66
+
67
+ - **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
68
+ - **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
69
+ - **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
70
+ - **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
71
+
72
+ The short version to run and train this policy:
73
+
74
+ ### Run the policy on your robot
75
+
76
+ ```bash
77
+ lerobot-rollout \
78
+ --strategy.type=base \
79
+ --robot.type=<your_robot_type> \
80
+ --robot.port=<your_robot_port> \
81
+ --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}}" \
82
+ --policy.path=lerobot/lingbot_va_robotwin \
83
+ --task="<your_task_description>" \
84
+ --duration=60
85
+ ```
86
+
87
+ 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.
88
+
89
+ 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).
90
+
91
+ ### Train your own policy
92
+
93
+ ```bash
94
+ lerobot-train \
95
+ --dataset.repo_id=${HF_USER}/<dataset> \
96
+ --policy.type=lingbot_va \
97
+ --output_dir=outputs/train/<policy_repo_id> \
98
+ --job_name=lerobot_training \
99
+ --policy.device=cuda \
100
+ --policy.repo_id=${HF_USER}/<policy_repo_id> \
101
+ --wandb.enable=true
102
+ ```
103
+
104
+ _Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
105
+
106
+ ---
107
+
108
+ ## Evaluation
109
+
110
+ <!-- Report real-robot results here: run the policy several times per task and count the
111
+ successes. Delete the "No evaluation results" line and fill in this table instead:
112
+
113
+ | Task | Trials | Successes | Success rate |
114
+ | ---- | ------ | --------- | ------------ |
115
+ | pick the lego brick | 10 | 8 | 80% |
116
+
117
+ Also worth noting: anything that affects difficulty (new object positions, lighting,
118
+ distractors, a different robot of the same type, ...).
119
+ -->
120
+
121
+ _No evaluation results have been provided for this policy yet._
122
+
123
+ ---
124
+
125
+ ## Citation
126
+
127
+ If you use this policy, please cite the method linked in the description above, along with LeRobot:
128
+
129
+ ```bibtex
130
+ @misc{cadene2024lerobot,
131
+ 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},
132
+ title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
133
+ howpublished = "\url{https://github.com/huggingface/lerobot}",
134
+ year = {2024}
135
+ }
136
+ ```