LeRobot 文档
安装
并获得增强的文档体验
开始使用
安装
环境设置
使用 Python 3.10 创建一个虚拟环境,使用 Miniconda
conda create -y -n lerobot python=3.10
然后激活你的 conda 环境,每次打开 shell 使用 lerobot 时都必须这样做
conda activate lerobot
当使用 miniconda
时,在您的环境中安装 ffmpeg
conda install ffmpeg -c conda-forge
这通常会为您的平台安装使用 libsvtav1
编码器编译的 ffmpeg 7.X
。如果不支持 libsvtav1
(使用 ffmpeg -encoders
检查支持的编码器),您可以
- [在任何平台上] 使用以下命令显式安装
ffmpeg 7.X
conda install ffmpeg=7.1.1 -c conda-forge
- [仅限 Linux] 如果您想自带 ffmpeg:安装 ffmpeg 构建依赖项并使用 libsvtav1 从源代码编译 ffmpeg,并确保使用
which ffmpeg
命令来确认您安装的 ffmpeg 二进制文件。
安装 LeRobot 🤗
从源码安装
首先,克隆仓库并进入该目录
git clone https://github.com/huggingface/lerobot.git
cd lerobot
然后,以可编辑模式安装该库。如果您计划为代码做贡献,这会很有用。
pip install -e .
从 PyPI 安装
核心库: 使用以下命令安装基础包
pip install lerobot
这只安装默认的依赖项。
额外功能: 要安装附加功能,请使用以下之一
pip install 'lerobot[all]' # All available features
pip install 'lerobot[aloha,pusht]' # Specific features (Aloha & Pusht)
pip install 'lerobot[feetech]' # Feetech motor support
将 [...]
替换为您所需的功能。
可用标签: 有关可选依赖项的完整列表,请参阅: https://pypi.ac.cn/project/lerobot/
问题排查
如果遇到构建错误,您可能需要安装额外的依赖项:cmake
、build-essential
和 ffmpeg libs
。要在 Linux 上安装这些,请运行
sudo apt-get install cmake build-essential python-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-dev pkg-config
对于其他系统,请参阅:编译 PyAV
可选依赖
LeRobot 为特定功能提供了可选的附加功能。多个附加功能可以组合使用(例如,.[aloha,feetech]
)。有关所有可用附加功能的列表,请参阅 pyproject.toml
。
模拟
安装环境包:aloha
(gym-aloha)、xarm
(gym-xarm) 或 pusht
(gym-pusht)。示例
pip install -e ".[aloha]" # or "[pusht]" for example
电机控制
对于 Koch v1.1,安装 Dynamixel SDK;对于 SO100/SO101/Moss,安装 Feetech SDK。
pip install -e ".[feetech]" # or "[dynamixel]" for example
实验追踪
要使用 Weights and Biases 进行实验追踪,请使用以下命令登录
wandb login
如果您的机器人尚未准备好,您现在可以开始组装。在左侧查找您的机器人类型。然后按照下面的链接将 Lerobot 与您的机器人结合使用。
< > 在 GitHub 上更新