Getting Started
What is LeRobot?
What is LeRobot?
- Hardware-agnostic robot control interface
- Standardized dataset format hosted on Hugging Face Hub
- State-of-the-art policies for imitation learning, RL, and VLA models
- Tools for data collection, training, and evaluation
What Python version does LeRobot require?
What Python version does LeRobot require?
How do I install LeRobot?
How do I install LeRobot?
What robots does LeRobot support?
What robots does LeRobot support?
- Robot Arms: SO100, Koch, LeKiwi, HopeJR, OpenARM
- Mobile Manipulators: OMX, EarthRover
- Humanoids: Reachy2, Unitree G1
- Teleoperation Devices: Gamepads, Keyboards, Phones
Datasets
How do I load a dataset from the Hugging Face Hub?
How do I load a dataset from the Hugging Face Hub?
LeRobotDataset class:What format are LeRobot datasets?
What format are LeRobot datasets?
- Parquet files for state/action data (efficient columnar storage)
- MP4 videos or images for visual observations
- metadata.json for dataset information
Can I use my own dataset?
Can I use my own dataset?
- Porting Datasets guide
examples/port_datasets/for conversion examples- Dataset tools for merging and manipulating datasets
How do I visualize a dataset?
How do I visualize a dataset?
Training
How do I train a policy?
How do I train a policy?
lerobot-train command:What policies are available?
What policies are available?
- ACT (Action Chunking Transformer)
- Diffusion Policy
- VQ-BeT
- HIL-SERL
- TDMPC
- Pi0Fast, Pi0.5
- GR00T N1.5
- SmolVLA
- XVLA
How long does training take?
How long does training take?
- Policy type: Diffusion policies generally take longer than ACT
- Dataset size: More episodes = longer training
- Hardware: GPU type and number of GPUs
- Hyperparameters: Batch size, number of steps
Can I resume training from a checkpoint?
Can I resume training from a checkpoint?
--resume flag:How do I use multiple GPUs?
How do I use multiple GPUs?
Inference and Deployment
How do I load a pretrained model?
How do I load a pretrained model?
make_policy factory:How do I evaluate a policy?
How do I evaluate a policy?
lerobot-eval command:Can I deploy policies on real robots?
Can I deploy policies on real robots?
- Train your policy on real robot data or simulation
- Load the policy and connect to your robot
- Run the control loop
What about latency in real-time control?
What about latency in real-time control?
- Using async inference (see
examples/tutorial/async-inf/) - Running on GPU for faster inference
- Optimizing with TorchScript or ONNX
- Using action chunking (ACT-style policies)
Hardware Integration
How do I integrate my custom robot?
How do I integrate my custom robot?
Robot interface:- Create a new robot class inheriting from base Robot
- Implement required methods:
connect(),get_observation(),send_action() - Define your robot’s features and configuration
Do I need special hardware?
Do I need special hardware?
- Start with simulation environments (PushT, LIBERO)
- Use low-cost hardware like SO-100 arms
- Implement support for your existing robots
How do I calibrate my robot?
How do I calibrate my robot?
- Follow your robot’s calibration procedure
- Use LeRobot’s calibration tools if available
- Record the calibration parameters in your robot config
Troubleshooting
I'm getting CUDA out of memory errors
I'm getting CUDA out of memory errors
- Reduce batch size in your config
- Use gradient accumulation
- Enable mixed precision training (AMP)
- Use a smaller model variant
- Clear CUDA cache:
torch.cuda.empty_cache()
ffmpeg errors during dataset loading
ffmpeg errors during dataset loading
Where can I get help?
Where can I get help?
- Discord: Join the LeRobot server for community support
- GitHub Issues: Report bugs
- Discussions: Ask questions
- Documentation: Browse the full docs
Contributing
How can I contribute to LeRobot?
How can I contribute to LeRobot?
- Fix bugs or add features
- Improve documentation
- Share datasets on the Hub
- Add support for new robots or policies
- Help others in Discord
Do I need to be an expert to contribute?
Do I need to be an expert to contribute?
- Documentation improvements
- Bug reports
- Example notebooks
- Community support