LeRobot documentation

Instalasi

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v0.6.1).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

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).sh

Langkah 2: Pengaturan Lingkungan

Buat lingkungan virtual dengan Python 3.12:

conda
uv (hanya PyTorch >= 2.10)
conda create -y -n lerobot python=3.12

Lalu aktifkan lingkungan virtual Anda; Anda harus melakukan ini setiap kali membuka shell untuk menggunakan lerobot:

conda
uv (hanya PyTorch >= 2.10)
conda activate lerobot

Saat menginstal LeRobot di dalam WSL (Windows Subsystem for Linux), pastikan untuk juga menginstal evdev:

conda install evdev -c conda-forge

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 menginstal ffmpeg dan dapat langsung melompat ke Langkah 3.

Jetson (aarch64 + CUDA): fallback pyav di atas berarti tidak ada dekoding video yang dipercepat GPU secara default. docker/Dockerfile.jetson membangun torch/torchcodec dari sumber dengan dukungan CUDA untuk JetPack 6.2 — dipelihara komunitas, lihat ravediamond/lerobot-jetson untuk image yang sudah dibangun dan isu #819 untuk latar belakang.

Jika platform Anda mendukung TorchCodec, instal ffmpeg menggunakan salah satu metode di bawah ini:

conda (versi PyTorch apa pun)
uv (hanya PyTorch >= 2.10)

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.X dengan encoder libsvtav1. Jika Anda mengalami masalah (misalnya libsvtav1 tidak ada — periksa dengan ffmpeg -encoders — atau ketidakcocokan versi dengan torchcodec), Anda dapat secara eksplisit menginstal ffmpeg 7.1.1 menggunakan:

conda install ffmpeg=7.1.1 -c conda-forge

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 lerobot

Lalu, instal pustaka dalam mode dapat disunting. Ini berguna jika Anda berencana untuk berkontribusi pada kode.

conda
uv
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)

Instalasi dari PyPI

Perpustakaan Inti: Instal paket dasar dengan:

conda
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.

TambahanYang ditambahkanKasus penggunaan yang umum
datasetdatasets, av, torchcodec, jsonlinesMemuat & membuat dataset
trainingdataset + accelerate, trackioKebijakan pelatihan
hardwarepynput, pyserial, deepdiffMenghubungkan ke robot sungguhan
vizrerun-sdk, foxglove-sdkVisualisasi selama perekaman/evaluasi

Composite Extras menggabungkan fitur tambahan untuk skrip CLI umum:

TambahanTermasukKasus penggunaan yang umum
core_scriptsdataset + hardware + vizlerobot-record, lerobot-replay, lerobot-calibrate
evaluationavlerobot-eval (tambahkan policy + env extras sesuai kebutuhan)
dataset_vizdataset + vizlerobot-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]'                   # Everything

Ekstra 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 support

Beberapa 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.

uv-source
pip-conda

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 ≥ 580

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-dev

Untuk 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 example

Kendali 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 example

Pelacakan 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&BPengaturan Trackio
--wandb.enable=true--trackio.enable=true
--wandb.project=<project>--trackio.project=<project>
--wandb.disable_artifact=trueSudah 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=offlineHilangkan 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.
Update on GitHub