Skip to content

[Task Clean-up][Docs] Regenerate the stale environment overview table#6410

Open
hujc7 wants to merge 2 commits into
isaac-sim:developfrom
hujc7:jichuanh/task-cleanup-docs-regen
Open

[Task Clean-up][Docs] Regenerate the stale environment overview table#6410
hujc7 wants to merge 2 commits into
isaac-sim:developfrom
hujc7:jichuanh/task-cleanup-docs-regen

Conversation

@hujc7

@hujc7 hujc7 commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator

Review Map

PR Status Depends on Exact changes
📌 #6410 [Docs] Environment overview regen (this PR)
#6411 Part 1/8: Newton cloner/cubric/visualizer fixes
#6412 Part 2/8: OVPhysX articulation + manager runtime
#6413 Part 3/8: Reorient Direct, torch
#6414 Part 4/8: Handover + camera Direct, torch #6413 changes
#6418 Part 5/8: Reorient manager counterparts #6413 changes
#6421 Part 6/8: Handover + camera manager counterparts #6413, #6414, #6418 changes
#6415 Part 7/8: Benchmark success-rate utilities + docs #6413, #6414, #6418, #6421 changes
#6582 Part 8/8: Warp variants → experimental (draft; merges last) #6413 changes
#6324 [DO-NOT-MERGE] Lumped validation reference ALL

Summary

  • Regenerates docs/source/overview/environments.rst with tools/update_environments_rst.py on current develop — the committed table had drifted (renderer preset renames and several registrations landed without regeneration).
  • Mechanical change, no hand edits; lets subsequent [Task Clean-up] PRs carry only their own table rows.

Dependencies

  • None.

Review updates (2026-07-11)

  • Synced the table with lump head d3cddae: the stale camera-benchmark row is removed and the manager-based dexterous rows are included as regenerated by tools/update_environments_rst.py against the full task set; rows for tasks that land in later parts regenerate identically post-merge.

The committed table has drifted from the output of
tools/update_environments_rst.py (renderer preset renames and several
registrations landed without regeneration). Regenerating on current
develop so subsequent task PRs carry only their own rows.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 8, 2026
@greptile-apps

greptile-apps Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR regenerates docs/source/overview/environments.rst by running tools/update_environments_rst.py against the current develop branch registry, bringing a stale committed table back in sync with the actual registered environments.

  • Removes environments that are no longer in the Gym registry (e.g. several IsaacContrib-AutoMate-*, IsaacContrib-Deploy-*, and IsaacContrib-Cartpole-Showcase-* entries), and adds newly registered ones (Isaac-DrLegs-*, Isaac-Fourbar-Pole-Swingup, Isaac-Lift-KukaAllegro, IsaacContrib-Stack-Cube-SO101-*, and others).
  • Fixes physics-preset listings to include ovphysx and newton_kamino where they were missing, and consolidates standalone Play-environment rows into the dedicated Eval column of their training counterpart (e.g. Isaac-Velocity-Flat-AnymalD-Play is now the eval entry of Isaac-Velocity-Flat-AnymalD rather than an independent row).
  • No hand-edits; all content is generated by the existing tooling.

Confidence Score: 5/5

  • Documentation-only change produced entirely by the existing generation script; no runtime code is modified.
  • The single changed file is a generated RST table. The update script reads the live Gym registry and rewrites only the fenced AUTO-GENERATED block, leaving all surrounding prose untouched. The structural improvements (consolidating Play rows into the Eval column, adding missing physics presets) are consistent with the script's output logic and the PR description's stated intent.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/source/overview/environments.rst Auto-generated table regenerated via tools/update_environments_rst.py: adds new environments, removes stale ones, fixes physics/renderer preset listings, and consolidates Play rows into the Eval column.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[tools/update_environments_rst.py] --> B[Bootstrap source/* packages onto sys.path]
    B --> C[Import isaaclab_tasks + isaaclab_tasks_experimental]
    C --> D[collect_environment_doc_rows\nReads Gym registry]
    D --> E[render_comprehensive_list_table\nBuilds RST list-table markup]
    E --> F[patch_environments_rst\nReplaces AUTO-GENERATED block]
    F --> G[docs/source/overview/environments.rst\nUpdated committed file]

    subgraph Changes in this PR
        H[Removed stale entries\nIsaacContrib-AutoMate, Deploy, Showcase…]
        I[Added new entries\nDrLegs, Fourbar, KukaAllegro, SO101…]
        J[Fixed physics presets\novphysx + newton_kamino additions]
        K[Consolidated Play rows\ninto Eval column]
    end

    G --> H & I & J & K
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[tools/update_environments_rst.py] --> B[Bootstrap source/* packages onto sys.path]
    B --> C[Import isaaclab_tasks + isaaclab_tasks_experimental]
    C --> D[collect_environment_doc_rows\nReads Gym registry]
    D --> E[render_comprehensive_list_table\nBuilds RST list-table markup]
    E --> F[patch_environments_rst\nReplaces AUTO-GENERATED block]
    F --> G[docs/source/overview/environments.rst\nUpdated committed file]

    subgraph Changes in this PR
        H[Removed stale entries\nIsaacContrib-AutoMate, Deploy, Showcase…]
        I[Added new entries\nDrLegs, Fourbar, KukaAllegro, SO101…]
        J[Fixed physics presets\novphysx + newton_kamino additions]
        K[Consolidated Play rows\ninto Eval column]
    end

    G --> H & I & J & K
Loading

Reviews (1): Last reviewed commit: "Regenerate the stale environment overvie..." | Re-trigger Greptile

Sync the table with the lump head: the stale camera-benchmark row is
removed and the manager-based dexterous rows regenerate via
tools/update_environments_rst.py against the full task set; rows for
tasks that land in later parts regenerate identically post-merge.
hujc7 added a commit that referenced this pull request Jul 17, 2026
…nager runtime (#6412)

## Summary

- Fixes OVPhysX actuator joint indices to follow the common actuator
indexing contract.
- Fixes OVPhysX initialization alongside Kit by reusing Kit's registered
PhysX schema provider.
- Fixes the OVPhysX manager to support both the declared public runtime
API and the current runtime API.
- Regression tests included. Validated by full dexterous training runs
on the OVPhysX backend; split out of the lumped validation branch #6324
(Part 2 of 11).

## Dependencies

- None.

## Series review map

Full integrated diff + training/validation evidence: the lumped
validation PR #6324
(DO-NOT-MERGE).

| Part | PR |
|---|---|
| Docs: regenerate the environment overview table |
#6410 |
| Part 1/11: Newton runtime fixes (cloner rows, cubric fallback, viz
teardown) | #6411 |
| **Part 2/11: OVPhysX runtime fixes (this PR)** |
#6412 |
| Part 3/11: success-rate metrics for the Direct reorientation tasks |
#6413 |
| Part 4/11: RSL-RL training for the handover Direct task |
#6414 |
| Part 5/11: success-rate support in the benchmark utilities |
#6415 |
| Part 6/11: renderer presets for the Direct camera task |
#6416 |
| Part 7/11: OVPhysX presets for the dexterous tasks |
#6417 |
| Part 8/11: Allegro manager counterpart |
#6418 |
| Part 9/11: Shadow + OpenAI manager counterparts |
#6419 |
| Part 10/11: Shadow camera manager counterpart |
#6420 |
| Part 11/11: Shadow handover manager counterpart |
#6421 |


---
### Exact changes in this PR

- OVPhysX backend changes + tests:
1f7a433
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.

1 participant