Skip to content

Document warp-frontend play commands in the quick start - #6947

Merged
hujc7 merged 8 commits into
isaac-sim:developfrom
hujc7:jichuanh/docs-warp-quickstart-play
Aug 28, 2026
Merged

Document warp-frontend play commands in the quick start#6947
hujc7 merged 8 commits into
isaac-sim:developfrom
hujc7:jichuanh/docs-warp-quickstart-play

Conversation

@hujc7

@hujc7 hujc7 commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Description

The Newton warp-environments quick start listed only train commands, so there was no
documented way to run inference on a policy trained with --frontend warp.

Each workflow's train command is now followed by its matching play command inside the
same code block, in both the uv and isaaclab.sh tabs, so the pair is read together.
Adds a note that --video is rejected on the warp path — for train and play alike, since
the guard lives in the shared apply_video_recording.

Uses the canonical --visualizer newton_gl; newton has been a deprecated alias since #6658.

Fixes nvbug 6531264.

Page: https://isaac-sim.github.io/IsaacLab/develop/source/overview/core-concepts/physical-backends/newton/warp-environments.html#quick-start

Type of change

  • Documentation update

Release backport

  • Backport this pull request to the active release branch after it merges into develop

Validation

Every documented command was run end-to-end on an RTX A6000 against develop, with
--num_envs 32 --max_iterations 5 on the train runs to bound them:

Command Result
train --task Isaac-Cartpole-Direct --frontend warp presets=newton_mjwarp Training time: 1.72 seconds
train --task Isaac-Velocity-Flat-AnymalD --frontend warp presets=newton_mjwarp Training time: 7.96 seconds
play --task Isaac-Cartpole-Direct --frontend warp ... --checkpoint latest --visualizer newton_gl loaded model_4.pt
play --task Isaac-Velocity-Flat-AnymalD --frontend warp ... --checkpoint latest --visualizer newton_gl loaded model_4.pt
play ... --frontend warp --video rejected with ValueError: --video is not supported with --frontend 'warp'
play ... --frontend torch --video (the note's remedy) wrote videos/play/clip_0000.mp4

uv run --isolated --extra test -- make -C docs current-docs (-W --keep-going) passes with
no warnings, after merging develop.

No changelog fragment: the change touches only docs/.

Checklist

  • I have read and understood the contribution guidelines
  • I have run the pre-commit checks with ./isaaclab.sh --format
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

hujc7 added 3 commits August 6, 2026 12:02
The warp environments quick start showed only training commands, so
there was no documented way to run inference on a policy trained with
--frontend warp.

Split the quick start into Training and Playing sections so every train
example has a matching play example in both the uv and isaaclab.sh tabs,
and note that --video is rejected on the warp path.
The quick start listed only train commands, so there was no documented
way to run inference on a policy trained with --frontend warp. Pair each
workflow's train command with its play command inside the existing code
blocks rather than adding a separate section, so the two are read
together.

Use the canonical --visualizer newton_gl spelling; "newton" has been a
deprecated alias since isaac-sim#6658. Note that --video is rejected on the warp
path for both train and play, not just play.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 10, 2026
The paired train/play code blocks carry the same information, so the
introductory paragraph only restated them. Keep the quick start to the
commands plus the --video note.
@hujc7
hujc7 marked this pull request as ready for review August 10, 2026 23:16
@hujc7
hujc7 requested a review from a team August 10, 2026 23:16

@isaaclab-review-bot isaaclab-review-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isaac Lab Review Bot

Reviewed the documentation-only addition of warp-frontend play commands for both direct and manager-based workflows, along with the new video-recording limitation note. The examples consistently pair with the existing training commands in both quick-start tabs.

  • Design and architecture: The additions preserve the existing tab-set and code-block organization. The --video limitation is placed alongside the warp quick-start commands where users are most likely to encounter it.
  • API: No public API or CLI contract is changed. The documented play path uses the existing warp frontend, Newton preset, latest-checkpoint selector, and canonical newton_gl visualizer spelling. No source package is modified, so the source-package changelog requirement is not triggered.
  • Implementation: The RST indentation, shell continuations, and note directive are consistent with the surrounding document. The direct and manager-based play examples mirror their corresponding training configurations, and the note clearly identifies that recording requires replay through the torch frontend.

No blocking issues. No inline issue met the actionable-evidence threshold; the assessment above records the review feedback.

Automated review; human maintainers own approval decisions.

@greptile-apps

greptile-apps Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds matching inference commands to the Newton warp-environments quick start and clarifies that video recording requires replay through the torch frontend.

  • Documents play commands for direct and manager-based RSL-RL workflows in both launcher tabs.
  • Uses the canonical newton_gl visualizer and latest checkpoint selector.
  • Adds guidance for recording rollouts from warp-trained checkpoints.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The new commands use supported frontend, preset, checkpoint, and visualizer arguments, and no concrete failure remains in the playback or video guidance.

Important Files Changed

Filename Overview
docs/source/overview/core-concepts/physical-backends/newton/warp-environments.rst The added play commands and video guidance align with the CLI contracts and documented validation; no actionable issue was identified.

Reviews (1): Last reviewed commit: "Drop the quick-start prose intro" | Re-trigger Greptile

hujc7 added 4 commits August 13, 2026 10:51
The quick start now documents a single execution path, so the tab-set has
nothing to switch between. sphinx-design still renders a one-item set as an
always-checked radio input plus a label, giving a tab button that cannot be
toggled, and emits a stray rubric heading in non-HTML builds.

Collapse it to a plain code-block with uv run, matching using-cables.rst.
@hujc7

hujc7 commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator Author

@StafaH for review

@hujc7
hujc7 enabled auto-merge (squash) August 26, 2026 06:09
@hujc7
hujc7 merged commit 55ac56a into isaac-sim:develop Aug 28, 2026
45 checks passed
@isaaclab-bot

isaaclab-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Backported to release/3.0.0 as 0a746c4.

isaaclab-bot Bot pushed a commit that referenced this pull request Aug 28, 2026
# Description

The Newton warp-environments quick start listed only `train` commands,
so there was no
documented way to run inference on a policy trained with `--frontend
warp`.

Each workflow's `train` command is now followed by its matching `play`
command inside the
same code block, in both the `uv` and `isaaclab.sh` tabs, so the pair is
read together.
Adds a note that `--video` is rejected on the warp path — for `train`
and `play` alike, since
the guard lives in the shared `apply_video_recording`.

Uses the canonical `--visualizer newton_gl`; `newton` has been a
deprecated alias since #6658.

Fixes nvbug 6531264.

Page:
https://isaac-sim.github.io/IsaacLab/develop/source/overview/core-concepts/physical-backends/newton/warp-environments.html#quick-start

## Type of change

- Documentation update

## Release backport

- [x] <!-- backport-active-release --> Backport this pull request to the
active release branch after it merges into `develop`

## Validation

Every documented command was run end-to-end on an RTX A6000 against
`develop`, with
`--num_envs 32 --max_iterations 5` on the train runs to bound them:

| Command | Result |
| --- | --- |
| `train --task Isaac-Cartpole-Direct --frontend warp
presets=newton_mjwarp` | `Training time: 1.72 seconds` |
| `train --task Isaac-Velocity-Flat-AnymalD --frontend warp
presets=newton_mjwarp` | `Training time: 7.96 seconds` |
| `play --task Isaac-Cartpole-Direct --frontend warp ... --checkpoint
latest --visualizer newton_gl` | loaded `model_4.pt` |
| `play --task Isaac-Velocity-Flat-AnymalD --frontend warp ...
--checkpoint latest --visualizer newton_gl` | loaded `model_4.pt` |
| `play ... --frontend warp --video` | rejected with `ValueError:
--video is not supported with --frontend 'warp'` |
| `play ... --frontend torch --video` (the note's remedy) | wrote
`videos/play/clip_0000.mp4` |

`uv run --isolated --extra test -- make -C docs current-docs` (`-W
--keep-going`) passes with
no warnings, after merging `develop`.

No changelog fragment: the change touches only `docs/`.

## 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 my name to the `CONTRIBUTORS.md` or my name already
exists there

(cherry picked from commit 55ac56a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants