Instructions to use samithva/task_e_pi05 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- LeRobot
How to use samithva/task_e_pi05 with LeRobot:
- Notebooks
- Google Colab
- Kaggle
| base_model: lerobot/pi05_base | |
| datasets: samithva/teleop_task_e_0627 | |
| library_name: lerobot | |
| license: apache-2.0 | |
| model_name: pi05 | |
| pipeline_tag: robotics | |
| tags: | |
| - pi05 | |
| - robotics | |
| - lerobot | |
| # Model Card for pi05 | |
| <!-- Provide a quick summary of what the model is/does. --> | |
| [π₀.₅ (Pi05)](https://www.physicalintelligence.company/blog/pi05) is a Vision-Language-Action model from Physical Intelligence designed for open-world generalization: it evolves π₀ to generalize to entirely new environments and situations that were never seen during training. The LeRobot implementation is adapted from their open-source OpenPI repository. | |
| <!-- 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/<hf_user>/<policy_repo_id>/resolve/main/demo.gif" width="60%"/> | |
| </p> | |
| --> | |
| This policy has been trained and pushed to the Hub using [LeRobot](https://github.com/huggingface/lerobot). | |
| Learn how to train and run it in the [LeRobot pi05 guide](https://huggingface.co/docs/lerobot/main/en/pi05), or browse the [full documentation](https://huggingface.co/docs/lerobot/index). | |
| --- | |
| ## Model Details | |
| - **License:** apache-2.0 | |
| - **Fine-tuned from:** [lerobot/pi05_base](https://huggingface.co/lerobot/pi05_base) | |
| - **Robot type:** `piper` | |
| - **Cameras:** `ee`, `external` | |
| ## Inputs & Outputs | |
| The policy consumes these observation features and produces these action features. | |
| **Inputs** | |
| | Feature | Type | Shape | | |
| | --- | --- | --- | | |
| | `observation.state` | STATE | `(8,)` | | |
| | `observation.images.ee` | VISUAL | `(3, 480, 640)` | | |
| | `observation.images.external` | VISUAL | `(3, 480, 640)` | | |
| **Outputs** | |
| | Feature | Type | Shape | | |
| | --- | --- | --- | | |
| | `action` | ACTION | `(8,)` | | |
| ## Training Dataset | |
| - **Repository:** [samithva/teleop_task_e_0627](https://huggingface.co/datasets/samithva/teleop_task_e_0627) | |
| - **Episodes:** 226 | |
| - **Frames:** 162912 | |
| - **Frame rate:** 50 FPS | |
| - **Task(s):** "pick and place the objects into the basket" | |
| <a class="flex" href="https://huggingface.co/spaces/lerobot/visualize_dataset?path=samithva/teleop_task_e_0627"> | |
| <img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl.svg"/> | |
| <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/badges/resolve/main/visualize-this-dataset-xl-dark.svg"/> | |
| </a> | |
| ## Training Configuration | |
| | Setting | Value | | |
| | --- | --- | | |
| | Training steps | 1500 | | |
| | Batch size | 32 | | |
| | Optimizer | adamw | | |
| | Learning rate | 2.5e-05 | | |
| | Seed | 1000 | | |
| | LeRobot version | 0.5.2 | | |
| --- | |
| ## 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=piper \ | |
| --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=samithva/task_e_pi05 \ | |
| --task="pick and place the objects into the basket" \ | |
| --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](https://huggingface.co/docs/lerobot/main/en/inference). | |
| ### Train your own policy | |
| This policy type is usually fine-tuned from the pretrained base model [lerobot/pi05_base](https://huggingface.co/lerobot/pi05_base): | |
| ```bash | |
| lerobot-train \ | |
| --dataset.repo_id=${HF_USER}/<dataset> \ | |
| --policy.path=lerobot/pi05_base \ | |
| --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/<policy_repo_id>/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: | |
| | Task | Trials | Successes | Success rate | | |
| | ---- | ------ | --------- | ------------ | | |
| | pick the lego brick | 10 | 8 | 80% | | |
| 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} | |
| } | |
| ``` |