Horizooon commited on
Commit
b2fc686
·
verified ·
1 Parent(s): 0d627fe

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +80 -0
README.md CHANGED
@@ -1,3 +1,83 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ library_name: lerobot
4
+ pipeline_tag: robotics
5
+ datasets:
6
+ - Hiwonder-robot/cube_to_plate
7
+ tags:
8
+ - lerobot
9
+ - so-arm101
10
+ - robotics
11
+ - imitation-learning
12
+ - manipulation
13
+ - cube2plate
14
  ---
15
+
16
+ # SO-ARM101 Cube2Plate Policy
17
+
18
+ This model is a LeRobot policy trained for the SO-ARM101 robotic arm on the Cube2Plate task.
19
+
20
+ The policy is used to control the SO-ARM101 robotic arm to pick up a cube and place it onto a plate.
21
+
22
+ ## Model Details
23
+
24
+ - **Robot:** SO-ARM101
25
+ - **Task:** Cube2Plate
26
+ - **Framework:** LeRobot
27
+ - **Model type:** Imitation learning policy
28
+ - **License:** Apache-2.0
29
+ - **Training dataset:** [Hiwonder-robot/cube_to_plate](https://huggingface.co/datasets/Hiwonder-robot/cube_to_plate)
30
+
31
+ ## Intended Use
32
+
33
+ This model is intended for running and evaluating the Cube2Plate task with the SO-ARM101 robotic arm.
34
+
35
+ It can be used for:
36
+
37
+ - SO-ARM101 robotic arm control
38
+ - Cube-to-plate manipulation task
39
+ - LeRobot policy evaluation
40
+ - Imitation learning experiments
41
+
42
+ ## How to Use
43
+
44
+ You can run evaluation or inference with LeRobot:
45
+
46
+ ```bash
47
+ lerobot-record \
48
+ --robot.type=so101_follower \
49
+ --dataset.repo_id=${HF_USER}/eval_so101 \
50
+ --policy.path=${HF_USER}/Cube2Plate \
51
+ --episodes=10
52
+ ```
53
+
54
+ If the following folder already exists locally:
55
+
56
+ ```bash
57
+ C:/Users/Admin/Desktop/lerobot/${HF_USER}/eval_so101
58
+ ```
59
+
60
+ please delete it before running the command again.
61
+
62
+ ## Training Data
63
+
64
+ This model was trained using demonstration data collected for the Cube2Plate task with the SO-ARM101 robotic arm.
65
+
66
+ Dataset:
67
+
68
+ [Hiwonder-robot/cube_to_plate](https://huggingface.co/datasets/Hiwonder-robot/cube_to_plate)
69
+
70
+ ## Evaluation
71
+
72
+ The model can be evaluated by running the trained policy on the SO-ARM101 robotic arm and checking whether the cube is successfully placed onto the plate.
73
+
74
+ ## Limitations
75
+
76
+ - This model is designed only for the Cube2Plate task.
77
+ - Performance may be affected by camera position, lighting conditions, object position, and robot calibration.
78
+ - The model may not generalize well to different objects, environments, or robot configurations.
79
+ - Please run the robot carefully to avoid collision or hardware damage.
80
+
81
+ ## More Information
82
+
83
+ This model was trained and uploaded using the LeRobot framework.