[Docs] Expand Isaac Teleop XR performance optimization guide#5643
Conversation
There was a problem hiding this comment.
🤖 Isaac Lab Review Bot
PR #5643 - [Docs] Expand Isaac Teleop XR performance optimization guide
Summary
This is a well-crafted documentation PR that significantly improves the XR performance optimization guide. The additions provide actionable guidance for users struggling with frame rate issues on lower-spec hardware.
✅ What Looks Good
-
Clear technical explanations: The relationship between
sim.dt,render_interval, and actual frame rates is well documented with practical recommendations. -
Modern hardware focus: Updated to reference Quest 3 and Pico 4 Ultra (90 Hz) rather than older devices.
-
Complete RTX Minimal guidance: The new section thoroughly covers:
- When to use it (lower-spec GPUs, complex scenes)
- How to enable it (viewport dropdown + Render Settings)
- The
DistantLight-only limitation with a working code snippet
-
Resolution multiplier documentation: Clear explanation of the tradeoff with a sensible starting point (0.8).
-
Good decision to remove the "physics on CPU" dropdown since it is already the default.
-
Proper assets: New screenshots follow the existing
_static/teleop/convention with descriptive names. -
Changelog fragment follows the expected format and references the appropriate section.
📋 Minor Item to Verify
- The changelog fragment references
:ref:\isaac-teleop-performance`. Please confirm this label exists in the RST file (likely around line 950 ofisaac_teleop.rst`). If missing, the docs build will produce a warning.
Verdict
Looks good to merge once the docs CI completes successfully. Great work on making XR performance optimization more accessible! 🎮
🔄 Update (2026-05-15)
New commits add two more performance optimization dropdowns:
-
Configure retargeting execution - Documents
RetargetingExecutionConfigwith clear sync vs pipelined mode guidance andDeadlinePacingConfigtuning. -
Check CloudXR frame pacing - Explains pacer behavior and provides actionable diagnostics via
--cloudxr_env.
Both additions maintain the same high documentation quality. No issues found. ✅
🔄 Update (2026-05-16)
Latest SHA reviewed: 802206d321507cba2c3084867ea70887fe052c7b
Incremental Changes Since Last Review
Changes since 73d64c5:
- Removed
docs/isaaclab-docs.tar.gz— binary archive cleanup ✅ - Removed
docs/teleop_migration_2.3_to_3.0.md— migration guide removed (683 lines)
The core documentation improvements remain unchanged. The file removals appear to be intentional cleanup (the migration guide was likely a working document that does not belong in this docs PR, and the tarball was generated/transient).
No new issues found. PR remains good to merge. ✅
Greptile SummaryThis PR expands the Optimize XR Performance section of the Isaac Teleop feature guide with five new dropdowns covering the RTX - Minimal renderer, the XR resolution-multiplier slider,
Confidence Score: 5/5Documentation-only change with no runtime code modifications; safe to merge. All changes are prose, reStructuredText markup, and screenshot assets. The code snippets in the new dropdowns match the actual API in docs/source/features/isaac_teleop.rst — the retargeting execution snippet warrants a quick look for import completeness. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A([XR teleop cannot sustain headset display rate]) --> B{Already tuned\nsim.dt & render_interval?}
B -- No --> C[Set sim.dt = 1/90\nset render_interval = 2]
C --> D{Still dropping\nframes?}
B -- Yes --> D
D -- No --> Z([Done])
D -- Yes --> E[Switch viewport to\nRTX - Minimal renderer]
E --> F[Set Minimal Shading Mode\n= Diffuse/Glossy/Emission]
F --> G{Using DomeLight?}
G -- Yes --> H[Swap/supplement with\nDistantLight]
G -- No --> I{Still dropping\nframes?}
H --> I
I -- No --> Z
I -- Yes --> J[Lower XR Resolution\nMultiplier e.g. 0.8]
J --> K{Heavy retargeting?}
K -- Python-light --> L[Use RetargetingExecutionConfig\nmode=sync]
K -- Native/heavy --> M[Use RetargetingExecutionConfig\nmode=pipelined, tune safety_margin_s]
L --> N{Frame-time\nspikes visible?}
M --> N
N -- Yes --> O[Override CloudXR frame pacer\nvia custom .env + --cloudxr_env]
N -- No --> Z
O --> Z
Reviews (2): Last reviewed commit: "Remove accidentally committed docs tarba..." | Re-trigger Greptile |
🔄 Isaac Lab Review Bot - Incremental Review UpdateReviewing new commits: Summary of New ChangesThis incremental update includes:
Previous Feedback StatusThe previous suggestion regarding the Overall Assessment✅ The incremental changes are well-structured and improve the documentation quality. The migration guide is particularly valuable for users upgrading their teleop implementations. Automated review by Isaac Lab Review Bot |
|
@greptile |
…im#5643) # Description Expands the **Optimize XR Performance** section of the Isaac Teleop feature guide with the most common levers users reach for when XR teleop cannot sustain the headset's display rate -- particularly on lower-spec GPUs or in heavy scenes. What changed: - **RTX - Minimal renderer**: new dropdown explaining when to use it, how to enable it from the viewport renderer dropdown, the recommended **Render Settings** (**Minimal Shading Mode = Diffuse/Glossy/Emission**), and the current `DistantLight`-only lighting limitation, with a snippet showing how to swap a `DomeLight` for a `DistantLight`. - **XR Resolution Multiplier slider**: new dropdown describing the **XR -> Advanced Settings -> Render Resolution** slider for trading image sharpness for GPU headroom (`0.8` as a sensible starting point). - **Physics / render time step**: refreshed to focus on Quest 3 / Pico 4 Ultra (90 Hz), explain what `sim.render_interval` actually controls, and call out the `sim.dt` stability/performance trade-off. - Removed the **Try running physics on CPU** dropdown -- this is already the default for these workflows. Fixes # (issue) ## 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 - [x] I have added tests that prove my fix is effective or that my feature works - [x] 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
Description
Expands the Optimize XR Performance section of the Isaac Teleop feature guide
with the most common levers users reach for when XR teleop cannot sustain the
headset's display rate -- particularly on lower-spec GPUs or in heavy scenes.
What changed:
enable it from the viewport renderer dropdown, the recommended Render
Settings (Minimal Shading Mode = Diffuse/Glossy/Emission), and the
current
DistantLight-only lighting limitation, with a snippet showing howto swap a
DomeLightfor aDistantLight.XR -> Advanced Settings -> Render Resolution slider for trading image
sharpness for GPU headroom (
0.8as a sensible starting point).(90 Hz), explain what
sim.render_intervalactually controls, and call outthe
sim.dtstability/performance trade-off.default for these workflows.
Fixes # (issue)
Type of change
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there