CoolFace
Modelpublic

DataLabHell/act_so100_sponge_pickandplace

sourceHugging Faceapache-2.0updated 25d agoView on Hugging Face
2likes32downloads
Model Card

Model Card for act

<!-- Provide a quick summary of what the model is/does. -->

Action Chunking with Transformers (ACT) 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.

<!-- A short demo is worth more than any description! Record a GIF/video of the policy running on your robot, upload it to this repo, and embed it here: <p align="center"> <img src="https://huggingface.co/<hfuser>/<policyrepo_id>/resolve/main/demo.gif" width="60%"/> </p> -->

This policy has been trained and pushed to the Hub using LeRobot.

Learn how to train and run it in the LeRobot act guide, or browse the full documentation.


Model Details

  • License: apache-2.0

Inputs & Outputs

The policy consumes these observation features and produces these action features.

Inputs

FeatureTypeShape
observation.stateSTATE(6,)
observation.images.topVISUAL(3, 480, 640)
observation.images.gripperVISUAL(3, 480, 640)
observation.images.frontVISUAL(3, 480, 640)

Outputs

FeatureTypeShape
actionACTION(6,)

How to Get Started with the Model

New to LeRobot? These guides cover the full workflow:

  • [Install LeRobot](https://huggingface.co/docs/lerobot/main/en/installation) — set up the lerobot package.
  • [Hardware setup](https://huggingface.co/docs/lerobot/main/en/hardware_guide) — assemble, wire, and calibrate your robot and cameras.
  • [Record data & train a policy](https://huggingface.co/docs/lerobot/en/il_robots) — the end-to-end imitation-learning walkthrough.
  • [CLI cheat-sheet](https://huggingface.co/docs/lerobot/main/en/cheat-sheet) — quick reference for the lerobot-* commands.

The short version to run and train this policy:

Run the policy on your robot

bash
lerobot-rollout \
  --strategy.type=base \
  --robot.type=<your_robot_type> \
  --robot.port=<your_robot_port> \
  --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}}" \
  --policy.path=tobdeu/act_so100_sponge \
  --task="<your_task_description>" \
  --duration=60

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.

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.

Train your own policy

bash
lerobot-train \
  --dataset.repo_id=${HF_USER}/<dataset> \
  --policy.type=act \
  --output_dir=outputs/train/<policy_repo_id> \
  --job_name=lerobot_training \
  --policy.device=cuda \
  --policy.repo_id=${HF_USER}/<policy_repo_id> \
  --wandb.enable=true

Writes checkpoints to `outputs/train/<policyrepoid>/checkpoints/`.


Evaluation

<!-- Report real-robot results here: run the policy several times per task and count the successes. Delete the "No evaluation results" line and fill in this table instead:

TaskTrialsSuccessesSuccess rate
pick the lego brick10880%

Also worth noting: anything that affects difficulty (new object positions, lighting, distractors, a different robot of the same type, ...). -->

No evaluation results have been provided for this policy yet.


Citation

If you use this policy, please cite the method linked in the description above, along with LeRobot:

bibtex
@misc{cadene2024lerobot,
    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},
    title = {LeRobot: State-of-the-art Machine Learning for Real-World Robotics in Pytorch},
    howpublished = "\url{https://github.com/huggingface/lerobot}",
    year = {2024}
}