Add Robotics tag and metadata
Browse filesHi! I'm VB from Hugging Face. Congratulations on your model! I'm opening a quick PR to update the model card to add Robotics metadata.
This PR adds standard Robotics metadata to the model card:
- Added 'Robotics' to tags
- Set pipeline_tag to 'robotics'
These changes help improve discoverability of robotics-related models on the Hugging Face Hub.
README.md
ADDED
@@ -0,0 +1,50 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
library_name: lerobot
|
3 |
+
license: apache-2.0
|
4 |
+
pipeline_tag: robotics
|
5 |
+
tags:
|
6 |
+
- robotics
|
7 |
+
---
|
8 |
+
|
9 |
+
# Model Card for so100_block_bin_model
|
10 |
+
|
11 |
+
<!-- Provide a quick summary of what the model is/does. -->
|
12 |
+
|
13 |
+
This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
|
14 |
+
See the full documentation at [LeRobot Docs](https://huggingface.co/docs/lerobot/index).
|
15 |
+
|
16 |
+
---
|
17 |
+
|
18 |
+
## How to Get Started with the Model
|
19 |
+
|
20 |
+
For a complete walkthrough, see the [training guide](https://huggingface.co/docs/lerobot/il_robots#train-a-policy).
|
21 |
+
Below is the short version on how to train and run inference/eval:
|
22 |
+
|
23 |
+
### Train from scratch
|
24 |
+
|
25 |
+
```bash
|
26 |
+
python lerobot/scripts/train.py \
|
27 |
+
--dataset.repo_id=<user_or_org>/<dataset> \
|
28 |
+
--policy.type=act \
|
29 |
+
--output_dir=outputs/train/<desired_policy_repo_id> \
|
30 |
+
--job_name=lerobot_training \
|
31 |
+
--policy.device=cuda \
|
32 |
+
--policy.repo_id=<user_or_org>/<desired_policy_repo_id> \
|
33 |
+
--wandb.enable=true
|
34 |
+
```
|
35 |
+
|
36 |
+
*Writes checkpoints to `outputs/train/<desired_policy_repo_id>/checkpoints/`.*
|
37 |
+
|
38 |
+
### Evaluate the policy
|
39 |
+
|
40 |
+
```bash
|
41 |
+
python -m lerobot.record \
|
42 |
+
--robot.type=so100_follower \
|
43 |
+
--dataset.repo_id=<user_or_org>/eval_<dataset> \
|
44 |
+
--policy.path=<user_or_org>/<desired_policy_repo_id> \
|
45 |
+
--episodes=10
|
46 |
+
```
|
47 |
+
|
48 |
+
Prefix the dataset repo with **eval_** and supply `--policy.path` pointing to a local or hub checkpoint.
|
49 |
+
|
50 |
+
---
|