Instructions to use MadmanMischief/act_candy_sort_sim with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- LeRobot
How to use MadmanMischief/act_candy_sort_sim with LeRobot:
# No code snippets available yet for this library. # To use this model, check the repository files and the library's documentation. # Want to help? PRs adding snippets are welcome at: # https://github.com/huggingface/huggingface.js
- Notebooks
- Google Colab
- Kaggle
Add model card
Browse files
README.md
CHANGED
|
@@ -9,36 +9,43 @@ tags:
|
|
| 9 |
- lerobot
|
| 10 |
---
|
| 11 |
|
| 12 |
-
#
|
| 13 |
|
| 14 |
-
|
| 15 |
|
|
|
|
| 16 |
|
| 17 |
-
|
| 18 |
|
|
|
|
|
|
|
| 19 |
|
|
|
|
| 20 |
|
|
|
|
| 21 |
|
| 22 |
-
|
| 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 |
-
|
| 30 |
|
| 31 |
-
|
| 32 |
|
|
|
|
| 33 |
|
| 34 |
-
|
| 35 |
-
|
| 36 |
-
## Model Details
|
| 37 |
-
|
| 38 |
-
- **License:** \[More Information Needed]
|
| 39 |
-
- **Robot type:** `so_follower`
|
| 40 |
-
- **Cameras:** `wrist`, `phone`
|
| 41 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 42 |
|
| 43 |
## Inputs & Outputs
|
| 44 |
|
|
@@ -58,105 +65,6 @@ The policy consumes these observation features and produces these action feature
|
|
| 58 |
| --- | --- | --- |
|
| 59 |
| `action` | ACTION | `(6,)` |
|
| 60 |
|
|
|
|
| 61 |
|
| 62 |
-
|
| 63 |
-
|
| 64 |
-
- **Repository:** [MadmanMischief/so101_candy_sort_sim_half](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort_sim_half)
|
| 65 |
-
- **Episodes:** 55
|
| 66 |
-
- **Frames:** 31125
|
| 67 |
-
- **Frame rate:** 30 FPS
|
| 68 |
-
- **Task(s):** "pick up the blue candy"
|
| 69 |
-
|
| 70 |
-
<a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=MadmanMischief/so101_candy_sort_sim_half">
|
| 71 |
-
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/>
|
| 72 |
-
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/>
|
| 73 |
-
</a>
|
| 74 |
-
|
| 75 |
-
|
| 76 |
-
## Training Configuration
|
| 77 |
-
|
| 78 |
-
| Setting | Value |
|
| 79 |
-
| --- | --- |
|
| 80 |
-
| Training steps | 50000 |
|
| 81 |
-
| Batch size | 16 |
|
| 82 |
-
| Optimizer | adamw |
|
| 83 |
-
| Learning rate | 1e-05 |
|
| 84 |
-
| Seed | 1000 |
|
| 85 |
-
| LeRobot version | 0.6.2 |
|
| 86 |
-
|
| 87 |
-
---
|
| 88 |
-
|
| 89 |
-
## How to Get Started with the Model
|
| 90 |
-
|
| 91 |
-
New to LeRobot? These guides cover the full workflow:
|
| 92 |
-
|
| 93 |
-
- **[Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation)** — set up the `lerobot` package.
|
| 94 |
-
- **[Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide)** — assemble, wire, and calibrate your robot and cameras.
|
| 95 |
-
- **[Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots)** — the end-to-end imitation-learning walkthrough.
|
| 96 |
-
- **[CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet)** — quick reference for the `lerobot-*` commands.
|
| 97 |
-
|
| 98 |
-
The short version to run and train this policy:
|
| 99 |
-
|
| 100 |
-
### Run the policy on your robot
|
| 101 |
-
|
| 102 |
-
```bash
|
| 103 |
-
lerobot-rollout \
|
| 104 |
-
--strategy.type=base \
|
| 105 |
-
--robot.type=so_follower \
|
| 106 |
-
--robot.port=<your_robot_port> \
|
| 107 |
-
--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}}" \
|
| 108 |
-
--policy.path=MadmanMischief/act_candy_sort_sim \
|
| 109 |
-
--task="pick up the blue candy" \
|
| 110 |
-
--duration=60
|
| 111 |
-
```
|
| 112 |
-
|
| 113 |
-
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.
|
| 114 |
-
|
| 115 |
-
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).
|
| 116 |
-
|
| 117 |
-
### Train your own policy
|
| 118 |
-
|
| 119 |
-
```bash
|
| 120 |
-
lerobot-train \
|
| 121 |
-
--dataset.repo_id=${HF_USER}/<dataset> \
|
| 122 |
-
--policy.type=act \
|
| 123 |
-
--output_dir=outputs/train/<policy_repo_id> \
|
| 124 |
-
--job_name=lerobot_training \
|
| 125 |
-
--policy.device=cuda \
|
| 126 |
-
--policy.repo_id=${HF_USER}/<policy_repo_id> \
|
| 127 |
-
--wandb.enable=true
|
| 128 |
-
```
|
| 129 |
-
|
| 130 |
-
_Writes checkpoints to `outputs/train/<policy_repo_id>/checkpoints/`._
|
| 131 |
-
|
| 132 |
-
---
|
| 133 |
-
|
| 134 |
-
## Evaluation
|
| 135 |
-
|
| 136 |
-
<!-- Report real-robot results here: run the policy several times per task and count the
|
| 137 |
-
successes. Delete the "No evaluation results" line and fill in this table instead:
|
| 138 |
-
|
| 139 |
-
| Task | Trials | Successes | Success rate |
|
| 140 |
-
| ---- | ------ | --------- | ------------ |
|
| 141 |
-
| pick the lego brick | 10 | 8 | 80% |
|
| 142 |
-
|
| 143 |
-
Also worth noting: anything that affects difficulty (new object positions, lighting,
|
| 144 |
-
distractors, a different robot of the same type, ...).
|
| 145 |
-
-->
|
| 146 |
-
|
| 147 |
-
_No evaluation results have been provided for this policy yet._
|
| 148 |
-
|
| 149 |
-
---
|
| 150 |
-
|
| 151 |
-
## Citation
|
| 152 |
-
|
| 153 |
-
If you use this policy, please cite the method linked in the description above, along with LeRobot:
|
| 154 |
-
|
| 155 |
-
```bibtex
|
| 156 |
-
@misc{cadene2024lerobot,
|
| 157 |
-
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},
|
| 158 |
-
title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
|
| 159 |
-
howpublished = "\url{https://github.com/huggingface/lerobot}",
|
| 160 |
-
year = {2024}
|
| 161 |
-
}
|
| 162 |
-
```
|
|
|
|
| 9 |
- lerobot
|
| 10 |
---
|
| 11 |
|
| 12 |
+
# ACT, 55 sim demos only — SO101 candy sort
|
| 13 |
|
| 14 |
+
**Task:** teach an SO101 arm (leader/follower teleoperation) to pick the blue candies out of a mixed blue and green pile and drop them on a towel. Language prompt: `"pick up the blue candy"`. Built during the [B1S Hacktober Physical AI 2026](https://www.b1s.ai/hackathons/b1s-hacktober-physical-ai-2026) hackathon with LeRobot 0.6.2.
|
| 15 |
|
| 16 |
+
**Robot:** SO101 follower, 6 joints (pan, lift, elbow, wrist flex, wrist roll, gripper) at 30 Hz. Cameras: `wrist` (USB webcam on the gripper) and `phone` (Android phone beside the table).
|
| 17 |
|
| 18 |
+
## Training
|
| 19 |
|
| 20 |
+
- **Dataset:** [MadmanMischief/so101_candy_sort_sim_half](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort_sim_half)
|
| 21 |
+
- ACT on the L40S, batch 16, 50k steps, on 55 scripted pick-and-place demos recorded in the Isaac Sim twin. Repo root = 50k.
|
| 22 |
|
| 23 |
+
## Results
|
| 24 |
|
| 25 |
+
**Real arm**
|
| 26 |
|
| 27 |
+
- Not run on the arm.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
|
| 29 |
+
**Sim (digital twin)**
|
| 30 |
|
| 31 |
+
- 50k: 0 / 5 (0 / 10), never lifted a blue candy.
|
| 32 |
|
| 33 |
+
Sim scores are out of 5 rollouts (candy layouts seeds 500 to 504) in an Isaac Sim 6.1 / Isaac Lab digital twin; a rollout succeeds when a blue candy ends on the towel within 20 s. The twin uses assisted grasp.
|
| 34 |
|
| 35 |
+
## Run it with LeRobot
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 36 |
|
| 37 |
+
```bash
|
| 38 |
+
lerobot-rollout \
|
| 39 |
+
--strategy.type=base \
|
| 40 |
+
--policy.path=MadmanMischief/act_candy_sort_sim \
|
| 41 |
+
--robot.type=so101_follower \
|
| 42 |
+
--robot.port=/dev/ttyACM0 \
|
| 43 |
+
--robot.id=my_follower_arm \
|
| 44 |
+
--robot.cameras="{ wrist: {type: opencv, index_or_path: /dev/video4, width: 640, height: 480, fps: 30}, phone: {type: opencv, index_or_path: <phone camera>, width: 640, height: 360, fps: 30} }" \
|
| 45 |
+
--task="pick up the blue candy" \
|
| 46 |
+
--duration=40
|
| 47 |
+
```
|
| 48 |
+
The policy expects the image sizes listed under Inputs below (half resolution: wrist 320x240, phone 640x360; we added a `downscale: 2` option to LeRobot's OpenCV camera for the wrist cam). Other checkpoints are under `checkpoints/<step>/pretrained_model` (download with `hf download MadmanMischief/act_candy_sort_sim --include 'checkpoints/<step>/*'`).
|
| 49 |
|
| 50 |
## Inputs & Outputs
|
| 51 |
|
|
|
|
| 65 |
| --- | --- | --- |
|
| 66 |
| `action` | ACTION | `(6,)` |
|
| 67 |
|
| 68 |
+
## Related
|
| 69 |
|
| 70 |
+
Datasets: [so101_candy_sort](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort) · [so101_candy_sort_half_127](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort_half_127) · [so101_candy_sort_sim_half](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort_sim_half) · [so101_candy_sort_mix_half](https://huggingface.co/datasets/MadmanMischief/so101_candy_sort_mix_half) · [so101_candy_grid](https://huggingface.co/datasets/MadmanMischief/so101_candy_grid). RL policy and digital twin: [so101_candy_rl](https://huggingface.co/MadmanMischief/so101_candy_rl).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|