AdrielP commited on
Commit
adb92bd
·
verified ·
1 Parent(s): 8221dc8

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -48
README.md CHANGED
@@ -1,62 +1,44 @@
1
  ---
2
- datasets: AdrielP/cables_il_only_black
3
- library_name: lerobot
4
  license: apache-2.0
5
- model_name: act
6
- pipeline_tag: robotics
7
  tags:
8
  - robotics
9
- - lerobot
10
  - act
 
 
 
 
 
 
11
  ---
12
 
13
- # Model Card for act
14
-
15
- <!-- Provide a quick summary of what the model is/does. -->
16
-
17
-
18
- [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.
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
  license: apache-2.0
3
+ library_name: lerobot
 
4
  tags:
5
  - robotics
 
6
  - act
7
+ - imitation-learning
8
+ - so101
9
+ - cable-sorting
10
+ datasets:
11
+ - AdrielP/cables_il_only_black
12
+ pipeline_tag: robotics
13
  ---
14
 
15
+ # ACT - Cable Sorting (Only Black)
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
+ Modelo de Imitation Learning entrenado con Action Chunking Transformers (ACT) para ordenamiento de cables con el robot SO101.
 
18
 
19
+ ## Tarea
20
+ Cuando **solo el cable negro** está visible → el robot quita el cable amarillo y lo coloca en la caja amarilla.
21
 
22
+ ## Detalles de entrenamiento
23
+ - **Algoritmo:** Behaviour Cloning con ACT
24
+ - **Dataset:** AdrielP/cables_il_only_black
25
+ - **Episodios:** 100 demostraciones
26
+ - **Steps:** 50,000
27
+ - **Batch size:** 8
28
+ - **Robot:** SO101 Follower
29
+ - **Cámaras:** front (640x480) + side (640x480) a 30fps
 
 
30
 
31
+ ## Cómo usar
 
 
32
 
33
  ```bash
34
  lerobot-record \
35
+ --robot.type=so101_follower \
36
+ --robot.port=/dev/ttyACM0 \
37
+ --robot.cameras='{"front":{"type":"opencv","index_or_path":0,"width":640,"height":480,"fps":30},"side":{"type":"opencv","index_or_path":2,"width":640,"height":480,"fps":30}}' \
38
+ --policy.path=AdrielP/act_only_black \
39
+ --dataset.repo_id=AdrielP/eval_only_black \
40
+ --dataset.single_task="state based cable sorting" \
41
+ --dataset.num_episodes=5 \
42
+ --dataset.fps=15 \
43
+ --play_sounds=false
44
+ ```