Skip to content

Commit 161ef85

Browse files
authored
Updates SkillGen documentation for data gen command and success rates (#3702)
# SkillGen documentation: data gen command cleanup and success-rate guidance ## Description This PR updates the SkillGen documentation in `docs/source/overview/imitation-learning/skillgen.rst`: - Removes a redundant `--headless` flag from a data generation command example. - Adds a note with success-rate guidelines and training recommendations for cube stacking and bin cube stacking. - Clarifies minor text details, including correcting the planning phase order to “Retreat → Contact → Approach” for consistency. Motivation: Improve clarity, set realistic expectations on data generation and downstream policy performance, and align docs with actual planner behavior. Dependencies: None ## Type of change - Documentation update ## Checklist - [x] I have read and understood the [contribution guidelines](https://isaac-sim.github.io/IsaacLab/main/source/refs/contributing.html) - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) 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 a77910b commit 161ef85

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

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

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,7 @@ Once satisfied with small-scale results, generate a full training dataset:
280280
--input_file ./datasets/annotated_dataset_skillgen.hdf5 \
281281
--output_file ./datasets/generated_dataset_skillgen_cube_stack.hdf5 \
282282
--task Isaac-Stack-Cube-Franka-IK-Rel-Skillgen-v0 \
283-
--use_skillgen \
284-
--headless
283+
--use_skillgen
285284
286285
.. note::
287286

@@ -357,8 +356,8 @@ Train a state-based policy for the basic cube stacking task:
357356
--algo bc \
358357
--dataset ./datasets/generated_dataset_skillgen_cube_stack.hdf5
359358
360-
Adaptive Bin Stacking Policy
361-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
359+
Adaptive Bin Cube Stacking Policy
360+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
362361

363362
Train a policy for the more complex adaptive bin stacking:
364363

@@ -374,7 +373,7 @@ Train a policy for the more complex adaptive bin stacking:
374373
The training script will save the model checkpoints in the model directory under ``IssacLab/logs/robomimic``.
375374

376375
Evaluating Trained Policies
377-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
376+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
378377

379378
Test your trained policies:
380379

@@ -389,13 +388,22 @@ Test your trained policies:
389388
390389
.. code:: bash
391390
392-
# Adaptive bin stacking evaluation
391+
# Adaptive bin cube stacking evaluation
393392
./isaaclab.sh -p scripts/imitation_learning/robomimic/play.py \
394393
--device cpu \
395394
--task Isaac-Stack-Cube-Bin-Franka-IK-Rel-Mimic-v0 \
396395
--num_rollouts 50 \
397396
--checkpoint /path/to/model_checkpoint.pth
398397
398+
.. note::
399+
400+
**Expected Success Rates and Recommendations for Cube Stacking and Bin Cube Stacking Tasks**
401+
402+
* SkillGen data generation and downstream policy success are sensitive to the task and the quality of dataset annotation, and can show high variance.
403+
* For cube stacking and bin cube stacking, data generation success is typically 40% to 70% when the dataset is properly annotated per the instructions.
404+
* Behavior Cloning (BC) policy success from 1000 generated demonstrations trained for 2000 epochs (default) is typically 40% to 85% for these tasks, depending on data quality.
405+
* Recommendation: Train for the default 2000 epochs with about 1000 generated demonstrations, and evaluate multiple checkpoints saved after the 1000th epoch to select the best-performing policy.
406+
399407
.. _cuRobo-interface-features:
400408

401409
cuRobo Interface Features
@@ -416,9 +424,9 @@ cuRobo Planner (GPU, collision-aware)
416424
* Location: ``isaaclab_mimic/motion_planners/curobo``
417425
* Multi-phase planning:
418426

419-
* Approach → Contact → Retreat phases per subtask
427+
* Retreat → Contact → Approach phases per subtask
420428
* Configurable collision filtering in contact phases
421-
* For SkillGen, approach and retreat phases are collision-free. The transit phase is collision-checked.
429+
* For SkillGen, retreat and approach phases are collision-free. The transit phase is collision-checked.
422430

423431
* World synchronization:
424432

0 commit comments

Comments
 (0)