Skip to content

Commit c2eaded

Browse files
author
zhouyunsong
committed
!37 update doc
* 更新文件: add_benchmark.md * 更新文件: training.md * 更新文件: model.md * 更新文件: evaluation.md * 更新文件: train_eval.md * 更新文件: installation.md * 更新文件: train_eval.md
1 parent 0adfee8 commit c2eaded

File tree

6 files changed

+110
-131
lines changed

6 files changed

+110
-131
lines changed

source/en/user_guide/internmanip/quick_start/add_benchmark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ eval_cfg = EvalCfg(
133133
)
134134
```
135135

136-
## 5. Launch the Evaluator
136+
### 5. Launch the Evaluator
137137
```python
138138
python scripts/eval/start_evaluator.py \
139139
--config scripts/eval/configs/custom_on_custom.py

source/en/user_guide/internmanip/quick_start/installation.md

Lines changed: 45 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ InternManip works across most hardware setups.
3535
Just note the following exceptions:
3636
- **GenManip Benchmark** must run on **NVIDIA RTX series GPUs** (e.g., RTX 4090).
3737
- GR00T requires **CUDA 12.4 installed system-wide (not via Conda)**.
38+
- **Miniconda**.
3839

3940
### Overall Requirements
4041
- **OS:** Ubuntu 20.04/22.04
@@ -308,72 +309,18 @@ Optionally, users can customize the virtual environments directory path by passi
308309
./install.sh --venv-dir ./my_envs --model
309310
```
310311
311-
### ⚠️ Troubleshooting
312-
**1. Tips for Slow or Unstable Networks**
313312

314-
If you encounter errors such as timeouts or incomplete downloads, especially in network-restricted or low-bandwidth environments, we recommend the following approaches.
315-
- By default, `uv pip` uses relatively short HTTP timeouts. To extend the timeout, set the following environment variable before installation:
316-
```bash
317-
export UV_HTTP_TIMEOUT=600 # Timeout in seconds (10 minutes)
318-
```
319-
- To ensure successful installation without network interruptions, you can download some large packages first and then install them locally:
320-
```bash
321-
uv pip download -d ./wheelhouse "some-large-package"
322-
uv pip install --no-index --find-links=./wheelhouse "some-large-package"
323-
```
324-
325-
326-
**2. GCC Fails to Compile Due to Missing Dependencies**
327-
328-
When compiling C++ components (e.g., `building ManiSkill2_real2sim`), you might encounter errors related to GCC or missing shared libraries. This guide walks you through how to resolve them without root/sudo permissions.
329-
330-
- Step 1: Use a modern GCC (recommended ≥ 9.3.0). Older system compilers (e.g., GCC 5.x or 7.x) may not support required C++ standards. It's recommended to switch to GCC 9.3.0 or newer:
331-
```bash
332-
export LD_LIBRARY_PATH=${PATH_TO}/gcc/gcc-9.3.0/lib64:${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}
333-
export PATH=${PATH_TO}/gcc/gcc-9.3.0/bin:$PATH
334-
```
335-
> ⚠️ Note: Simply using a newer compiler might not be enough — it may depend on shared libraries that are not available on your system.
336-
- Step 2: Manually install required libraries. If you encounter errors like: `error while loading shared libraries: libmpc.so.2 (libmpfr.so.1, libgmp.so.3)`. If you do have `sudo` privileges, the easiest way is to install the required libraries system-wide using your system package manager.
337-
```bash
338-
sudo apt update
339-
sudo apt install gcc-9 g++-9
340-
```
341-
Or, you need to manually compile and install the following dependencies locally:
342-
```bash
343-
INSTALL_DIR=$HOME/local
344-
mkdir -p "$INSTALL_DIR"
345-
cd "$INSTALL_DIR"
346-
347-
wget https://ftp.gnu.org/gnu/gmp/gmp-6.2.1.tar.xz
348-
tar -xf gmp-6.2.1.tar.xz && cd gmp-6.2.1
349-
./configure --prefix="$INSTALL_DIR"
350-
make -j$(nproc)
351-
make install
352-
cd "$INSTALL_DIR"
353-
354-
wget https://www.mpfr.org/mpfr-current/mpfr-4.2.1.tar.xz
355-
tar -xf mpfr-4.2.1.tar.xz && cd mpfr-4.2.1
356-
./configure --prefix="$INSTALL_DIR" --with-gmp="$INSTALL_DIR"
357-
make -j$(nproc)
358-
make install
359-
cd "$INSTALL_DIR"
313+
```{tips}
314+
Since we install packages via `uv`, if there are network fluctuations causing some packages to fail installing, the process will skip them and still output `✅ install finished`. This does not guarantee that all packages were installed successfully. Therefore, please **check the logs carefully** after installation to see if there are any errors.
315+
```
360316

361-
echo "📦 Installing MPC..."
362-
wget https://ftp.gnu.org/gnu/mpc/mpc-1.3.1.tar.gz
363-
tar -xf mpc-1.3.1.tar.gz && cd mpc-1.3.1
364-
./configure --prefix="$INSTALL_DIR" --with-gmp="$INSTALL_DIR" --with-mpfr="$INSTALL_DIR"
365-
make -j$(nproc)
366-
make install
367-
```
368-
- Step 3 (Optional): Fix Missing `.so` Versions. Sometimes you have the correct library version (e.g., `libgmp.so.10`), but GCC expects an older symlink name (e.g., `libgmp.so.3`). You can fix missing library versions with symlinks.
369-
- Step 4: Export the Library Path. Make sure the compiler can find your locally installed shared libraries:
370-
```bash
371-
export LD_LIBRARY_PATH=$HOME/local/lib:$LD_LIBRARY_PATH
372-
```
373317

318+
```{important}
319+
If you encounter any issues during the installation, please first check the [Troubleshooting](#troubleshooting) section.
320+
```
374321

375322

376-
## Verification (WIP)
323+
## Verification
377324

378325
You can evaluate the pretrained **GR00t-N1** model on the `Simpler-Env` benchmark using a **client-server** architecture. This requires two separate terminal sessions:
379326

@@ -382,7 +329,7 @@ You can evaluate the pretrained **GR00t-N1** model on the `Simpler-Env` benchmar
382329
Activate the environment for the model, and start the policy server:
383330
```bash
384331
source .venv/model/bin/activate
385-
python scripts/eval/start_policy_server.py
332+
python scripts/eval/start_agent_server.py
386333
```
387334
This will start the policy server that listens for observation inputs and sends back action predictions.
388335

@@ -503,9 +450,42 @@ sudo apt install libvulkan1
503450
sudo ldconfig
504451
```
505452

506-
### 4. GCC Fails to Compile Due to Missing Dependencies
453+
### 4. Handling `RuntimeError: vk::PhysicalDevice::createDeviceUnique: ErrorExtensionNotPresent` in SimplerEnv Benchmark
454+
455+
456+
This error is a tricky issue caused by a failed GPU driver installation when running the SimplerEnv benchmark. Many users have reported this problem in the [SimplerEnv GitHub issue #68](https://github.com/simpler-env/SimplerEnv/issues/68).
457+
458+
You may try the suggested solutions there, but they do not always work reliably. Therefore, we provide an alternative approach if you can use container images.
459+
460+
#### Alternative Solution Using Apptainer Container
461+
- Install Apptainer on your system if you haven't already.
462+
- Download a prebuilt container image with SimplerEnv installed from our [Hugging Face repository](https://huggingface.co/InternRobotics/Manishill2/tree/main).
463+
- Run the evaluation inside the container using a command similar to the following:
464+
```bash
465+
apptainer exec --bind /mnt:/mnt --nv path_to_maniskill2.sif path_to_your_python scripts/eval/start_evaluator.py --config run_configs/examples/internmanip_demo.py --server
466+
```
467+
Replace path_to_maniskill2.sif with the actual path to the downloaded container image, and path_to_your_python with the Python interpreter you want to use inside the container.
468+
469+
470+
### 5. Failed to Install `pyzmq` When Building Model Dependency
471+
472+
473+
When installing the `model` environment and encountering the following error:
474+
```bash
475+
Resolved 162 packages in 4.80s
476+
× Failed to build `pyzmq==27.0.1`
477+
├─▶ The build backend returned an error
478+
╰─▶ Call to `scikit_build_core.build.build_wheel` failed (exit status: 1)
479+
```
480+
A recommended approach is to build from source by running:
481+
```bash
482+
./install.sh --model_bfs
483+
```
484+
If this fails with GCC-related errors, please refer to the troubleshooting advice below.
485+
486+
### 6. GCC Fails to Compile Due to Missing Dependencies
507487
508-
When compiling C++ components (e.g., `building ManiSkill2_real2sim`), you might encounter errors related to GCC or missing shared libraries. This guide walks you through how to resolve them without root/sudo permissions.
488+
When compiling C++ components (e.g., `building ManiSkill2_real2sim` or `pyzmq`), you might encounter errors related to GCC or missing shared libraries. This guide walks you through how to resolve them without root/sudo permissions.
509489
510490
- Step 1: Use a modern GCC (recommended ≥ 9.3.0). Older system compilers (e.g., GCC 5.x or 7.x) may not support required C++ standards. It's recommended to switch to GCC 9.3.0 or newer:
511491
```bash
@@ -531,7 +511,7 @@ When compiling C++ components (e.g., `building ManiSkill2_real2sim`), you might
531511
make install
532512
cd "$INSTALL_DIR"
533513
534-
wget https://www.mpfr.org/mpfr-current/mpfr-4.2.1.tar.xz
514+
wget https://www.mpfr.org/mpfr-4.2.1/mpfr-4.2.1.tar.xz
535515
tar -xf mpfr-4.2.1.tar.xz && cd mpfr-4.2.1
536516
./configure --prefix="$INSTALL_DIR" --with-gmp="$INSTALL_DIR"
537517
make -j$(nproc)

source/en/user_guide/internmanip/quick_start/train_eval.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ You can evaluate `pi0` on the `genmanip` benchmark in a single process using the
283283
Activate the environment for the model and start the policy server:
284284
```bash
285285
source .venv/model/bin/activate
286-
python scripts/eval/start_policy_server.py
286+
python scripts/eval/start_agent_server.py
287287
```
288288
This server listens for observation inputs from the environment and responds with action predictions from the model.
289289

source/en/user_guide/internmanip/tutorials/evaluation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Activate the environment for the model and start the policy server:
5151
```bash
5252
# Client-server mode
5353
source .venv/model/bin/activate
54-
python scripts/eval/start_policy_server.py
54+
python scripts/eval/start_agent_server.py
5555
```
5656
This server listens for observation inputs from the environment and responds with action predictions from the model.
5757
#### 🖥 Terminal 2: Launch the Evaluator (Environment Side)

0 commit comments

Comments
 (0)