Document warp-frontend play commands in the quick start - #6947
Draft
hujc7 wants to merge 1 commit into
Draft
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The Newton warp-environments quick start listed only
traincommands, so there was nodocumented way to run inference on a policy trained with
--frontend warp.Split the quick start into Training and Playing a Trained Policy, so every train
example has a matching
playexample in both theuvandisaaclab.shtabs, and notethat
--videois rejected on the warp path.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
Validation
Every newly documented command was run end-to-end on an RTX A6000 (5 iterations, small
num_envs):train --task Isaac-Cartpole-Direct --frontend warp presets=newton_mjwarpTraining time: 2.78 secondstrain --task Isaac-Velocity-Flat-AnymalD --frontend warp presets=newton_mjwarpTraining time: 5.54 secondsplay --task Isaac-Cartpole-Direct --frontend warp ... --checkpoint latest --visualizer newtonmodel_4.pt, stepped underInteractiveSceneWarpplay --task Isaac-Velocity-Flat-AnymalD --frontend warp ... --checkpoint latest --visualizer newtonmodel_4.pt, stepped underInteractiveSceneWarpplay ... --frontend warp --videoValueError: --video is not supported with --frontend 'warp'No changelog fragment: the change touches only
docs/, andtools/changelog/cli.py check developpasses.Checklist
pre-commitchecks with./isaaclab.sh --formatCONTRIBUTORS.mdor my name already exists there