docs: Remove deprecated headless examples for beta2#6107
docs: Remove deprecated headless examples for beta2#6107AntoineRichard wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Review Summary
Clean documentation PR that systematically removes the deprecated --headless flag across 44 files and provides correct guidance for the new --visualizer / --viz pattern. The changes are consistent and well-structured.
CI Status: Pre-commit, changelog, broken link, and wheel build checks all pass ✅
Findings
| # | Severity | File | Issue |
|---|---|---|---|
| 1 | 🟠 Medium | docs/source/policy_deployment/00_hover/hover_policy.rst |
Dangling trailing backslashes after --headless removal (3 occurrences) |
| 2 | 🟡 Minor | docs/source/features/hydra.rst |
Stale prose references "headless mode" after flag removal |
| 3 | 🟢 Nit | docs/source/setup/quickstart.rst |
Replacement text is slightly verbose for the context |
Details
1. Dangling trailing backslashes in hover_policy.rst 🟠
In three multi-line commands, --headless was the final argument (no trailing \ of its own), but the preceding line has a trailing \ for continuation. After removal, the last line of the command now ends with \ followed by a blank line, which is a broken shell command in the rendered example.
Affected locations (lines ~60, ~75, ~168):
# Before (correct):
${ISAACLAB_PATH:?}/isaaclab.sh -p scripts/rsl_rl/train_teacher_policy.py --num_envs 1024 --reference_motion_path neural_wbc/data/data/motions/stable_punch.pkl --headless
# After (dangling backslash):
${ISAACLAB_PATH:?}/isaaclab.sh -p scripts/rsl_rl/train_teacher_policy.py --num_envs 1024 --reference_motion_path neural_wbc/data/data/motions/stable_punch.pkl ```
**Fix:** Remove the trailing `\` from the line that is now the last argument in each of the 3 commands.
#### 2. Stale prose in `hydra.rst` 🟡
The paragraph after the code examples still reads:
> "The above command will run training with the task ``Isaac-Cartpole`` **in headless mode**, and set the..."
Since `--headless` was removed from the commands, this should be updated (e.g., "without a visualizer" or simply remove "in headless mode").
#### 3. Verbose replacement in `quickstart.rst` 🟢
The new text is a 160+ character single line:
> "For commands that do not configure a visualizer, omit `--visualizer` / `--viz` to run without a viewer. Use `--help` on any script to see task-specific..."
Consider splitting across two lines or simplifying to stay within typical RST line-length conventions. This is purely cosmetic.
---
Overall a well-executed cleanup. The dangling backslashes in hover_policy.rst are the only issue that would produce incorrect rendered examples for users copying commands.| ./isaaclab.sh train --rl_library sb3 --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.seed=2024 | ||
|
|
||
| The above command will run training with the task ``Isaac-Cartpole`` in headless mode, and set the | ||
| ``env.actions.joint_effort.scale`` parameter to 10.0 and the ``agent.seed`` parameter to 2024. |
There was a problem hiding this comment.
Stale prose: The --headless flag was removed from all four command examples above, but this sentence still reads:
The above command will run training with the task
Isaac-Cartpolein headless mode, and set the…
Since the commands no longer explicitly pass any headless/visualizer flag, this text is now misleading. Consider updating to something like:
The above command will run training with the task ``Isaac-Cartpole`` (without a visualizer by default) and set the…
Or simply remove the "in headless mode" qualifier.
Greptile SummaryThis PR backports #6102 to
Confidence Score: 5/5Documentation-only change with no code modifications; safe to merge. All 44 changed files are .rst / .md / .skip documentation files. The changes are mechanical and consistent — removing --headless from code blocks and updating surrounding prose. The one minor gap is that hydra.rst still describes the example commands as running in headless mode without explaining the new default-headless contract, which could leave readers puzzled, but this does not affect runtime behaviour. docs/source/features/hydra.rst — the explanatory sentence on line 51 still references headless mode without clarifying that this now means omitting the visualizer flag rather than passing --headless. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User runs isaaclab command] --> B{Does command or config\nselect a visualizer?}
B -- No --> C[Runs headless by default\nomit --visualizer / --viz]
B -- Yes --> D{Want headless?}
D -- No --> E[Visualizer launches normally\ne.g. --visualizer kit]
D -- Yes --> F[Force disable visualizer\n--visualizer none / --viz none]
style C fill:#d4edda,stroke:#28a745
style F fill:#fff3cd,stroke:#ffc107
style E fill:#cce5ff,stroke:#004085
Reviews (1): Last reviewed commit: "docs: Clarify visualizer override guidan..." | Re-trigger Greptile |
| The above command will run training with the task ``Isaac-Cartpole`` in headless mode, and set the | ||
| ``env.actions.joint_effort.scale`` parameter to 10.0 and the ``agent.seed`` parameter to 2024. |
There was a problem hiding this comment.
Stale "headless mode" description after flag removal
The prose still says "The above command will run training with the task Isaac-Cartpole in headless mode" but the --headless flag was removed from all four tab items above and no explicit --viz none was added. Readers following this tutorial won't understand how headless behaviour is achieved without additional context explaining that omitting --visualizer / --viz is the default no-viewer path in Isaac Lab 3.0-beta2. The phrase should either be updated to say "without a visualizer (the default)" or a brief note like the one added in other files should be included.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| @@ -60,7 +60,6 @@ Execute the following command from the ``HOVER`` directory to train the teacher | |||
| ${ISAACLAB_PATH:?}/isaaclab.sh -p scripts/rsl_rl/train_teacher_policy.py \ | |||
| --num_envs 1024 \ | |||
| --reference_motion_path neural_wbc/data/data/motions/stable_punch.pkl \ | |||
There was a problem hiding this comment.
Dangling trailing backslash: Now that --headless is removed, this line ends with \ but has nothing following it. This will render as a broken example for users.
| --reference_motion_path neural_wbc/data/data/motions/stable_punch.pkl \ | |
| --reference_motion_path neural_wbc/data/data/motions/stable_punch.pkl |
Same issue occurs two more times in this file (the student training command ~line 77 and the deployment command ~line 170).
Description
Backport of #6102 to
release/3.0.0-beta2.Removes deprecated
--headlessfrom documentation examples and clarifies that omitting--visualizer/--vizis the default headless path. Uses--visualizer none/--viz noneonly for forced-disable cases when a config or command selects a visualizer.No new dependencies.
Fixes # N/A
Type of change
Screenshots
N/A.
Checklist
pre-commitchecks with./isaaclab.sh --formatsource/<pkg>/changelog.d/for every touched package (do not editCHANGELOG.rstor bumpextension.toml— CI handles that)CONTRIBUTORS.mdor my name already exists there