Skip to content

Commit b70bd42

Browse files
authored
Updates cuRobo installation instructions and added VRAM baseline perf to SkillGen docs (#3796)
### Description - Add a concise installation caveat for cuRobo when Omniverse Kit/Isaac Sim environment scripts set `PYTHONPATH`/`PYTHONHOME`, with simple mitigations. - Clarify `TORCH_CUDA_ARCH_LIST` usage (match GPU compute capability; add `+PTX` for forward compatibility). - Consolidate and document VRAM usage baselines and GPU recommendations for both Vanilla Cube Stacking and Adaptive Bin Cube Stacking (measured over 10 demos on RTX 6000 Ada 48 GB). - Minor wording fixes for consistency (e.g., “adaptive bin cube stacking”). - **Dependencies**: None ### Type of change - Documentation update ### Checklist - [x] I have read and understood the contribution guidelines - [x] I have run the `pre-commit` checks with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension’s `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there
1 parent 995070d commit b70bd42

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

docs/source/overview/imitation-learning/skillgen.rst

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,24 @@ cuRobo provides the motion planning capabilities for SkillGen. This installation
6161

6262
* cuRobo is installed from source and is editable installed. This means that the cuRobo source code will be cloned in the current directory under ``src/nvidia-curobo``. Users can choose their working directory to install cuRobo.
6363

64+
* ``TORCH_CUDA_ARCH_LIST`` in the above command should match your GPU's CUDA compute capability (e.g., ``8.0`` for A100, ``8.6`` for many RTX 30‑series, ``8.9`` for RTX 4090); the ``+PTX`` suffix embeds PTX for forward compatibility so newer GPUs can JIT‑compile when native SASS isn’t included.
65+
66+
.. warning::
67+
68+
**cuRobo installation may fail if Isaac Sim environment scripts are sourced**
69+
70+
Sourcing Omniverse Kit/Isaac Sim environment scripts (for example, ``setup_conda_env.sh``) exports ``PYTHONHOME`` and ``PYTHONPATH`` to the Kit runtime and its pre-bundled Python packages. During cuRobo installation this can cause ``conda`` to import Omniverse's bundled libraries (e.g., ``requests``/``urllib3``) before initialization, resulting in a crash (often seen as a ``TypeError`` referencing ``omni.kit.pip_archive``).
71+
72+
Do one of the following:
73+
74+
- Install cuRobo from a clean shell that has not sourced any Omniverse/Isaac Sim scripts.
75+
- Temporarily reset or ignore inherited Python environment variables (notably ``PYTHONPATH`` and ``PYTHONHOME``) before invoking Conda, so Kit's Python does not shadow your Conda environment.
76+
- Use Conda mechanisms that do not rely on shell activation and avoid inheriting the current shell's Python variables.
77+
78+
After installation completes, you may source Isaac Lab/Isaac Sim scripts again for normal use.
79+
80+
81+
6482
Step 3: Install Rerun
6583
^^^^^^^^^^^^^^^^^^^^^
6684

@@ -112,7 +130,7 @@ The dataset contains:
112130

113131
* Human demonstrations of Franka arm cube stacking
114132
* Manually annotated subtask boundaries for each demonstration
115-
* Compatible with both basic cube stacking and adaptive bin stacking tasks
133+
* Compatible with both basic cube stacking and adaptive bin cube stacking tasks
116134

117135
Download and Setup
118136
^^^^^^^^^^^^^^^^^^
@@ -346,6 +364,15 @@ Generate the complete adaptive stacking dataset:
346364

347365
If the pre-annotated dataset is used and the data generation command is run with ``--headless`` enabled, the generation time is typically around ~220 minutes for 1000 demonstrations for a single environment on a RTX 6000 Ada GPU.
348366

367+
.. note::
368+
369+
**VRAM usage and GPU recommendations**
370+
371+
Figures measured over 10 generated demonstrations on an RTX 6000 Ada.
372+
* Vanilla Cube Stacking: 1 env ~9.3–9.6 GB steady; 5 envs ~21.8–22.2 GB steady (briefly higher during initialization).
373+
* Adaptive Bin Cube Stacking: 1 env ~9.3–9.6 GB steady; 5 envs ~22.0–22.3 GB steady (briefly higher during initialization).
374+
* Minimum recommended GPU: ≥24 GB VRAM for ``--num_envs`` 1–2; ≥48 GB VRAM for ``--num_envs`` up to ~5.
375+
* To reduce VRAM: prefer ``--headless`` and keep ``--num_envs`` modest. Numbers can vary with scene assets and number of demonstrations.
349376

350377
Learning Policies from SkillGen Data
351378
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)