chore(docs): update docs (#911)

This commit is contained in:
Steven Palma 2025-03-27 09:55:06 +01:00 committed by GitHub
parent 90533e6b9f
commit 78fd1a1e04
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 12 additions and 13 deletions

View File

@ -108,9 +108,8 @@ Install 🤗 LeRobot:
pip install --no-binary=av -e . pip install --no-binary=av -e .
``` ```
> **NOTE:** Depending on your platform, If you encounter any build errors during this step > **NOTE:** If you encounter build errors, you may need to install additional dependencies (`cmake`, `build-essential`, and `ffmpeg libs`). On Linux, run:
you may need to install `cmake` and `build-essential` for building some of our dependencies. `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`. For other systems, see: [Compiling PyAV](https://pyav.org/docs/develop/overview/installation.html#bring-your-own-ffmpeg)
On linux: `sudo apt-get install cmake build-essential`
For simulations, 🤗 LeRobot comes with gymnasium environments that can be installed as extras: For simulations, 🤗 LeRobot comes with gymnasium environments that can be installed as extras:
- [aloha](https://github.com/huggingface/gym-aloha) - [aloha](https://github.com/huggingface/gym-aloha)
@ -119,7 +118,7 @@ For simulations, 🤗 LeRobot comes with gymnasium environments that can be inst
For instance, to install 🤗 LeRobot with aloha and pusht, use: For instance, to install 🤗 LeRobot with aloha and pusht, use:
```bash ```bash
pip install -e ".[aloha, pusht]" pip install --no-binary=av -e ".[aloha, pusht]"
``` ```
To use [Weights and Biases](https://docs.wandb.ai/quickstart) for experiment tracking, log in with To use [Weights and Biases](https://docs.wandb.ai/quickstart) for experiment tracking, log in with

View File

@ -59,7 +59,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
#### 5. Install LeRobot with dependencies for the feetech motors: #### 5. Install LeRobot with dependencies for the feetech motors:
```bash ```bash
cd ~/lerobot && pip install -e ".[feetech]" cd ~/lerobot && pip install --no-binary=av -e ".[feetech]"
``` ```
Great :hugs:! You are now done installing LeRobot and we can begin assembling the SO100 arms :robot:. Great :hugs:! You are now done installing LeRobot and we can begin assembling the SO100 arms :robot:.

View File

@ -69,7 +69,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
#### 5. Install LeRobot with dependencies for the feetech motors: #### 5. Install LeRobot with dependencies for the feetech motors:
```bash ```bash
cd ~/lerobot && pip install -e ".[feetech]" cd ~/lerobot && pip install --no-binary=av -e ".[feetech]"
``` ```
## C. Install LeRobot on laptop ## C. Install LeRobot on laptop
@ -110,7 +110,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
#### 5. Install LeRobot with dependencies for the feetech motors: #### 5. Install LeRobot with dependencies for the feetech motors:
```bash ```bash
cd ~/lerobot && pip install -e ".[feetech]" cd ~/lerobot && pip install --no-binary=av -e ".[feetech]"
``` ```
Great :hugs:! You are now done installing LeRobot and we can begin assembling the SO100 arms and Mobile base :robot:. Great :hugs:! You are now done installing LeRobot and we can begin assembling the SO100 arms and Mobile base :robot:.

View File

@ -33,7 +33,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
5. Install LeRobot with dependencies for the feetech motors: 5. Install LeRobot with dependencies for the feetech motors:
```bash ```bash
cd ~/lerobot && pip install -e ".[feetech]" cd ~/lerobot && pip install --no-binary=av -e ".[feetech]"
``` ```
## Configure the motors ## Configure the motors

View File

@ -18,7 +18,7 @@ training outputs directory. In the latter case, you might want to run examples/3
It requires the installation of the 'gym_pusht' simulation environment. Install it by running: It requires the installation of the 'gym_pusht' simulation environment. Install it by running:
```bash ```bash
pip install -e ".[pusht]"` pip install --no-binary=av -e ".[pusht]"`
``` ```
""" """

View File

@ -33,7 +33,7 @@ First, install the additional dependencies required for robots built with dynami
Using `pip`: Using `pip`:
```bash ```bash
pip install -e ".[dynamixel]" pip install --no-binary=av -e ".[dynamixel]"
``` ```
Using `poetry`: Using `poetry`:

View File

@ -45,7 +45,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
6. Install LeRobot with stretch dependencies: 6. Install LeRobot with stretch dependencies:
```bash ```bash
cd ~/lerobot && pip install -e ".[stretch]" cd ~/lerobot && pip install --no-binary=av -e ".[stretch]"
``` ```
> **Note:** If you get this message, you can ignore it: `ERROR: pip's dependency resolver does not currently take into account all the packages that are installed.` > **Note:** If you get this message, you can ignore it: `ERROR: pip's dependency resolver does not currently take into account all the packages that are installed.`

View File

@ -32,7 +32,7 @@ git clone https://github.com/huggingface/lerobot.git ~/lerobot
5. Install LeRobot with dependencies for the Aloha motors (dynamixel) and cameras (intelrealsense): 5. Install LeRobot with dependencies for the Aloha motors (dynamixel) and cameras (intelrealsense):
```bash ```bash
cd ~/lerobot && pip install -e ".[dynamixel, intelrealsense]" cd ~/lerobot && pip install --no-binary=av -e ".[dynamixel, intelrealsense]"
``` ```
## Teleoperate ## Teleoperate

View File

@ -24,7 +24,7 @@ Designed by Physical Intelligence. Ported from Jax by Hugging Face.
Install pi0 extra dependencies: Install pi0 extra dependencies:
```bash ```bash
pip install -e ".[pi0]" pip install --no-binary=av -e ".[pi0]"
``` ```
Example of finetuning the pi0 pretrained model (`pi0_base` in `openpi`): Example of finetuning the pi0 pretrained model (`pi0_base` in `openpi`):