Skip to content

Commit 6daa579

Browse files
docs: update installation instructions (#1686)
1 parent 06bebd9 commit 6daa579

File tree

2 files changed

+83
-13
lines changed

2 files changed

+83
-13
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@
101101
## Installation
102102

103103
LeRobot works with Python 3.10+ and PyTorch 2.2+.
104+
105+
### Environment Setup
106+
104107
Create a virtual environment with Python 3.10 and activate it, e.g. with [`miniconda`](https://docs.anaconda.com/free/miniconda/index.html):
105108

106109
```bash
@@ -124,10 +127,21 @@ conda install ffmpeg -c conda-forge
124127
>
125128
> - _[On Linux only]_ Install [ffmpeg build dependencies](https://trac.ffmpeg.org/wiki/CompilationGuide/Ubuntu#GettheDependencies) and [compile ffmpeg from source with libsvtav1](https://trac.ffmpeg.org/wiki/CompilationGuide/Ubuntu#libsvtav1), and make sure you use the corresponding ffmpeg binary to your install with `which ffmpeg`.
126129
127-
Install 🤗 LeRobot:
130+
### Install LeRobot 🤗
131+
132+
#### From Source
133+
134+
First, clone the repository and navigate into the directory:
128135
129136
```bash
130-
pip install lerobot
137+
git clone https://github.com/huggingface/lerobot.git
138+
cd lerobot
139+
```
140+
141+
Then, install the library in editable mode. This is useful if you plan to contribute to the code.
142+
143+
```bash
144+
pip install -e .
131145
```
132146

133147
> **NOTE:** If you encounter build errors, you may need to install additional dependencies (`cmake`, `build-essential`, and `ffmpeg libs`). On Linux, run:
@@ -145,6 +159,34 @@ For instance, to install 🤗 LeRobot with aloha and pusht, use:
145159
pip install -e ".[aloha, pusht]"
146160
```
147161

162+
### Installation from PyPI
163+
164+
**Core Library:**
165+
Install the base package with:
166+
167+
```bash
168+
pip install lerobot
169+
```
170+
171+
_This installs only the default dependencies._
172+
173+
**Extra Features:**
174+
To install additional functionality, use one of the following:
175+
176+
```bash
177+
pip install 'lerobot[all]' # All available features
178+
pip install 'lerobot[aloha,pusht]' # Specific features (Aloha & Pusht)
179+
pip install 'lerobot[feetech]' # Feetech motor support
180+
```
181+
182+
_Replace `[...]` with your desired features._
183+
184+
**Available Tags:**
185+
For a full list of optional dependencies, see:
186+
https://pypi.org/project/lerobot/
187+
188+
### Weights & Biases
189+
148190
To use [Weights and Biases](https://docs.wandb.ai/quickstart) for experiment tracking, log in with
149191

150192
```bash

docs/source/installation.mdx

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
# Installation
22

3-
## Install LeRobot
4-
5-
Currently only available from source.
6-
7-
Download our source code:
8-
9-
```bash
10-
git clone https://github.com/huggingface/lerobot.git
11-
cd lerobot
12-
```
3+
## Environment Setup
134

145
Create a virtual environment with Python 3.10, using [`Miniconda`](https://docs.anaconda.com/miniconda/install/#quick-command-line-install)
156

@@ -40,12 +31,49 @@ conda install ffmpeg -c conda-forge
4031
>
4132
> - _[On Linux only]_ If you want to bring your own ffmpeg: Install [ffmpeg build dependencies](https://trac.ffmpeg.org/wiki/CompilationGuide/Ubuntu#GettheDependencies) and [compile ffmpeg from source with libsvtav1](https://trac.ffmpeg.org/wiki/CompilationGuide/Ubuntu#libsvtav1), and make sure you use the corresponding ffmpeg binary to your install with `which ffmpeg`.
4233
43-
Install 🤗 LeRobot:
34+
## Install LeRobot 🤗
35+
36+
### From Source
37+
38+
First, clone the repository and navigate into the directory:
39+
40+
```bash
41+
git clone https://github.com/huggingface/lerobot.git
42+
cd lerobot
43+
```
44+
45+
Then, install the library in editable mode. This is useful if you plan to contribute to the code.
4446

4547
```bash
4648
pip install -e .
4749
```
4850

51+
### Installation from PyPI
52+
53+
**Core Library:**
54+
Install the base package with:
55+
56+
```bash
57+
pip install lerobot
58+
```
59+
60+
_This installs only the default dependencies._
61+
62+
**Extra Features:**
63+
To install additional functionality, use one of the following:
64+
65+
```bash
66+
pip install 'lerobot[all]' # All available features
67+
pip install 'lerobot[aloha,pusht]' # Specific features (Aloha & Pusht)
68+
pip install 'lerobot[feetech]' # Feetech motor support
69+
```
70+
71+
_Replace `[...]` with your desired features._
72+
73+
**Available Tags:**
74+
For a full list of optional dependencies, see:
75+
https://pypi.org/project/lerobot/
76+
4977
### Troubleshooting
5078

5179
If you encounter build errors, you may need to install additional dependencies: `cmake`, `build-essential`, and `ffmpeg libs`.

0 commit comments

Comments
 (0)