Skip to content

Commit dd20866

Browse files
Address agent review findings and refresh stale Newton task list
Verification agents flagged five issues against the previous two commits and one issue-isaac-sim#876 gap that the first pass missed. 1. Newton using-kamino.rst literalinclude path was one level short (../../../../../ → ../../../../../../). The previous depth resolved to a non-existent /docs/source/isaaclab_tasks/... and would have broken the sphinx build. 2. PhysX supported-features.rst listed Ray Caster, Visuo-tactile, and Camera as PhysX-specific sensors. Ray Caster and Camera are implemented in isaaclab core (backend-agnostic); Visuo-tactile lives in isaaclab_contrib. Reframe the section to separate PhysX-implemented sensors from backend-agnostic ones. Drop the unverifiable "path-traced" qualifier on the RTX renderer claim. 3. OvPhysX stub referenced only PR isaac-sim#5426 and PR isaac-sim#5459. The actual in-flight set spans six PRs: isaac-sim#5426 (merged), isaac-sim#5459, isaac-sim#5422, isaac-sim#5421, isaac-sim#5570, isaac-sim#5589. List them all with merge state, and reword "primary covered surfaces" to reflect that most are still open PRs. 4. backends/index.rst feature matrix said OvPhysX sensor coverage was "Partial" — actually only RigidObject is merged. Replace the matrix rows with concrete "In-flight (PR #...)" / "Not yet" cells. 5. Issue isaac-sim#876 asked to "review the limitations list and update it." The previous pass only reworded the intro. Refresh the task list against develop's actual newton_mjwarp coverage, add Shadow Hand / Shadow Hand Over / cabinet / dexsuite / rough-terrain locomotion, and replace the rigid bullet list with a discovery recipe so the list stops bit-rotting.
1 parent c9a73c3 commit dd20866

5 files changed

Lines changed: 120 additions & 68 deletions

File tree

docs/source/overview/core-concepts/backends/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,27 +81,27 @@ per-task support, see each backend's own ``limitations`` page.
8181
* - Articulation API
8282
- Yes
8383
- Yes
84-
- Yes (subset)
84+
- In-flight (PR #5459)
8585
* - Rigid Object API
8686
- Yes
8787
- Yes
88-
- Yes (subset)
89-
* - Contact Sensor
9088
- Yes
89+
* - Contact Sensor
9190
- Yes
9291
- Yes
93-
* - IMU / Frame Transformer / Ray Caster
92+
- In-flight (PR #5422)
93+
* - IMU
9494
- Yes
9595
- Yes
96-
- Partial — see backend page
97-
* - PVA / Joint-Wrench Sensor
96+
- In-flight (PR #5421)
97+
* - Frame Transformer / Ray Caster / PVA / Joint-Wrench Sensor
9898
- Yes
9999
- Yes
100-
- Partial
100+
- Not yet
101101
* - Camera / Tiled Rendering
102102
- Yes (RTX)
103103
- Yes (Newton-Warp renderer)
104-
- Yes (RTX) — depends on Isaac Sim
104+
- Not yet
105105
* - Requires Isaac Sim
106106
- Yes
107107
- Optional (only for the Omniverse visualizer)

docs/source/overview/core-concepts/backends/newton/limitations-and-known-bugs.rst

Lines changed: 81 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,84 @@ The Newton backend is in beta. Breaking changes and incomplete documentation are
55
still expected, and official support or debugging assistance will only be
66
available once the integration reaches an official release.
77

8-
Here is a non-exhaustive list of capabilities currently supported by the Newton
9-
backend, grouped by extension:
10-
11-
* isaaclab:
12-
* Articulation API (supports both articulations and single-body articulations as rigid bodies)
13-
* Contact Sensor
14-
* Direct & Manager single agent workflows
15-
* Omniverse Kit visualizer
16-
* Newton visualizer
17-
* isaaclab_assets:
18-
* Quadrupeds
19-
* Anymal-B, Anymal-C, Anymal-D
20-
* Unitree A1, Go1, Go2
21-
* Spot
22-
* Humanoids
23-
* Unitree H1 & G1
24-
* Cassie
25-
* Arms and Hands
26-
* Franka
27-
* UR10
28-
* Allegro Hand
29-
* Toy examples
30-
* Cartpole
31-
* Ant
32-
* Humanoid
33-
* isaaclab_tasks:
34-
* Direct:
35-
* Cartpole (State, RGB, Depth)
36-
* Ant
37-
* Humanoid
38-
* Allegro Hand Repose Cube
39-
* Manager based:
40-
* Cartpole (State)
41-
* Ant
42-
* Humanoid
43-
* Locomotion (velocity flat terrain)
44-
* Anymal-B
45-
* Anymal-C
46-
* Anymal-D
47-
* Cassie
48-
* A1
49-
* Go1
50-
* Go2
51-
* Unitree G1
52-
* Unitree H1
53-
* Manipulation reach
54-
* Franka
55-
* UR10
8+
9+
Discovering Newton-Supported Tasks
10+
----------------------------------
11+
12+
A task supports the Newton backend when its physics ``PresetCfg`` declares a
13+
``newton_mjwarp`` (or ``newton_kamino``) entry. To list every task that
14+
currently supports Newton:
15+
16+
.. code-block:: bash
17+
18+
grep -rln "newton_mjwarp" source/isaaclab_tasks/
19+
20+
Passing ``presets=newton_mjwarp`` to a task without that preset will raise an
21+
error at launch. The :doc:`solver-transitioning` page covers how to add a
22+
Newton preset to your own task.
23+
24+
25+
Supported Surface
26+
-----------------
27+
28+
The following capabilities are covered by the Newton backend on ``develop`` at
29+
the time of writing. The list is non-exhaustive and continues to grow.
30+
31+
isaaclab
32+
^^^^^^^^
33+
34+
* Articulation API (multi-link and single-body articulations)
35+
* Rigid Object and Rigid Object Collection APIs
36+
* Sensors: Contact Sensor, IMU, Frame Transformer, Joint Wrench, PVA
37+
* Direct and Manager-based single-agent workflows
38+
* Omniverse Kit visualizer (when Isaac Sim is installed)
39+
* Newton-Warp visualizer (kit-less)
40+
* Tiled rendering via the Newton-Warp renderer
41+
42+
isaaclab_assets
43+
^^^^^^^^^^^^^^^
44+
45+
* Quadrupeds: Anymal-B, Anymal-C, Anymal-D, Unitree A1, Unitree Go1, Unitree
46+
Go2, Spot
47+
* Humanoids: Unitree H1, Unitree G1, Cassie
48+
* Arms and hands: Franka, UR10, Allegro Hand, Shadow Hand
49+
* Toy examples: Cartpole, Ant, Humanoid
50+
51+
isaaclab_tasks
52+
^^^^^^^^^^^^^^
53+
54+
Direct workflows:
55+
56+
* Cartpole (state, RGB, depth)
57+
* Ant, Humanoid
58+
* Allegro Hand Repose Cube, Shadow Hand, Shadow Hand Over
59+
* Locomotion (shared base env)
60+
61+
Manager-based workflows:
62+
63+
* Classic: Cartpole, Ant, Humanoid
64+
* Locomotion velocity, flat terrain: A1, Anymal-B, Anymal-C, Anymal-D, Cassie,
65+
Unitree G1, Go1, Go2, Unitree H1, Spot
66+
* Locomotion velocity, rough terrain: Anymal-C, Cassie, Go1, Go2
67+
* Manipulation: reach (Franka, UR10), cabinet, dexsuite
68+
69+
70+
Solver Coverage
71+
---------------
72+
73+
* **MuJoCo-Warp solver**: the primary, validated path for every supported task.
74+
* **Kamino solver**: beta. Currently validated on ``Isaac-Cartpole-Direct-v0``,
75+
``Isaac-Ant-Direct-v0``, ``Isaac-Cartpole-v0``, and ``Isaac-Ant-v0``. See
76+
:doc:`using-kamino`.
77+
78+
Other Newton solvers (e.g. VBD) are not yet exposed through Isaac Lab.
79+
80+
81+
Known Gaps
82+
----------
83+
84+
* Soft bodies, particles, and other non-rigid PhysX features are not yet
85+
available through Newton.
86+
* Behaviour on stiff contact stacks can diverge from PhysX; expect to retune
87+
contact and substep parameters when porting tasks across backends.
88+
* Multi-agent and self-play workflows are not yet wired up for Newton.

docs/source/overview/core-concepts/backends/newton/using-kamino.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ solver config types used by the presets:
4949
Then add a ``newton_kamino`` entry beside the existing ``default``, ``physx``, and
5050
``newton_mjwarp`` entries:
5151

52-
.. literalinclude:: ../../../../../source/isaaclab_tasks/isaaclab_tasks/direct/cartpole/cartpole_env_cfg.py
52+
.. literalinclude:: ../../../../../../source/isaaclab_tasks/isaaclab_tasks/direct/cartpole/cartpole_env_cfg.py
5353
:language: python
5454
:start-at: class CartpolePhysicsCfg
5555
:end-at: ovphysx: OvPhysxCfg = OvPhysxCfg()

docs/source/overview/core-concepts/backends/ovphysx/index.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,25 @@ What works today
3737
----------------
3838

3939
The asset and sensor surface tracks PhysX, but only a subset is implemented and
40-
validated at the time of writing. Articulation, Rigid Object, and Contact
41-
Sensor are the primary covered surfaces. Other sensors and renderer
42-
combinations are partial — consult the in-flight pull requests below for the
43-
current status:
40+
validated at the time of writing. Rigid Object support is merged on
41+
``develop``; the remaining assets and sensors are landing through a series of
42+
stacked pull requests:
4443

45-
* Articulation: `PR #5459 <https://github.com/isaac-sim/IsaacLab/pull/5459>`_
46-
* RigidObject: `PR #5426 <https://github.com/isaac-sim/IsaacLab/pull/5426>`_
44+
* RigidObject — merged via
45+
`PR #5426 <https://github.com/isaac-sim/IsaacLab/pull/5426>`_.
46+
* Articulation — open in
47+
`PR #5459 <https://github.com/isaac-sim/IsaacLab/pull/5459>`_.
48+
* Contact Sensor — open in
49+
`PR #5422 <https://github.com/isaac-sim/IsaacLab/pull/5422>`_.
50+
* IMU — open in
51+
`PR #5421 <https://github.com/isaac-sim/IsaacLab/pull/5421>`_.
52+
* RigidObjectCollection — open in
53+
`PR #5570 <https://github.com/isaac-sim/IsaacLab/pull/5570>`_.
54+
* SceneDataProvider — open in
55+
`PR #5589 <https://github.com/isaac-sim/IsaacLab/pull/5589>`_.
56+
57+
Other sensors (Frame Transformer, Joint Wrench, PVA, Ray Caster) and the
58+
rendering surface are not yet wired up for OvPhysX.
4759

4860
Status and follow-up
4961
--------------------

docs/source/overview/core-concepts/backends/physx/supported-features.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,27 @@ Core Simulation
2323
Sensors
2424
-------
2525

26+
PhysX implements the following sensors directly under
27+
``isaaclab_physx/sensors/``:
28+
2629
* Contact Sensor
2730
* IMU
2831
* Frame Transformer
29-
* Ray Caster
30-
* PVA
3132
* Joint Wrench Sensor
32-
* Visuo-tactile sensor
33-
* Camera (RTX) — see :doc:`../../sensors/camera`
33+
* PVA
34+
35+
The following sensors are backend-agnostic (implemented in ``isaaclab`` core)
36+
and work transparently with PhysX:
37+
38+
* Ray Caster
39+
* Camera — see :doc:`../../sensors/camera`
3440

3541

3642
Rendering
3743
---------
3844

39-
* RTX renderer (real-time and path-traced)
45+
* RTX renderer (real-time rasterized; path tracing available through the
46+
underlying Omniverse RTX pipeline)
4047
* Tiled rendering for vectorized RGB / depth / segmentation
4148

4249

0 commit comments

Comments
 (0)