Skip to content

Fixes environment task names in release docs#6126

Open
kellyguo11 wants to merge 1 commit into
isaac-sim:release/3.0.0-beta2from
kellyguo11:doc-env-name
Open

Fixes environment task names in release docs#6126
kellyguo11 wants to merge 1 commit into
isaac-sim:release/3.0.0-beta2from
kellyguo11:doc-env-name

Conversation

@kellyguo11

@kellyguo11 kellyguo11 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes task names that were incorrectly updated on the release branch from changes in develop. Adds back -v0 for cartpole names.

Type of change

  • Documentation update

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 tests that prove my fix is effective or that my feature works
  • I have updated the changelog and the corresponding version in the extension's config/extension.toml file
  • I have added my name to the CONTRIBUTORS.md or my name already exists there

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 11, 2026

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📝 Documentation Review — Task Name Fixes

Summary: This PR correctly updates environment task names across 17 documentation files to include version suffixes (e.g., Isaac-CartpoleIsaac-Cartpole-v0), aligning the docs with the registered task names in the 3.0.0-beta2 release.

✅ Changes look good overall

The following rename patterns are applied consistently:

  • Isaac-CartpoleIsaac-Cartpole-v0
  • Isaac-Cartpole-DirectIsaac-Cartpole-Direct-v0
  • Isaac-Cartpole-Camera-DirectIsaac-Cartpole-Camera-Presets-Direct-v0

Additionally, camera-related examples now use --rl_library rl_games instead of rsl_rl, which appears intentional.

🔍 Minor observation

In docs/source/setup/quickstart.rst, the camera task example uses Isaac-Cartpole-RGB-Camera-Direct-v0:

./isaaclab.sh train --rl_library rl_games   --task=Isaac-Cartpole-RGB-Camera-Direct-v0   physics=newton_mjwarp renderer=newton_renderer presets=rgb

While in other files (e.g., quickstart_details.rst, rl_existing_scripts.rst, hydra.rst), the equivalent camera task is named Isaac-Cartpole-Camera-Presets-Direct-v0. If these are distinct registered tasks (one with RGB baked in, one generic with presets), this is fine. Otherwise, it may be worth unifying for reader clarity.

CI Status

  • pre-commit ✅ passed
  • Check for Broken Links ✅ passed
  • Build Latest Docs ⏳ pending
  • Other checks skipped (docs-only change)

LGTM — straightforward docs fix. 🎉

@greptile-apps

greptile-apps Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR fixes stale environment task names across 17 release documentation files, adding the required -v0 version suffix (e.g. Isaac-CartpoleIsaac-Cartpole-v0) and updating camera task names to match currently registered gym IDs.

  • All non-camera task names (Isaac-Cartpole, Isaac-Cartpole-Direct) are correctly updated to Isaac-Cartpole-v0 and Isaac-Cartpole-Direct-v0, which both exist in the gym registry.
  • Camera task names are updated from the stale Isaac-Cartpole-Camera-Direct to Isaac-Cartpole-Camera-Presets-Direct-v0 (most files) or Isaac-Cartpole-RGB-Camera-Direct-v0 (quickstart.rst); however these two names are used interchangeably in nearly identical command examples, creating an inconsistency — see inline comment.

Confidence Score: 4/5

The documentation corrections are accurate for 16 of 17 files; quickstart.rst uses a task name that does not match the preset-selection example it is paired with.

The quickstart.rst camera example pairs Isaac-Cartpole-RGB-Camera-Direct-v0 with presets=rgb, but every parallel doc uses Isaac-Cartpole-Camera-Presets-Direct-v0 for the same command. A user following quickstart.rst would reference a fixed-config task that has no preset plumbing, making the presets=rgb override silently ineffective. All other changes are straightforward and correct.

docs/source/setup/quickstart.rst — the camera task name in the presets example needs to match what all other docs use.

Important Files Changed

Filename Overview
docs/source/setup/quickstart.rst Updates task names to add -v0 suffix correctly, but uses Isaac-Cartpole-RGB-Camera-Direct-v0 for the camera+presets example where other docs consistently use Isaac-Cartpole-Camera-Presets-Direct-v0
docs/source/setup/quickstart_details.rst Task names updated to -v0 suffix; uses Isaac-Cartpole-Camera-Presets-Direct-v0 consistently with other docs
docs/source/features/hydra.rst Task names and rl_library updated correctly; Isaac-Cartpole-v0 and Isaac-Cartpole-Camera-Presets-Direct-v0 both exist in the gym registry
docs/source/migration/migrating_from_isaacgymenvs.rst Task name Isaac-Cartpole-Direct-v0 correctly updated for both train and play commands
docs/source/migration/migrating_from_omniisaacgymenvs.rst Same fix as migrating_from_isaacgymenvs — Isaac-Cartpole-Direct-v0 correctly applied
docs/source/migration/migrating_to_isaaclab_3-0.rst Isaac-Cartpole-v0 correctly applied in all four command examples
docs/source/overview/reinforcement-learning/rl_existing_scripts.rst Camera task and rl_library updated consistently to Isaac-Cartpole-Camera-Presets-Direct-v0 with rl_games
docs/source/tutorials/03_envs/run_rl_training.rst All five command examples updated to Isaac-Cartpole-v0; log path references were already correct
docs/source/overview/core-concepts/sensors/camera.rst Camera task updated to Isaac-Cartpole-Camera-Presets-Direct-v0, consistent with the registered gym ID
docs/source/overview/core-concepts/visualization.rst All six task-name references updated to Isaac-Cartpole-v0 and camera prose updated to Isaac-Cartpole-Camera-Presets-Direct-v0

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Docs: task name reference] --> B{Task type}
    B -->|Manager-based| C[Isaac-Cartpole-v0\nmanager_based/classic/cartpole]
    B -->|Direct workflow| D[Isaac-Cartpole-Direct-v0\ndirect/cartpole]
    B -->|Camera + Presets| E[Isaac-Cartpole-Camera-Presets-Direct-v0\ndirect/cartpole]
    B -->|Fixed RGB Camera| F[Isaac-Cartpole-RGB-Camera-Direct-v0\ndirect/cartpole]
    E --> G[quickstart_details.rst\nhydra.rst\ncamera.rst\nvisualization.rst\nrl_existing_scripts.rst]
    F --> H[quickstart.rst ⚠️\nused with presets=rgb]
    style H fill:#ffcccc
    style E fill:#ccffcc
    style F fill:#ffe0b2
Loading

Reviews (1): Last reviewed commit: "Fixes environment task names in release ..." | Re-trigger Greptile

Comment on lines +102 to 104
./isaaclab.sh train --rl_library rl_games \
--task=Isaac-Cartpole-RGB-Camera-Direct-v0 \
physics=newton_mjwarp renderer=newton_renderer presets=rgb

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.

P1 Inconsistent camera task name with presets=rgb override

quickstart.rst uses Isaac-Cartpole-RGB-Camera-Direct-v0 while every other updated doc (quickstart_details.rst, hydra.rst, camera.rst, visualization.rst, rl_existing_scripts.rst) uses Isaac-Cartpole-Camera-Presets-Direct-v0 for the same camera + presets example command. Isaac-Cartpole-RGB-Camera-Direct-v0 is a fixed-config RGB task without preset support, so passing presets=rgb as a Hydra override is likely a no-op or undefined behavior here; Isaac-Cartpole-Camera-Presets-Direct-v0 is the task explicitly built for preset selection via Hydra.

Suggested change
./isaaclab.sh train --rl_library rl_games \
--task=Isaac-Cartpole-RGB-Camera-Direct-v0 \
physics=newton_mjwarp renderer=newton_renderer presets=rgb
./isaaclab.sh train --rl_library rl_games \
--task=Isaac-Cartpole-Camera-Presets-Direct-v0 \
physics=newton_mjwarp renderer=newton_renderer presets=rgb

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.

2 participants