Update README.md to include install (#377)

readme was missing the install command which caused me a lot of issues
to figure out. Run sync then install into conda environment
This commit is contained in:
Jimmy Tanner
2025-03-20 09:49:40 -07:00
committed by GitHub
2 changed files with 4 additions and 3 deletions

View File

@@ -38,6 +38,7 @@ We use [uv](https://docs.astral.sh/uv/) to manage Python dependencies. See the [
```bash
GIT_LFS_SKIP_SMUDGE=1 uv sync
GIT_LFS_SKIP_SMUDGE=1 uv pip install -e .
```
NOTE: `GIT_LFS_SKIP_SMUDGE=1` is needed to pull LeRobot as a dependency.

View File

@@ -28,13 +28,13 @@ uv pip sync examples/aloha_real/requirements.txt
uv pip install -e packages/openpi-client
# Run the robot
python examples/aloha_real/main.py
python -m examples.aloha_real.main
```
Terminal window 2:
```bash
roslaunch --wait aloha ros_nodes.launch
roslaunch aloha ros_nodes.launch
```
Terminal window 3:
@@ -123,4 +123,4 @@ This task involves opening a tupperware filled with food and pouring the content
We provide the [pi0_aloha_pen_uncap config](../../src/openpi/training/config.py) as an example. You should refer to the root [README](../../README.md) for how to run training with the new config.
IMPORTANT: Our base checkpoint includes normalization stats from various common robot configurations. When fine-tuning a base checkpoint with a custom dataset from one of these configurations, we recommend using the corresponding normalization stats provided in the base checkpoint. In the example, this is done by specifying the trossen asset_id and a path to the pretrained checkpoints asset directory within the AssetsConfig.
IMPORTANT: Our base checkpoint includes normalization stats from various common robot configurations. When fine-tuning a base checkpoint with a custom dataset from one of these configurations, we recommend using the corresponding normalization stats provided in the base checkpoint. In the example, this is done by specifying the trossen asset_id and a path to the pretrained checkpoints asset directory within the AssetsConfig.