wangzixiang
/
lerobot
mirror of https://github.com/huggingface/lerobot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes for #57

This commit is contained in:
Simon Alibert 2024-03-28 10:01:33 +01:00
parent 032200e32c
commit 9d9148dad8
1 changed files with 6 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -60,46 +60,21 @@
## Installation ## Installation
As of now, this repository is tested on Python 3.10 and PyTorch 2.2.1. Download our source code:
We don't have a build released yet (coming soon!), so to install 🤗 LeRobot you need to clone this repo first:
```bash ```bash
git clone https://github.com/huggingface/lerobot.git git clone https://github.com/huggingface/lerobot.git
cd lerobot cd lerobot
``` ```
You should install 🤗 LeRobot in a [virtual environment](https://docs.python.org/3/library/venv.html). If you're unfamiliar with Python virtual environments, check out the [user guide](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/). Create a virtual environment with Python 3.10 and activate it, e.g. with [`miniconda`](https://docs.anaconda.com/free/miniconda/index.html):
Create a virtual environment with Python 3.10 and activate it.
Using [`miniconda`](https://docs.anaconda.com/free/miniconda/index.html):
```bash ```bash
conda create -y -n lerobot python=3.10 conda create -y -n lerobot python=3.10
conda activate lerobot conda activate lerobot
``` ```
Using [`pyenv`](https://github.com/pyenv/pyenv):
```bash
pyenv install 3.10
pyenv local 3.10
```
Then, install 🤗 LeRobot: Then, install 🤗 LeRobot:
### With pip
```bash ```bash
pip install . python -m pip install .
```
### With poetry
```bash
poetry install
```
**Note:** If you encounter a disk space error, try to change your `tmp/` dirrectory to a location where you have enough disk space, e.g.
```bash
mkdir ~/tmp
export TMPDIR='~/tmp'
``` ```
To use [Weights and Biases](https://docs.wandb.ai/quickstart) for experiments tracking, log in with To use [Weights and Biases](https://docs.wandb.ai/quickstart) for experiments tracking, log in with
@ -252,11 +227,11 @@ Then, the equivalent of `pip install some-package`, would just be:
poetry add some-package poetry add some-package
``` ```
**NOTE:** Currently, to ensure the CI works properly, any new package must also be added in the CPU-only environment dedicated CI. To do this, you should create a separate environment and add the new package there as well. For example: **NOTE:** Currently, to ensure the CI works properly, any new package must also be added in the CPU-only environment dedicated to the CI. To do this, you should create a separate environment and add the new package there as well. For example:
```bash ```bash
# add the new package to your main poetry env # Add the new package to your main poetry env
poetry add some-package poetry add some-package
# add the same package to the CPU-only env dedicated to CI # Add the same package to the CPU-only env dedicated to CI
conda create -y -n lerobot-ci python=3.10 conda create -y -n lerobot-ci python=3.10
conda activate lerobot-ci conda activate lerobot-ci
cd .github/poetry/cpu cd .github/poetry/cpu