Add Robotics tag and metadata

#4
by reach-vb - opened
Files changed (1) hide show
  1. README.md +44 -0
README.md ADDED
@@ -0,0 +1,44 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: lerobot/smolvla_base
3
+ library_name: lerobot
4
+ license: apache-2.0
5
+ model_name: smolvla
6
+ pipeline_tag: robotics
7
+ tags:
8
+ - robotics
9
+ - smolvla
10
+ ---
11
+
12
+ # Model Card for mobile_so100_test
13
+
14
+ <!-- Provide a quick summary of what the model is/does. -->
15
+
16
+ [SmolVLA](https://huggingface.co/papers/2506.01844) is a compact, efficient vision-language-action model that achieves competitive performance at reduced computational costs and can be deployed on consumer-grade hardware.
17
+
18
+ This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot).
19
+ See the full documentation at [LeRobot Docs](https://huggingface.co/docs/lerobot/index).
20
+
21
+ ---
22
+
23
+ ## How to Get Started with the Model
24
+
25
+ For a complete walkthrough, see the [training guide](https://huggingface.co/docs/lerobot/il_robots#train-a-policy).
26
+ Below is the short version on how to train and run inference/eval:
27
+
28
+ ### Train from scratch
29
+
30
+ ```bash
31
+ python lerobot/scripts/train.py --dataset.repo_id=<user_or_org>/<dataset> --policy.type=act --output_dir=outputs/train/<desired_policy_repo_id> --job_name=lerobot_training --policy.device=cuda --policy.repo_id=<user_or_org>/<desired_policy_repo_id> --wandb.enable=true
32
+ ```
33
+
34
+ *Writes checkpoints to `outputs/train/<desired_policy_repo_id>/checkpoints/`.*
35
+
36
+ ### Evaluate the policy
37
+
38
+ ```bash
39
+ python -m lerobot.record --robot.type=so100_follower --dataset.repo_id=<user_or_org>/eval_<dataset> --policy.path=<user_or_org>/<desired_policy_repo_id> --episodes=10
40
+ ```
41
+
42
+ Prefix the dataset repo with **eval_** and supply `--policy.path` pointing to a local or hub checkpoint.
43
+
44
+ ---