Fix document according to bug 6198710#5787
Conversation
Greptile SummaryThis PR fixes a documentation sequencing bug where the "Test setup" step was listed before downloading and preparing the COMPASS USD assets that
Confidence Score: 5/5Documentation-only change with no code execution path; safe to merge. The change corrects a logical ordering mistake in the tutorial: the play.py test now appears after the USD assets it depends on are downloaded and placed, and the document body matches. No code is modified, there are no broken RST constructs introduced, and the added prerequisite sentence in the Testing section accurately reflects the dependency. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Create workspace] --> B[Install Isaac Sim & Isaac Lab]
B --> C[Install COMPASS Repository]
C --> D[Authenticate with Hugging Face]
D --> E[Download assets\nX-Mobility / COMPASS USDs / NuRec]
E --> F[Prepare assets\nExtract & place usd/ folder]
F --> G[Test setup\nplay.py]
G --> H[Train Residual RL Policy]
H --> I[Evaluate Trained Policy]
I --> J[Export to ONNX / TensorRT]
J --> K[ROS2 / Sim-to-Real Deployment]
Reviews (1): Last reviewed commit: "Fix document according to bug 6198710" | Re-trigger Greptile |
There was a problem hiding this comment.
Documentation Review
Thanks for this documentation improvement!
Summary
This PR reorders the steps in the COMPASS NuRec navigation policy tutorial to fix a logical dependency issue (bug 6198710).
Changes Analysis
What changed:
- Moved "Test setup" from step 4 to step 7 in the workflow overview
- Moved the corresponding "Testing the Setup" section to after asset downloading/preparation
- Added clarification that assets must be in place before testing
- Renumbered steps: Hugging Face auth is now step 4, download assets is step 5, prepare assets is step 6, test setup is step 7
Why this is correct:
The original documentation instructed users to test the setup before downloading and placing the required assets. The play.py script requires COMPASS USD assets to be present under compass/rl_env/exts/mobility_es/mobility_es/usd/. Running it before assets are in place would fail. This reordering fixes that logical dependency.
CI Status Note
The "Check for Broken Links" CI failure is a pre-existing issue affecting the repository's documentation (redirects in unrelated files like README.md, SECURITY.md, source_installation.rst, etc.). This is not caused by this PR.
Verdict
The documentation change is logically sound and improves the user experience by presenting steps in the correct order. No further changes needed.
Issue:
play.py verification step fails with FileNotFoundError for office.usd because the COMPASS USD assets (compass_usds.zip) are not listed as a prerequisite in the documentation, causing the script to always fail when run in documented order.
Running play.py (TC-02 — Verify COMPASS Setup) fails with FileNotFoundError for office.usd. The script is hardcoded to load usd/office/office.usd from the mobility_es extension directory, but this file is part of compass_usds.zip (downloaded from nvidia/COMPASS on Hugging Face). The documentation for PR #5599 and the COMPASS navigation guide do not mention downloading and placing the COMPASS USD assets as a prerequisite for running play.py. As a result, play.py will always fail if run before the asset download step.
Solution:
Add the prerequisite (download compass_usdz.zip) steps before running the play.py verification step in the docs
Checklist
pre-commitchecks with./isaaclab.sh --formatconfig/extension.tomlfileCONTRIBUTORS.mdor my name already exists there