Skip to content

[Task Clean-up][Docs] Dexterous Part 7/9: Environment overview updates for the reorientation series - #6410

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

[Task Clean-up][Docs] Dexterous Part 7/9: Environment overview updates for the reorientation series#6410
hujc7 wants to merge 27 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
#6411 Part 1/9: Newton cloner/cubric/visualizer fixes merged
#6412 Part 2/9: OVPhysX articulation + manager runtime merged
#6413 Part 3/9: Reorient Direct, torch changes
#6414 Part 4/9: MARL-to-single-agent fix + handover/camera Direct #6413 changes
#6418 Part 5/9: Reorient manager counterparts #6413 changes
#6421 Part 6/9: Handover + camera manager counterparts #6413, #6414, #6418 changes
📌 #6410 Part 7/9: Environment overview docs (this PR) #6421 changes
#6415 Part 8/9: Benchmark success-rate utilities #6421 changes
#6582 Part 9/9: Warp variants → experimental (draft; merges last) #6413 changes
#6324 [DO-NOT-MERGE] Lumped validation reference ALL

Documents the dexterous reorientation and handover tasks' newton_mjwarp/ovphysx physics backends in the comprehensive environment table, and repoints the shadow-hand source links to the renamed *_direct_env_cfg / *_direct_camera_env modules.

Stacked on Part 6 (#6421) so every referenced task and module exists. The dexterous env.rst update lives here (kept out of the benchmark part) so the docs land as one focused change.

Depends on: #6413, #6414, #6418, #6421.

@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

hujc7 added 3 commits July 16, 2026 17:44
Add a behavioral Metrics/success_rate signal (goal-reach streaks per
episode) and threshold-independent episode orientation-error diagnostics
to the Direct reorientation environments, with the shared helpers in
isaaclab_tasks.core.utils and torch math tests. The task logic is
torch-first per the mainline convention; success gates task health while
reward stays diagnostic. Also fix hand resets that could initialize
joints below their lower position limits.
Add the RSL-RL runner configuration for the Shadow handover Direct task
and success-rate metrics on the torch-first path, fix handover
construction on Newton (renamed distal joints), and land the camera
Direct renderer presets with configuration validation. RSL-RL
observations now read from the public environment-owned obs_buf on all
Direct env bases (reset stores the buffer like step), replacing the
adapter-side private hook.
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
hujc7 added 8 commits July 18, 2026 03:58
Fold the reviewed lump changes that belong to this part's content:

- Share the handover sim settings through the HandoverTaskCfgBase
  mixin instead of a module-level cfg variable.
- Reuse isaaclab.utils.math.quat_mul for the Newton initial-rotation
  composition instead of a local xyzw product helper.
- Nest the single-consumer tiled-camera helper cfg inside the camera
  task cfg.
- Drop the stale kit-less OpenUSD bullet from the isaaclab changelog
  fragment.

Source commits on the lump branch: 2c22af0, 2c5ea5b,
42675b6, 1f05f85.
Fold the reviewed lump changes that belong to this part's content:

- Share per-family sim settings through task-cfg base mixins.
- Deduplicate backend scene presets via inner-class defaults and nest
  single-consumer helper cfgs in the shadow-hand Direct cfg.
- Compute the orientation error through
  isaaclab.utils.math.quat_error_magnitude and delete the local
  direct_reorient_rotation_distance primitive.
- Rename direct_reorient_reward to reorient_reward: shared symbols
  carry no paradigm prefix.

Source commits on the lump branch: 2c22af0, 792e400,
42675b6, c6140f9, 173e9dc.
Part 3 share of the lump readability round (cdaadac): the Direct
cfg files keep only task values; asset and marker cfgs, name lists,
backend presets, and noise cfgs move to shadow_hand_common and
allegro_hand_common, task geometry to reorient_common, and
reorient_task_base is removed. The Shadow Direct files carry the
workflow marker in their names.
…eanup-dex-part04

# Conflicts:
#	source/isaaclab_tasks/test/core/test_dexterous_task_math.py
Part 4 share of the lump readability round (cdaadac): the camera
Direct files carry the workflow marker in their names and read the
camera geometry from reorient_common; handover_task_base is renamed
handover_common and the handover files take the Shadow identity from
shadow_hand_common. Sim settings are declared inline per file.
The shadow_hand_env_cfg -> shadow_hand_direct_env_cfg rename landed at
this layer while two consumers kept importing the removed module name,
so the part tree no longer stood alone (caught by arm-ci kitless
rendering collection). Pin the camera cfg import to
shadow_hand_direct_env_cfg and the handover robot cfg import to
shadow_hand_common, matching the final tree.
@hujc7
hujc7 requested a review from Toni-SM as a code owner July 23, 2026 21:57
@hujc7
hujc7 requested a review from a team July 23, 2026 21:57
@github-actions github-actions Bot added the asset New asset feature or request label Jul 23, 2026
@hujc7 hujc7 changed the title [Task Clean-up][Docs] Regenerate the stale environment overview table [Task Clean-up][Docs] Dexterous Part 9/9: Environment overview updates for the reorientation series Jul 23, 2026
@hujc7 hujc7 changed the title [Task Clean-up][Docs] Dexterous Part 9/9: Environment overview updates for the reorientation series [Task Clean-up][Docs] Dexterous Part 7/9: Environment overview updates for the reorientation series Jul 23, 2026
The vision env renders through the Isaac RTX tiled camera, whose render
products require the Fabric cloning path. The Newton backend disables
Fabric cloning, so under Newton the rgb annotator has no render products
at num_envs > 1 and the default RGB/depth/semantic render fails with
"Annotator rgb is not attached to any render products".

The shared PhysicsCfg/RobotCfg/ObjectCfg now default to Newton, so the
camera env inherited a Newton default it cannot render with. Override the
camera env's backend PresetCfgs to default to PhysX in __post_init__;
Newton stays selectable via physics=newton_mjwarp for the depth-only
Newton-warp-renderer benchmark path.
hujc7 added a commit that referenced this pull request Jul 24, 2026
…eorientation Direct tasks (#6413)

## Review Map

- **Exact changes**: a stacked PR's page shows the cumulative diff of
its dependency chain; the link pins the commit range that is the PR's
own contribution.
- Links pin specific SHAs and can go stale after a branch update — the
table on #6324 is refreshed first.

| PR | Status | Depends on | Exact changes |
|---|---|---|---|
| #6411 Part 1/9: Newton cloner/cubric/visualizer fixes |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6411?label=)
| — | merged |
| #6412 Part 2/9: OVPhysX articulation + manager runtime |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6412?label=)
| — | merged |
| 📌 #6413 Part 3/9: Reorient Direct, torch (this PR) |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6413?label=)
| — |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6413/changes/f4895f0f9ee..d29afc75e71)
|
| #6414 Part 4/9: MARL-to-single-agent fix + handover/camera Direct |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6414?label=)
| #6413 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6414/changes/d29afc75e71..b10a84948f8)
|
| #6418 Part 5/9: Reorient manager counterparts |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6418?label=)
| #6413 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6418/changes/d29afc75e71..707d37f8f99)
|
| #6421 Part 6/9: Handover + camera manager counterparts |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6421?label=)
| #6413, #6414, #6418 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6421/changes/707d37f8f99..b50ac8906fc)
|
| #6410 Part 7/9: Environment overview docs |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6410?label=)
| #6421 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6410/changes/b50ac8906fc..af259c0778d)
|
| #6415 Part 8/9: Benchmark success-rate utilities |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6415?label=)
| #6421 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6415/changes/b50ac8906fc..c7f2f019d8b)
|
| #6582 Part 9/9: Warp variants → experimental (draft; merges last) |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6582?label=)
| #6413 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6582/changes/d29afc75e71..167c28578b3)
|
| #6324 [DO-NOT-MERGE] Lumped validation reference |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6324?label=)
| ALL | — |

## Summary

- Adds a behavioral `Metrics/success_rate` signal (goal-reach streaks
per episode) and threshold-independent episode orientation-error
diagnostics to the Direct reorientation environments; success gates task
health, reward stays diagnostic.
- Task logic is **torch-first** per the mainline convention (plain torch
buffers; `.torch` accessors only at the core-lib boundary). This
supersedes the earlier warp-first revision of this PR; the warp
implementation moved to `isaaclab_tasks_experimental`
(#6582).
- Lands shared helpers in `isaaclab_tasks.core.utils`
(`EpisodeErrorRecorder`, `sample_joint_positions_within_limits`) with
torch math tests; fixes hand resets below lower joint limits.

## Stacking

- First stack PR; based on `develop`.

## Validation

- Kit-free torch math + utils tests green; Direct state training on
Newton: success rate 0.85–1.00, reward ≈3600–3900 at 2000 iterations,
frame-verified policy video. Full integrated evidence: #6324.

## Review history

- The earlier warp-era review rounds on this PR are superseded by the
torch restack (2026-07-16); the warp implementation and its
review-polished kernels live on in
#6582.
@configclass
class ShadowHandCameraEnvCfg(ShadowHandEnvCfg):
# scene
scene: InteractiveSceneCfg = InteractiveSceneCfg(num_envs=1225, env_spacing=2.0, replicate_physics=True)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] This field replaces the parent backend-aware scene preset with a plain InteractiveSceneCfg, whose clone_in_fabric default is False. The __post_init__ below says RTX render products require Fabric cloning, but it only switches the physics, robot, and object defaults. Resolving Isaac-Reorient-Cube-Shadow-Camera-Direct currently yields PhysxCfg, clone_in_fabric=False, and 1225 environments, so this does not establish the invariant the comment claims. Please make the camera scene backend-aware (defaulting the PhysX path to clone_in_fabric=True) and add a regression test for the fully resolved registered-task defaults.

physx = _ShadowHandCameraManagerSceneCfg(clone_in_fabric=True)
newton_mjwarp = _ShadowHandCameraManagerSceneCfg(clone_in_fabric=False)
ovphysx = physx
default = newton_mjwarp

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] The manager camera task still defaults to Newton with clone_in_fabric=False at 1225 environments—the exact combination the Direct-camera fix says cannot produce default RTX render products. Resolving Isaac-Reorient-Cube-Shadow-Camera confirms NewtonCfg plus clone_in_fabric=False. Please use one shared camera backend/default selection for both workflows so scene, physics, robot, and object resolve consistently to the working PhysX/Fabric path, and cover both task IDs in the same regression test.


Removed
^^^^^^^

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] Blocking per the repository API policy: public APIs cannot be removed until they have been deprecated in a prior release. A major changelog entry does not replace that transition period. Please retain ReorientObjectEnvCfg, the exported MDP terms, and the renamed public modules as forwarding compatibility shims that emit DeprecationWarning; remove them only after the documented deprecation window.

state_space = 290

# simulation
# simulation — values mirrored by the manager cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] I cannot find the claimed value-parity test, while these simulation and task constants are duplicated again in HandoverManagerEnvCfg. This comment is therefore factually misleading and the values can drift silently. Prefer a shared task-parameter source; if duplication is unavoidable, add an explicit Direct/manager contract test and keep production comments focused on behavior rather than test implementation.

ccd_iterations=50, # bumped from default 35 for multi-finger contact geometry
),
num_substeps=2,
# 4 substeps (vs the single-agent port's 2): sustained ball-palm contact

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This is an experiment log rather than durable source documentation: it embeds a particular environment count, probe duration, and observed failure percentage to justify one value. Please keep only the functional invariant here, such as that four substeps prevent non-finite sustained ball–palm contacts, and move the benchmark history/evidence to the PR or benchmark documentation. Please apply the same cleanup to the other provenance-heavy comments in this configuration.

random_values = math_utils.sample_uniform(-1.0, 1.0, (count, 2), device=device)
x_unit = torch.tensor([1.0, 0.0, 0.0], device=device).repeat(count, 1)
y_unit = torch.tensor([0.0, 1.0, 0.0], device=device).repeat(count, 1)
return math_utils.quat_mul(

@AntoineRichard AntoineRichard Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] random_xy_rotation() at lines 58-74 and randomize_rotation() at lines 77-82 implement the same ordered composition: sample/accept two values in [-1, 1], scale each by pi, build X- and Y-axis quaternions, then return quat_mul(x_rotation, y_rotation). The manager reset calls the first helper at line 119, while ReorientDirectEnv calls the second at lines 271 and 300, so the supposedly shared Direct/manager reset contract has two math implementations that can drift. Keep random_xy_rotation() only as the sampling wrapper and return randomize_rotation(random_values[:, 0], random_values[:, 1], x_unit, y_unit) from it. Add a deterministic helper-level assertion using fixed samples to lock the order and (x, y, z, w) convention.

@AntoineRichard AntoineRichard left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review]

Requesting changes for the inline correctness, API-compatibility, comment-quality, and duplication findings.

One additional blocking issue cannot be attached inline because the affected line is unchanged: scripts/demos/hands.py:53 still imports the deleted shadow_hand_env_cfg module, so the demo now fails during import. Please update the call site and keep the old module as a deprecated forwarding shim.

PR hygiene: the pinned exact-change range ends at af259c0, while the current head is f1afcc6; the docs-only bot summary therefore misses the latest runtime change. Please refresh the review map.

Verification performed: full pre-commit passed; 24 CPU unit tests and 108 kitless registered-task config tests passed. Camera runtime tests were unavailable because Isaac Sim is not installed in the review environment.

physx_cfg = SHADOW_HAND_CFG.replace(prim_path=prim_path).replace(
init_state=ArticulationCfg.InitialStateCfg(pos=init_pos, rot=init_rot, joint_pos={".*": 0.0})
)
# Newton's importer bakes the asset's native root orientation into the

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This block mixes the durable requirement (compose the task rotation with Newton’s baked root rotation) with debugging history and comparison to the previous Warp calculation. Please state only the functional constraint and required quaternion order here; move the former behavior and bit-for-bit provenance to the PR or a regression test.

state_space = 187 + 27 # asymmetric states + vision CNN embedding

def __post_init__(self):
# The vision env renders through the Isaac RTX tiled camera, whose render

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This seven-line rationale is longer than the configuration it explains and narrates backend failure and benchmark history. Keep the source comment to the enforceable functional constraint—for example, “RTX tiled cameras require Fabric cloning; default camera tasks to the PhysX/Fabric scene.”—and move the failure details and benchmark-path provenance to the PR or documentation. The code must also establish clone_in_fabric=True, as noted in the correctness thread above.



@configclass
class ReorientObjectEnvCfg(ManagerBasedRLEnvCfg):

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] This is the concrete public-class deletion covered by the compatibility finding. ReorientObjectEnvCfg was importable from isaaclab_tasks.core.reorient.reorient_manager_env_cfg; deleting the whole module makes downstream imports fail before users can migrate. Keep this module and class as a deprecated forwarding compatibility layer for at least one release, point it to the supported replacement where semantics permit, and add an import-level regression test for the legacy path.

#
# SPDX-License-Identifier: BSD-3-Clause

"""Shadow Hand identity shared by the Direct and manager-based reorientation tasks.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] Moving these definitions from shadow_hand_env_cfg.py to shadow_hand_common.py removes the old import path without a deprecation window. This already breaks scripts/demos/hands.py:53, and skills/user/use-sensors-actuators/examples.md:58 still directs users to the deleted file. Update those references now and retain shadow_hand_env_cfg.py as a deprecated forwarding module that re-exports the moved public names; add a test that imports ShadowHandRobotCfg through the legacy path.

def __post_init__(self):
self.decimation = 2
self.episode_length_s = 7.5
# simulation — mirrors the Direct cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This is the second copy of the handover simulation settings named in the Direct-config thread. The duplicated contract is decimation=2, episode_length_s=7.5, dt=1/120, render_interval=2, friction (1.0, 1.0), and PhysicsCfg(), but no parity test exists in source/isaaclab_tasks/test. Move these task-defining values to one shared configuration source consumed by both workflows, or add a parameterized test that resolves both registered task configs and compares each field. Until that safeguard exists, remove the false “guarded” claim.

obs_type = "full"
# simulation

# simulation — values mirrored by the manager cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This comment claims a safeguard that is not present: there is no Direct/manager value-parity test under source/isaaclab_tasks/test. The same Allegro values are assigned independently again in AllegroCubeEnvCfg.__post_init__ (allegro_hand_manager_env_cfg.py:295-302), including decimation, episode length, timestep, render interval, friction, and PhysicsCfg. Put these values in a shared task-parameter config used by both classes, or add a parameterized registered-config contract test that compares every duplicated field; otherwise this comment will conceal drift instead of preventing it.

def __post_init__(self):
self.decimation = 4
self.episode_length_s = 10.0
# simulation — mirrors the Direct cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This is the manager-side duplicate referenced in the Direct-config thread, and it is not guarded by any test. These assignments independently reproduce AllegroHandEnvCfg.sim plus its control timing, so changing either workflow can silently change training dynamics relative to the other. Consume a shared parameter object here, or add an explicit contract test covering decimation, episode_length_s, sim.dt, sim.render_interval, both friction coefficients, and the resolved physics preset. Remove the “guarded” wording unless that test is added in this PR.

asymmetric_obs = False
obs_type = "full"

# simulation — values mirrored by the manager cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] No value-parity test guards this state-task configuration. ShadowHandManagerEnvCfg.__post_init__ independently repeats the control and simulation values at shadow_hand_manager_env_cfg.py:218-225, while scene/backend defaults are declared through a separate preset. A future one-line tuning change can therefore make Direct and manager tasks diverge while this comment still promises parity. Share the task-defining values, or add a registered-config contract test covering timing, material, physics, and backend-resolved scene defaults; remove the unsupported test claim otherwise.

def __post_init__(self):
self.decimation = 2
self.episode_length_s = 10.0
# simulation — mirrors the Direct cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This is the manager-side copy of ShadowHandEnvCfg timing and simulation state, but the asserted parity test does not exist. Please eliminate the independent assignments through a shared task-parameter source, or add a contract test that resolves Isaac-Reorient-Cube-Shadow and Isaac-Reorient-Cube-Shadow-Direct and compares decimation, episode duration, timestep, render interval, material coefficients, physics backend, and scene-cloning choice. Without one of those safeguards, delete the misleading “guarded” claim.

asymmetric_obs = True
obs_type = "openai"

# simulation — values mirrored by the manager cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This OpenAI variant makes a second unsupported parity claim. Its decimation=3, episode_length_s=8.0, dt=1/60, render interval, material, and physics values are repeated in ShadowHandOpenAIManagerEnvCfg.__post_init__ (shadow_hand_openai_manager_env_cfg.py:222-229), but no test compares the resolved configs. Share these parameters or add a contract test for the FF/LSTM Direct and manager task IDs; otherwise remove the factual claim that a value-parity test guards them.

def __post_init__(self):
self.decimation = 3
self.episode_length_s = 8.0
# simulation — mirrors the Direct cfg (guarded by the value-parity test)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Moderate] This is the manager-side copy for the OpenAI FF/LSTM family, and it is not guarded by a parity test. Because both task IDs share this class while the Direct variants use ShadowHandOpenAIEnvCfg, drift here changes the control frequency and physics seen by one workflow only. Centralize the six repeated timing/simulation fields, or add a parameterized test over both FF and LSTM Direct/manager registrations that compares their fully resolved configs. Remove the “guarded” wording if the test is not part of this change.

@@ -6,6 +6,7 @@

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] This new runtime module replaces the public shadow_hand_camera_env.py import path, but the old module is removed immediately. Existing code importing ShadowHandCameraEnv from that path will fail even though the class itself still exists here. Retain shadow_hand_camera_env.py as a deprecated forwarding module that re-exports ShadowHandCameraEnv from this module (and preserves the separately documented compute_keypoints deprecation), then add a legacy-import test so the shim survives future cleanup.

#
# SPDX-License-Identifier: BSD-3-Clause

from __future__ import annotations

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] This configuration module replaces shadow_hand_camera_env_cfg.py, but deleting the old path breaks imports of ShadowHandTiledCameraCfg, ShadowHandCameraEnvCfg, and the benchmark/play configs before any deprecation period. Keep shadow_hand_camera_env_cfg.py as a deprecated forwarding module that re-exports the corresponding names from this Direct-camera module, and test at least the legacy module import plus construction of ShadowHandCameraEnvCfg. The new manager module can remain additive; it does not justify removing the established Direct path.

class EpisodeErrorRecorder:
"""Record the minimum physical error reached in each episode.

def success_bonus(

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] These are the actual public reward-term removals summarized in the changelog: success_bonus here, track_pos_l2 at line 51, and track_orientation_inv_l2 at line 75. They were exported through the package’s lazy MDP namespace, so external manager configs can reference them directly and will now fail at import/config resolution. Preserve the three callables with their existing signatures during the deprecation window—wrapping a new equivalent only where semantics are genuinely identical—and add import/call compatibility tests. Migration guidance to ReorientReward is not sufficient because that class does not preserve these function signatures.

from .commands import ReorientCommand


def max_consecutive_success(env: ManagerBasedRLEnv, num_success: int, command_name: str) -> torch.Tensor:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

[AI Review][Important] These are the concrete termination-term removals behind the changelog entry: max_consecutive_success here, object_away_from_goal at line 35, and object_away_from_robot at line 63. All three were reachable from isaaclab_tasks.core.reorient.mdp; deleting them breaks downstream manager configurations before migration code can run. Retain deprecated compatibility callables with the old names and signatures for the required release window, document the exact replacement for each function separately, and add a legacy-import/config-resolution test. A single pointer to ReorientTimeout does not demonstrate equivalent behavior for all three contracts.

hujc7 added a commit that referenced this pull request Jul 29, 2026
… and enable handover Direct RSL-RL (#6414)

## Review Map

- **Exact changes**: a stacked PR's page shows the cumulative diff of
its dependency chain; the link pins the commit range that is the PR's
own contribution. This PR (#6414) is now rebased directly onto
`develop`, so its own **Files changed** tab is its contribution.
- Links pin specific SHAs and can go stale after a branch update — the
table on #6324 is refreshed first.

| PR | Status | Depends on | Exact changes |
|---|---|---|---|
| #6411 Part 1/9: Newton cloner/cubric/visualizer fixes |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6411?label=)
| — | merged |
| #6412 Part 2/9: OVPhysX articulation + manager runtime |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6412?label=)
| — | merged |
| #6413 Part 3/9: Reorient Direct, torch |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6413?label=)
| — | merged |
| 📌 #6414 Part 4/9: MARL-to-single-agent fix + handover/camera Direct
(this PR) |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6414?label=)
| — (on develop) | Files changed tab |
| #6418 Part 5/9: Reorient manager counterparts |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6418?label=)
| #6413 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6418/changes/d29afc75e71..707d37f8f99)
|
| #6421 Part 6/9: Handover + camera manager counterparts |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6421?label=)
| #6414, #6418 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6421/changes/707d37f8f99..b50ac8906fc)
|
| #6410 Part 7/9: Environment overview docs |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6410?label=)
| #6421 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6410/changes/b50ac8906fc..af259c0778d)
|
| #6415 Part 8/9: Benchmark success-rate utilities |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6415?label=)
| #6421 |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6415/changes/b50ac8906fc..c7f2f019d8b)
|
| #6582 Part 9/9: Warp variants → experimental (draft; merges last) |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6582?label=)
| — |
[changes](https://github.com/isaac-sim/IsaacLab/pull/6582/changes/d29afc75e71..167c28578b3)
|
| #6324 [DO-NOT-MERGE] Lumped validation reference |
![](https://img.shields.io/github/pulls/detail/state/isaac-sim/IsaacLab/6324?label=)
| ALL | — |

## Summary

Converts the two-hand Shadow Hand **handover** task from multi-agent
(MARL) to **single-agent** (enabling RSL-RL training), fixes the
underlying MARL→single-agent observation bridge, and consolidates the
shared Shadow Hand definitions into the asset.

- **MARL → single-agent bridge (general, broader than this task).**
Single-agent RL libraries train `DirectMARLEnv` tasks via
`multi_agent_to_single_agent`; the bridge dropped the latest
observations from the public buffer. Fixed generally — RSL-RL
observations read from the env-owned `obs_buf`, stored by `reset` like
`step` on all env bases (`DirectRLEnv`, `DirectMARLEnv`, the
experimental warp base). Every MARL task + single-agent runner benefits;
handover is the first consumer.
- **Handover Direct → single-agent + RSL-RL.** Single-agent conversion,
RSL-RL runner config, shared identity in `handover_common`, success-rate
reward metrics, and a fix for its Newton construction failure (see
below).
- **Shadow Hand Newton robot → the asset.** Moved the Newton (MJWarp)
robot cfg into `isaaclab_assets` as `SHADOW_HAND_NEWTON_CFG` (beside
`SHADOW_HAND_CFG`); reorient and handover consume it as **siblings**
(neither imports the other). Reorient uses the default gains; handover
overrides only the finger stiffness/damping to `20/2` for its catch.
- **Shadow camera cleanup.** Renamed the camera Direct modules to
`shadow_hand_direct_camera_env[_cfg]`; moved cube-keypoint math to the
shared, unit-tested `reorient/mdp/observations.py` (replacing the
per-env `compute_keypoints` shim); and added OVPhysX physics presets to
the handover and camera Direct environments. The camera env config is
otherwise unchanged from develop.

### Behavior changes

**Reorient-on-Newton is unchanged.** The Newton hand definition moves
**verbatim** into `SHADOW_HAND_NEWTON_CFG` — same joint expressions,
effort limits, gains, friction and armature — so its config diff vs
`develop` is purely the move, and the Direct env config has no diff at
all.

Handover changes in three ways:

- Its **default physics backend moves from PhysX to Newton** (MJWarp),
matching the reorientation tasks. Pass `physics=physx` for the previous
backend.
- Its `distal_passive` actuator group is **removed**. It targeted
`robot0_(FF|MF|RF|LF)J0` — joints that **do not exist** on the Newton
asset (its fingers are numbered `J1`–`J4`/`J5`), so constructing the
environment raised `No joints found for actuator group`. The `fingers`
group already drives those joints, and the comment justifying the group
(USD-baked `stiffness=286/damping=57`) does not apply to this asset,
which authors no drive stiffness at all.
- Two orientation fixes: the goal orientation was initialized to a
180-degree rotation instead of identity, and the Newton root rotation
replaced the asset's baked rotation instead of composing with it,
leaving both palms rotated 90 degrees.

Two pre-existing discrepancies were found while verifying against the
asset and are left for a follow-up, since each is a behavior change
needing its own validation: the config sets `armature=2e-3` where the
asset authors `0.0002`, and the per-finger `J1`/`J2` pair is coupled by
a fixed tendon that the MJWarp solver currently skips — the actuator
gains are what hold that pair together today, which is why the `J4`
knuckle-abduction joints cannot simply be added to the driven set.

## Notes

- Rebased onto **latest develop**; clean 3-commit history: `Add
single-agent flattening for MARL Direct environments` / `Convert Shadow
Hand handover to single-agent Direct with RSL-RL` / `Clean up Shadow
reorient/camera tasks and consolidate the Newton hand`.

## Validation

- Kit-free suite green: handover, keypoint math, the MARL adapter, and
new checks pinning the RSL-RL wrapper observation contract (verified to
fail against the previous implementation).
- Camera Direct reaches training takeoff under `rsl_rl` (frame-verified
videos); its env config now matches develop's established vision env.
- **Reorient-on-Newton vs `develop`** (`rsl_rl`, 2048 envs, 1500
iterations, 4 runs per config): this branch spans 524–664 reward,
`develop` spans 654–822 — overlapping distributions whose per-config
spreads (140–168) exceed the gap between them. The move is additionally
verified at the config level: the Newton robot configuration is
character-for-character identical to `develop`'s.
- **Handover-on-Newton** trains end-to-end on this branch (reward 1314),
which the `develop` config cannot do at all — it fails during
construction. Full evidence: #6324.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

asset New asset feature or request documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants