[Docs] Merge and clean up RL docs - #7437
Conversation
Greptile SummaryThe PR consolidates the reinforcement-learning documentation around the Isaac Lab 3.0 CLI and adds a reproducible ANYmal-D learning-progression media workflow.
Confidence Score: 3/5The PR should not merge until the media generator selects an emitted final checkpoint and the removed documentation URLs are preserved or redirected. A fresh media-generation run stops when it looks for model_299.pt after a 300-iteration training run, and deleting the legacy source pages leaves existing repository links pointing to missing generated pages. Files Needing Attention: tools/docs/media/generate_reinforcement_learning.sh; docs/source/overview/reinforcement-learning/rl_existing_scripts.rst; docs/source/overview/reinforcement-learning/rl_frameworks.rst Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart LR
Train[Train ANYmal-D for 300 iterations] --> Saves[RSL-RL saves checkpoints]
Saves --> Select[Select iterations 0, 100, and final]
Select --> Play[Play each checkpoint with OVRTX]
Play --> Clips[Write three MP4 clips]
Clips --> FFmpeg[Stack and encode clips]
FFmpeg --> GIF[Documentation GIF]
|
There was a problem hiding this comment.
Isaac Lab Review Bot
The RL documentation consolidation is coherent and references to the removed pages are retargeted, but two actionable issues remain: the media generator uses a physics selector inconsistent with its installed backend extra, and the merged source-of-truth page drops the maintenance link to its synchronized RL skills.
- Design and architecture: The task-oriented consolidated page is a suitable replacement for the deleted RL overview, comparison, workflow, and training-guide pages. However, it should preserve the former training guide’s explicit instruction to synchronize the
train-rl-agentsanddebug-rl-trainingskills, since those skills now identify this merged page as their maintained documentation source. - API: The supplied documentation targets and inbound references are consistently migrated:
_rl-frameworksand_pretrained-checkpointsremain available,_choose-an-rl-librarysupports the new quickstart reference, and references in the changed documentation and skills point to the consolidated page. - Implementation: The capture helper and generator follow the existing documentation-media workflow, but the generator installs the
ovphysxextra while passingphysics=physxduring both training and playback. Those commands should use the documentedphysics=ovphysxselector to match the selected integration and make the workflow reproducible.
Minor fixes needed. Posted 2 actionable findings inline.
Automated review; human maintainers own approval decisions.
|
Applied the review follow-up in
Validation: |
|
run-ci |
There was a problem hiding this comment.
we try to keep gif files uploaded on S3 instead so that we can avoid bloating the repo size. generally, we only keep .jpg media files in the repo.
| .. code-block:: bash | ||
|
|
||
| uv run isaaclab play --rl_library rsl_rl --task Isaac-Cartpole \ | ||
| --checkpoint latest --num_envs 32 --viz kit |
There was a problem hiding this comment.
maybe we don't use kit here since it requires isaac sim?
| :alt: Anymal-D locomotion at RSL-RL training iterations 0, 100, and 299 | ||
|
|
||
| One RSL-RL experiment at three checkpoints: the same Anymal-D task, command, seed, camera, and | ||
| OVRTX rendering setup show how the policy changes during training. |
There was a problem hiding this comment.
what is the camera/ovrtx setup used for this? the environment doesn't come with a camera by default right?
There was a problem hiding this comment.
Fixed, this section was reworked so it no longer discuesses ovrtx
| .. code-block:: bash | ||
|
|
||
| uv run isaaclab train --rl_library rsl_rl --task Isaac-Cartpole \ | ||
| --num_envs 32 --viz kit |
There was a problem hiding this comment.
maybe also a different visualizer here?
There was a problem hiding this comment.
Fixed (ended up removing this part of the docs)
Description
Merge the reinforcement learning overview, framework comparison, existing-script reference, and training guide into one task-oriented page updated for the Isaac Lab 3.0 CLI and preset conventions.
The consolidated guide recommends RSL-RL as the default and explains the distinct reasons to choose RL-Games, SKRL, or Stable-Baselines3. It also adds a reproducible OVRTX-rendered ANYmal-D learning-progression GIF and a media-generation workflow modeled after the quickstart scripts.
No additional dependencies are required.
Type of change
Release backport
developScreenshots
The merged RL page includes the generated ANYmal-D learning-progression GIF, recorded with OVRTX at iterations 0, 100, and 299.
Validation
uv run --isolated --extra test -- make -C docs current-docs(passed with no warnings)uv run --no-project python tools/skills/cli.py check(validated 21 skills)uvx ruff check tools/docs/media/capture_reinforcement_learning.pyuvx ruff format --check tools/docs/media/capture_reinforcement_learning.pybash -n tools/docs/media/generate_reinforcement_learning.shgit diff --checkuv run isaaclab -f(all applicable formatting, RST, codespell, executable, large-file, and LFS checks passed; the repository-wide changelog hook reports unrelated baseline fragment divergence in source packages not touched by this documentation-only PR)tools/docs/media/generate_reinforcement_learning.shend-to-end with OVRTX and inspected the generated GIF.Checklist
pre-commitchecks withuv run isaaclab -fsource/<pkg>/changelog.d/for every touched package (no source packages touched)CONTRIBUTORS.mdor my name already exists there