Skip to content

Commit 78865b2

Browse files
committed
[docs] docs: promote pre-built docker images to top-level section
- Promote 'Pre-built Docker Images' from a ### subsection of 'Option A: Docker Image' to a top-level ## section so it appears in the page TOC alongside the build and source-install options. - Move 'Run the container' under 'Pre-built Docker Images' since the example tags (loongforge/loongforge:${LOONGFORGE_VERSION}[_lerobot]) only exist on the pre-built path; pairing it with the preceding 'docker pull' commands keeps the snippet self-consistent. - Promote 'Dual Python Environment in the LeRobot Image' from #### to ### so it nests correctly under the new top-level section. - Update cross-reference 'see Dual Python Environment above' -> 'below' to match the new ordering. - Mirror the same restructuring in the Chinese translation (docs/source_zh/get_started/installation.md).
1 parent 3141ac1 commit 78865b2

2 files changed

Lines changed: 53 additions & 49 deletions

File tree

docs/source/get_started/installation.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,9 @@ After the build finishes, verify:
8383
docker images | grep loongforge
8484
```
8585

86-
### Pre-built Docker Images
86+
---
87+
88+
## Pre-built Docker Images
8789

8890
LoongForge Docker images are available on Docker Hub:
8991
[https://hub.docker.com/u/loongforge](https://hub.docker.com/u/loongforge).
@@ -108,7 +110,30 @@ docker pull loongforge/loongforge:${LOONGFORGE_VERSION}
108110
docker pull loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot
109111
```
110112

111-
#### Dual Python Environment in the LeRobot Image
113+
### Run the container
114+
115+
```bash
116+
# Set the version tag you want to use, for example: 0.1.1
117+
LOONGFORGE_VERSION=<version>
118+
119+
# Using the base image (LLM/VLM/Diffusion)
120+
docker run --runtime=nvidia --gpus all -itd --rm \
121+
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
122+
-v /path/to/data:/mnt/cluster/LoongForge/ \
123+
loongforge/loongforge:${LOONGFORGE_VERSION} /bin/bash
124+
125+
# Using the LeRobot image (VLA: Pi0.5 + GR00T)
126+
docker run --runtime=nvidia --gpus all -itd --rm \
127+
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
128+
-v /path/to/data:/mnt/cluster/LoongForge/ \
129+
loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot /bin/bash
130+
```
131+
132+
Once inside the container, navigate to `/workspace/LoongForge/examples/` and
133+
launch the desired training script. For GR00T training, remember to activate
134+
the GR00T virtual environment first (see Dual Python Environment below).
135+
136+
### Dual Python Environment in the LeRobot Image
112137

113138
The LeRobot image (`<version>_lerobot`) uses a **dual virtual-environment** setup to resolve
114139
dependency conflicts between Pi0.5 and GR00T:
@@ -138,29 +163,6 @@ deactivate
138163
/opt/venvs/gr00t/bin/torchrun ${DISTRIBUTED_ARGS[@]} ...
139164
```
140165

141-
### Run the container
142-
143-
```bash
144-
# Set the version tag you want to use, for example: 0.1.1
145-
LOONGFORGE_VERSION=<version>
146-
147-
# Using the base image (LLM/VLM/Diffusion)
148-
docker run --runtime=nvidia --gpus all -itd --rm \
149-
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
150-
-v /path/to/data:/mnt/cluster/LoongForge/ \
151-
loongforge/loongforge:${LOONGFORGE_VERSION} /bin/bash
152-
153-
# Using the LeRobot image (VLA: Pi0.5 + GR00T)
154-
docker run --runtime=nvidia --gpus all -itd --rm \
155-
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
156-
-v /path/to/data:/mnt/cluster/LoongForge/ \
157-
loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot /bin/bash
158-
```
159-
160-
Once inside the container, navigate to `/workspace/LoongForge/examples/` and
161-
launch the desired training script. For GR00T training, remember to activate
162-
the GR00T virtual environment first (see Dual Python Environment above).
163-
164166
---
165167

166168
## Option B: Install from Source

docs/source_zh/get_started/installation.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ docker build --build-arg COMPILE_ENV=hopper --build-arg ENABLE_LEROBOT=false \
7575
docker images | grep loongforge
7676
```
7777

78-
### 预构建 Docker 镜像
78+
---
79+
80+
## 预构建 Docker 镜像
7981

8082
LoongForge Docker 镜像保存在 Docker Hub:
8183
[https://hub.docker.com/u/loongforge](https://hub.docker.com/u/loongforge)
@@ -99,7 +101,29 @@ docker pull loongforge/loongforge:${LOONGFORGE_VERSION}
99101
docker pull loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot
100102
```
101103

102-
#### LeRobot 镜像中的双 Python 环境
104+
### 运行容器
105+
106+
```bash
107+
# 设置需要使用的版本 tag,例如:0.1.1
108+
LOONGFORGE_VERSION=<version>
109+
110+
# 使用基础镜像(LLM/VLM/Diffusion)
111+
docker run --runtime=nvidia --gpus all -itd --rm \
112+
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
113+
-v /path/to/data:/mnt/cluster/LoongForge/ \
114+
loongforge/loongforge:${LOONGFORGE_VERSION} /bin/bash
115+
116+
# 使用 LeRobot 镜像(VLA: Pi0.5 + GR00T)
117+
docker run --runtime=nvidia --gpus all -itd --rm \
118+
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
119+
-v /path/to/data:/mnt/cluster/LoongForge/ \
120+
loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot /bin/bash
121+
```
122+
123+
进入容器后,导航到 `/workspace/LoongForge/examples/` 并启动所需的训练脚本。
124+
对于 GR00T 训练,请先激活 GR00T 虚拟环境(参见下方双 Python 环境说明)。
125+
126+
### LeRobot 镜像中的双 Python 环境
103127

104128
LeRobot 镜像(`<version>_lerobot`)使用**双虚拟环境**方案解决 Pi0.5 和 GR00T 之间的依赖冲突:
105129

@@ -128,28 +152,6 @@ deactivate
128152
/opt/venvs/gr00t/bin/torchrun ${DISTRIBUTED_ARGS[@]} ...
129153
```
130154

131-
### 运行容器
132-
133-
```bash
134-
# 设置需要使用的版本 tag,例如:0.1.1
135-
LOONGFORGE_VERSION=<version>
136-
137-
# 使用基础镜像(LLM/VLM/Diffusion)
138-
docker run --runtime=nvidia --gpus all -itd --rm \
139-
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
140-
-v /path/to/data:/mnt/cluster/LoongForge/ \
141-
loongforge/loongforge:${LOONGFORGE_VERSION} /bin/bash
142-
143-
# 使用 LeRobot 镜像(VLA: Pi0.5 + GR00T)
144-
docker run --runtime=nvidia --gpus all -itd --rm \
145-
-v /path/to/your/hf/models:/mnt/cluster/huggingface.co/ \
146-
-v /path/to/data:/mnt/cluster/LoongForge/ \
147-
loongforge/loongforge:${LOONGFORGE_VERSION}_lerobot /bin/bash
148-
```
149-
150-
进入容器后,导航到 `/workspace/LoongForge/examples/` 并启动所需的训练脚本。
151-
对于 GR00T 训练,请先激活 GR00T 虚拟环境(参见上方双 Python 环境说明)。
152-
153155
---
154156

155157
## 方式 B:源码安装

0 commit comments

Comments
 (0)