LeRobot documentation
Instalasi
Instalasi
Panduan ini menggunakan conda (via miniforge) untuk mengelola lingkungan (disarankan). Jika Anda lebih memilih manajer lingkungan lain (misalnya uv, venv), pastikan Anda memiliki Python >=3.12 dan dukungan PyTorch >= 2.10, lalu lanjutkan ke Environment Setup.
Langkah 1 (hanya conda): Instal miniforge
wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-$(uname)-$(uname -m).shLangkah 2: Pengaturan Lingkungan
Buat lingkungan virtual dengan Python 3.12:
conda create -y -n lerobot python=3.12
uv python install 3.12 uv venv --python 3.12
Lalu aktifkan lingkungan virtual Anda; Anda harus melakukan ini setiap kali membuka shell untuk menggunakan lerobot:
conda activate lerobot
Saat menginstal LeRobot di dalam WSL (Windows Subsystem for Linux), pastikan untuk juga menginstal
evdev:conda install evdev -c conda-forge
# Linux/macOS
source .venv/bin/activate
# Windows PowerShell
.venv\Scripts\activateSaat menginstal LeRobot di dalam WSL (Windows Subsystem for Linux), pastikan untuk juga menginstal
evdev:sudo apt install libevdev-dev uv pip install evdev
Install ffmpeg (untuk decoding video)
LeRobot menggunakan TorchCodec untuk decoding video secara default, yang membutuhkan ffmpeg.
Dukungan platform: TorchCodec tidak tersedia di macOS Intel (x86_64), Linux ARM (aarch64, arm64, armv7l), atau Windows dengan PyTorch < 2.8. Di platform-platform ini, LeRobot secara otomatis beralih ke
pyav— sehingga Anda tidak perlu menginstalffmpegdan dapat langsung melompat ke Langkah 3.Jetson (aarch64 + CUDA): fallback
pyavdi atas berarti tidak ada dekoding video yang dipercepat GPU secara default.docker/Dockerfile.jetsonmembanguntorch/torchcodecdari sumber dengan dukungan CUDA untuk JetPack 6.2 — dipelihara komunitas, lihatravediamond/lerobot-jetsonuntuk image yang sudah dibangun dan isu #819 untuk latar belakang.
Jika platform Anda mendukung TorchCodec, instal ffmpeg menggunakan salah satu metode di bawah ini:
Instal ffmpeg di lingkungan conda Anda. Ini berfungsi dengan semua versi PyTorch dan wajib untuk PyTorch < 2.10:
conda install ffmpeg -c conda-forge
Ini biasanya menginstal
ffmpeg 8.Xdengan encoderlibsvtav1. Jika Anda mengalami masalah (misalnyalibsvtav1tidak ada — periksa denganffmpeg -encoders— atau ketidakcocokan versi dengantorchcodec), Anda dapat secara eksplisit menginstalffmpeg 7.1.1menggunakan:conda install ffmpeg=7.1.1 -c conda-forge
Mulai dari PyTorch >= 2.10 (TorchCodec ≥ 0.10), TorchCodec dapat melakukan tautan dinamis ke instalasi ffmpeg sistem. Hal ini berguna saat menggunakan uv atau manajer lingkungan non-conda lainnya:
# Ubuntu/Debian
sudo apt install ffmpeg
# macOS (Apple Silicon)
brew install ffmpeg
ffmpegsistem hanya didukung dengan PyTorch >= 2.10 (TorchCodec ≥ 0.10). Untuk versi PyTorch yang lebih lama, Anda harus menggunakanconda install ffmpeg -c conda-forgesebagai gantinya.
Langkah 3: Instal LeRobot 🤗
Instalasi lerobot dasar sengaja dibuat ringan — hanya mencakup dependensi ML inti (PyTorch, torchvision, numpy, opencv, einops, draccus, huggingface-hub, gymnasium, safetensors). Dependensi yang lebih berat diaktifkan melalui ekstra opsional sehingga Anda hanya menginstal apa yang Anda butuhkan.
Dari Sumber
Pertama, klon repositori dan masuk ke direktori:
git clone https://github.com/huggingface/lerobot.git
cd lerobotLalu, instal pustaka dalam mode dapat disunting. Ini berguna jika Anda berencana untuk berkontribusi pada kode.
pip install -e ".[core_scripts]" # For robot workflows (recording, replaying, calibrate)
pip install -e ".[training]" # For training policies
pip install -e ".[all]" # Everything (all policies, envs, hardware, dev tools)uv pip install -e ".[core_scripts]" # For robot workflows (recording, replaying, calibrate)
uv pip install -e ".[training]" # For training policies
uv pip install -e ".[all]" # Everything (all policies, envs, hardware, dev tools)Instalasi dari PyPI
Perpustakaan Inti: Instal paket dasar dengan:
pip install lerobot
uv pip install lerobot
Ini hanya menginstal dependensi inti ML. Anda perlu menambahkan ekstra untuk sebagian besar alur kerja.
Ekstra Fitur: LeRobot menyediakan ekstra yang berfokus pada fitur yang dipetakan ke alur kerja umum. Jika Anda menggunakan uv, ganti pip install dengan uv pip install pada perintah di bawah ini.
| Tambahan | Yang ditambahkan | Kasus penggunaan yang umum |
|---|---|---|
dataset | datasets, av, torchcodec, jsonlines | Memuat & membuat dataset |
training | dataset + accelerate, trackio | Kebijakan pelatihan |
hardware | pynput, pyserial, deepdiff | Menghubungkan ke robot sungguhan |
viz | rerun-sdk, foxglove-sdk | Visualisasi selama perekaman/evaluasi |
Composite Extras menggabungkan fitur tambahan untuk skrip CLI umum:
| Tambahan | Termasuk | Kasus penggunaan yang umum |
|---|---|---|
core_scripts | dataset + hardware + viz | lerobot-record, lerobot-replay, lerobot-calibrate |
evaluation | av | lerobot-eval (tambahkan policy + env extras sesuai kebutuhan) |
dataset_viz | dataset + viz | lerobot-dataset-viz, lerobot-imgtransform-viz |
pip install 'lerobot[core_scripts]' # Record, replay, calibrate
pip install 'lerobot[training]' # Train policies
pip install 'lerobot[core_scripts,training]' # Record + train
pip install 'lerobot[all]' # EverythingEkstra kebijakan, lingkungan, dan perangkat keras masih tersedia untuk dependensi tertentu:
pip install 'lerobot[pi]' # Pi0/Pi0.5/Pi0-FAST policy deps
pip install 'lerobot[smolvla]' # SmolVLA policy deps
pip install 'lerobot[diffusion]' # Diffusion policy deps (diffusers)
pip install 'lerobot[aloha,pusht]' # Simulation environments
pip install 'lerobot[feetech]' # Feetech motor supportBeberapa extras dapat digabungkan (misalnya, .[core_scripts,pi,pusht]). Untuk daftar lengkap extras yang tersedia, lihat pyproject.toml.
Varian PyTorch CUDA (hanya Linux)
Pada Linux, jalur instalasi menentukan wheel CUDA yang Anda dapatkan. Instalasi pada macOS dan Windows menggunakan default PyPI (masing-masing wheel MPS / CPU / CUDA-Windows) dan dapat melewati bagian ini.
Instalasi dari sumber melalui uv (uv sync atau uv pip install -e .)
torch dan torchvision dikunci oleh proyek ke indeks PyTorch CUDA 12.8 (https://download.pytorch.org/whl/cu128, batas driver 570.86) — mencakup GPU Ampere/Ada/Hopper/Blackwell. Tidak perlu tindakan untuk setup NVIDIA yang umum.
Untuk menimpa untuk varian CUDA yang berbeda:
uv pip install --force-reinstall torch torchvision \
--index-url https://download.pytorch.org/whl/cu126 # older drivers; or cu130 for Blackwell on driver ≥ 580Instalasi dari sumber via pip/conda, atau pip install lerobot dari PyPI
Wheel torch default PyPI saat ini adalah wheel Linux yang dibundel dengan cu130, dengan batas bawah driver 580.65.
Untuk memilih varian CUDA tertentu:
Menggunakan pip atau conda — instal torch terlebih dahulu dengan index eksplisit, kemudian lerobot:
pip install --index-url https://download.pytorch.org/whl/cu128 torch torchvision
pip install -e ".[all]" # source
# — or —
pip install lerobot # from PyPIMenggunakan uv untuk menginstal dari PyPI — satu baris via --torch-backend (uv ≥ 0.6):
uv pip install --torch-backend cu128 lerobot
Nilai yang didukung meliputi auto, cpu, cu126, cu128, cu129, cu130, serta berbagai rocm* dan xpu. Ganti sesuai kebutuhan driver Anda.
Pemecahan Masalah
Jika Anda menemukan kesalahan build, Anda mungkin perlu menginstal dependensi sistem tambahan: cmake, build-essential, dan ffmpeg libs.
Untuk menginstal ini di Linux, jalankan:
sudo apt-get install cmake build-essential python3-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-devUntuk sistem lain, lihat: Compiling PyAV
Dependensi opsional
LeRobot menyediakan ekstra opsional untuk fungsionalitas tertentu. Beberapa ekstra dapat digabungkan (misalnya, .[aloha,feetech]). Untuk semua ekstra yang tersedia, lihat pyproject.toml. Jika Anda menggunakan uv, ganti pip install dengan uv pip install pada perintah di bawah ini.
Simulasi
Instal paket lingkungan: aloha (gym-aloha), pusht (gym-pusht), libero (hanya Linux) atau metaworld.
Paket-paket ini secara otomatis menyertakan ekstra dataset.
pip install -e ".[aloha]" # or "[pusht]" for exampleKendali Motor
Install ekstensi untuk motor Anda: dynamixel untuk Koch v1.1, feetech untuk SO100/SO101/Moss. Keduanya berkomunikasi dengan motor melalui rustypot.
pip install -e ".[feetech]" # or "[dynamixel]" for examplePelacakan Eksperimen
Trackio disertakan dalam ekstra training. Eksekusi lokal tidak memerlukan akun atau login: data disimpan dalam database SQLite lokal di bawah ~/.cache/huggingface/trackio. Buka dasbor dengan:
trackio show --project lerobot
Untuk menyinkronkan run ke Hugging Face Space (dibuat jika belum ada), jalankan hf auth login dan berikan --trackio.space_id=<user>/<space>. Remote jobs (--job.target) dengan tracking yang diaktifkan memerlukan space_id, karena database lokal pod hilang ketika job berakhir.
Privasi Space secara default adalah None: Space baru bersifat publik kecuali default organisasi adalah privat. Gunakan --trackio.private=true untuk membuat Space privat.
Setiap run mencatat perintah yang meluncurkannya dan output konsolnya (prints, logs, tracebacks), keduanya ditampilkan di halaman run pada dashboard. Pada Space, keduanya sama mudahnya dilihat dengan Space itu sendiri; gunakan --trackio.capture_console=false untuk menjaga agar output konsol tidak masuk ke dalam run.
Migrasi dari Weights & Biases
| Pengaturan W&B | Pengaturan Trackio |
|---|---|
--wandb.enable=true | --trackio.enable=true |
--wandb.project=<project> | --trackio.project=<project> |
--wandb.disable_artifact=true | Sudah menjadi default; gunakan --trackio.disable_artifact=false untuk mengaktifkan |
--wandb.entity=<team> | Pilih --trackio.space_id=<user-or-org>/<space> untuk logging yang dihosting |
--wandb.run_id=<id> | Gunakan --trackio.run_name=<name> untuk run Trackio yang sudah ada |
--wandb.mode=offline | Hilangkan space_id untuk pencatatan lokal; juga batalkan TRACKIO_SPACE_ID dan TRACKIO_SERVER_URL jika sudah disetel |
--wandb.mode=disabled | --trackio.enable=false |
--wandb.console=off | --trackio.capture_console=false |
Langkah selanjutnya
- Punya robot? Rakit dan kalibrasi robot Anda dengan mengikuti halamannya di bawah Robots di bilah samping (misalnya SO-101), lalu rekam dataset dan latih kebijakan pertama Anda dengan tutorial pembelajaran imitasi.
- Belum punya perangkat keras? Latih dan evaluasi kebijakan dalam simulasi dengan LIBERO, atau coba Colab notebooks.
- Ingin berkontribusi? Baca panduan berkontribusi.
- Simpan lembar contekan di dekat Anda: lembar ini merangkum semua perintah LeRobot di satu tempat.