LeRobot documentation

インストール

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

インストール

このガイドでは、conda(miniforge経由)を使用して環境を管理します(推奨)。別の環境マネージャー(例: uv、venv)を優先する場合は、Python >=3.12が利用可能であることを確認し、環境のセットアップに進んでください。

ステップ 1(conda のみ): miniforge をインストール

wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
bash Miniforge3-$(uname)-$(uname -m).sh

ステップ2: 環境のセットアップ

Python 3.12で仮想環境を作成します:

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

次に仮想環境を有効化してください。lerobot を使用するシェルを開くたびに、この手順を実行する必要があります。

conda
uv(PyTorch >= 2.10 のみ)
conda activate lerobot

evdevもインストールしてください。

conda install evdev -c conda-forge

プラットフォーム要件

Apple Silicon 環境では、PyTorch は macOS 14 以降、MPS アクセラレーションは macOS 15 以降が必要です(macOS 14 では、LeRobot は CPU にフォールバックします)。Linux 環境では、デフォルトの PyTorch wheels は 580.65 以降の NVIDIA ドライバーが必要です。古いドライバーを使用する場合は、PyTorch CUDA variantを参照してください。

ffmpeg をインストールします(動画のデコード用)

LeRobotはデフォルトで動画のデコードにTorchCodecを使用しており、これにはffmpegが必要です。

プラットフォームのサポート: TorchCodec は macOS Intel (x86_64) および Linux armv7l では利用できません。これらのプラットフォームでは、LeRobot は自動的に pyav にフォールバックします。そのため、ffmpeg のインストールは不要であり、ステップ 3 にスキップできます。

Jetson (aarch64 + CUDA): 動画デコードはデフォルトでCPU上で実行されます。docker/Dockerfile.jetson は、JetPack 6.2 向けに CUDA サポート付きで torch/torchcodec をソースからビルドします。コミュニティでメンテナンスされており、プリビルドイメージについては ravediamond/lerobot-jetson を、背景については #819 を参照してください。

プラットフォームがTorchCodecをサポートしている場合、以下のいずれかの方法でffmpegをインストールしてください。

conda (PyTorch の任意のバージョン)
uv(PyTorch >= 2.10 のみ)

conda環境にffmpegをインストールしてください。これはすべてのPyTorchバージョンで動作し、PyTorch < 2.10では必須です:

conda install ffmpeg -c conda-forge

通常、libsvtav1エンコーダー付きのffmpeg 8.Xがインストールされます。問題が発生した場合(libsvtav1が欠落している場合(ffmpeg -encodersで確認できます)や、torchcodecとのバージョン不一致など)、以下を使用してffmpeg 7.1.1を明示的にインストールできます。

conda install ffmpeg=7.1.1 -c conda-forge

ステップ 3: LeRobot のインストール 🤗

ベースのlerobotインストールは意図的に軽量に設計されており、コアのML依存関係(PyTorch、torchvision、numpy、opencv、einops、draccus、huggingface-hub、gymnasium、safetensors)のみが含まれます。より重い依存関係はオプションのエクストラに分離されているため、必要なものだけをインストールできます。

ソースから

まず、リポジトリをクローンし、ディレクトリに移動します:

git clone https://github.com/huggingface/lerobot.git
cd lerobot

次に、ライブラリを編集可能モードでインストールします。これは、コードへの貢献を予定している場合に便利です。

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)

PyPIからのインストール

コアライブラリ: 以下のコマンドでベースパッケージをインストールします:

conda
uv
pip install lerobot

これにより、コアのML依存関係のみがインストールされます。ほとんどのワークフローでは、追加のエクストラをインストールする必要があります。

機能別追加機能: LeRobot は、一般的なワークフローに対応する 機能スコープの追加機能 を提供しています。uv を使用している場合は、以下のコマンドで pip install を uv pip install に置き換えてください。

その他追加される機能典型的なユースケース
datasetdatasets, av, torchcodec, jsonlinesデータセットの読み込みと作成
trainingdataset + accelerate, trackioポリシーの学習
hardwarepynput, pyserial, deepdiff実際のロボットへの接続
vizrerun-sdk, foxglove-sdk記録/評価中の可視化

Composite Extrasは、一般的なCLIスクリプト用の機能エクストラを組み合わせます:

その他含まれるもの典型的なユースケース
core_scriptsdataset + hardware + vizlerobot-record, lerobot-replay, lerobot-calibrate
evaluationavlerobot-eval(必要に応じてポリシーと環境の追加項目を指定)
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

ポリシー、環境、およびハードウェアの追加機能は、特定の依存関係に対して引き続き利用可能です:

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

複数のextrasを組み合わせることができます(例: .[core_scripts,pi,pusht])。利用可能なextrasの完全なリストについては、pyproject.tomlを参照してください。

PyTorch CUDA バリアント(Linux のみ)

Linux では、torch と torchvision は PyPI から提供され、そのデフォルトのホイールは CUDA 13 ビルド(ドライバーの最低要件は 580.65)です。macOS と Windows のインストールでは PyPI のデフォルトホイールが使用されるため、このセクションをスキップできます。

古いドライバまたはGPUを使用している場合は、まず対応するPyTorchインデックスからPyTorchをインストールし、その後LeRobotをインストールしてください。PyPIのLinux版TorchCodecもCUDA 13ビルドであるため、CPUインデックスから取得してください(torchが2.11未満の場合は、TorchCodec互換性テーブルから対応するリリースを選択してください):

pip install --index-url https://download.pytorch.org/whl/cu126 torch torchvision
pip install --index-url https://download.pytorch.org/whl/cpu torchcodec
pip install -e ".[all]"          # source
# — or —
pip install lerobot              # from PyPI

cu126は、CUDA 12のみをサポートするドライバー用にPyTorchが保持しているビルドです。torch 2.15にはCUDA 12用のビルドが存在しないため、このインデックスではtorch 2.14がインストールされます。CUDA 12にとどまるということは、torch 2.14またはそれ以前のバージョンにとどまることを意味します。

uv pipでは、--torch-backendでインデックスを1ステップで選択できます。例: uv pip install --torch-backend cu126 lerobot。uv syncは常にコミットされたロックをインストールします。そこでCUDAビルドを変更するには、pyproject.tomlの[tool.uv.index]と[tool.uv.sources]にインデックスを追加し、uv lockを再実行してください。

トラブルシューティング

ビルドエラーが発生した場合は、追加のシステム依存関係 cmake、build-essential、および ffmpeg libs のインストールが必要になる場合があります。 Linux でこれらをインストールするには、次のコマンドを実行します:

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

その他のシステムについては、PyAVのコンパイルを参照してください。

オプションの依存関係

LeRobotには、特定の機能のためのオプションのエクストラが用意されています。複数のエクストラを組み合わせることができます(例: .[aloha,feetech])。利用可能なすべてのエクストラについては、pyproject.tomlを参照してください。uvを使用している場合は、以下のコマンドでpip installをuv pip installに置き換えてください。

シミュレーション

環境パッケージをインストールします: aloha (gym-aloha)、pusht (gym-pusht)、libero (Linux のみ)、または metaworld。 これらは自動的に dataset エクストラを含みます。

pip install -e ".[aloha]" # or "[pusht]" for example

モーター制御

モーター用の追加パッケージをインストールしてください: Koch v1.1 には dynamixel、SO100/SO101/Moss には feetech です。どちらも rustypot を介してモーターと通信します。

pip install -e ".[feetech]" # or "[dynamixel]" for example

実験の追跡

Trackioはtrainingエクストラに同梱されています。ローカルでの実行にはアカウントやログインは不要で、~/.cache/huggingface/trackio配下のローカルSQLiteデータベースに保存されます。ダッシュボードは以下で開けます:

trackio show --project lerobot

Hugging Face Space(存在しない場合は作成されます)にランを同期するには、hf auth login を実行し、--trackio.space_id=<user>/<space> を渡します。トラッキングが有効なリモートジョブ(--job.target)では、ジョブ終了時にポッドのローカルデータベースが失われるため、space_id が必須です。

Space のプライバシー設定はデフォルトで None です。組織のデフォルトがプライベートでない限り、新規の Space は公開になります。プライベートな Space を作成するには、--trackio.private=true を渡してください。

各ランは、そのランを起動したコマンドとコンソール出力(print、ログ、トレースバック)を記録し、これらはダッシュボードのランページに表示されます。Space 上では、Space 自体と同様に公開されます。コンソール出力をランから除外するには、--trackio.capture_console=false を渡してください。

Weights & Biasesからの移行

W&Bの設定Trackioの設定
--wandb.enable=true--trackio.enable=true
--wandb.project=<project>--trackio.project=<project>
--wandb.disable_artifact=trueデフォルトで有効です。オプトインするには--trackio.disable_artifact=falseを使用してください
--wandb.entity=<team>ホスト型ログ記録には--trackio.space_id=<user-or-org>/<space>を選択してください
--wandb.run_id=<id>既存のTrackioランに対して--trackio.run_name=<name>を使用します
--wandb.mode=offlineローカルでのログ出力を行う場合はspace_idを省略してください。また、TRACKIO_SPACE_IDおよびTRACKIO_SERVER_URLが設定されている場合は、それらを解除してください。
--wandb.mode=disabled--trackio.enable=false
--wandb.console=off--trackio.capture_console=false

次のステップ

  • ロボットをお持ちですか? サイドバーの Robots 以下の該当ページ(例: SO-101)に従って組み立てとキャリブレーションを行い、その後、imitation learning tutorial を使ってデータセットを記録し、最初のポリシーを学習してください。
  • まだハードウェアをお持ちでないですか? LIBEROでシミュレーション内でポリシーの学習と評価を行うか、Colabノートブックをお試しください。
  • 貢献したいですか? コントリビューションガイドをお読みください。
  • チートシートを手元に置いておいてください。すべてのLeRobotコマンドが1か所にまとめられています。
Update on GitHub