Skip to content

Commit ed7fa88

Browse files
Update Kamino tutorial for renamed Newton presets
Update preset references in the Kamino tutorial after the rename in isaac-sim#5488 ("Rename Newton preset to MJWarp"): * ``presets=newton`` -> ``presets=newton_mjwarp`` * ``presets=kamino`` -> ``presets=newton_kamino`` * ``env.sim.physics=kamino`` -> ``env.sim.physics=newton_kamino`` * Backticked preset name references in prose updated to match. This brings the tutorial in line with the renamed preset keys and satisfies the regression check in ``test_newton_solver_preset_names.py``.
1 parent 1730053 commit ed7fa88

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

docs/source/experimental-features/newton-physics-integration/using-kamino.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Using the Kamino Solver
66
Kamino is a Newton solver, not a separate Isaac Lab physics backend. In Isaac Lab,
77
Kamino is enabled by selecting a :class:`~isaaclab_newton.physics.NewtonCfg` whose
88
``solver_cfg`` is :class:`~isaaclab_newton.physics.KaminoSolverCfg`.
9-
This is usually exposed as a ``kamino`` physics preset on the task configuration.
9+
This is usually exposed as a ``newton_kamino`` physics preset on the task configuration.
1010

1111
Kamino support is currently beta. A task that works with PhysX or with Newton's
1212
MuJoCo-Warp solver may still need task-specific asset, collision, reset, and solver
@@ -20,18 +20,18 @@ Before adding Kamino, first make sure the task runs with the Newton backend:
2020

2121
.. code-block:: bash
2222
23-
./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton
23+
./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton_mjwarp
2424
2525
Then run the same task with the Kamino preset if it is available:
2626

2727
.. code-block:: bash
2828
29-
./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=kamino
29+
./isaaclab.sh -p scripts/environments/zero_agent.py --task Isaac-Cartpole-Direct-v0 --num_envs 128 --viz newton presets=newton_kamino
3030
31-
At the time of writing, the ``kamino`` preset is defined for
31+
At the time of writing, the ``newton_kamino`` preset is defined for
3232
``Isaac-Cartpole-Direct-v0``, ``Isaac-Ant-Direct-v0``, ``Isaac-Cartpole-v0``,
33-
and ``Isaac-Ant-v0``. Passing ``presets=kamino`` to another task does not
34-
automatically enable Kamino; the task must define and validate its own ``kamino``
33+
and ``Isaac-Ant-v0``. Passing ``presets=newton_kamino`` to another task does not
34+
automatically enable Kamino; the task must define and validate its own ``newton_kamino``
3535
preset.
3636

3737

@@ -46,8 +46,8 @@ solver config types used by the presets:
4646
4747
from isaaclab_newton.physics import KaminoSolverCfg, MJWarpSolverCfg, NewtonCfg
4848
49-
Then add a ``kamino`` entry beside the existing ``default``, ``physx``, and
50-
``newton`` entries:
49+
Then add a ``newton_kamino`` entry beside the existing ``default``, ``physx``, and
50+
``newton_mjwarp`` entries:
5151

5252
.. literalinclude:: ../../../../source/isaaclab_tasks/isaaclab_tasks/direct/cartpole/cartpole_env_cfg.py
5353
:language: python
@@ -57,7 +57,7 @@ Then add a ``kamino`` entry beside the existing ``default``, ``physx``, and
5757

5858
The important pieces are:
5959

60-
* Add a ``kamino`` preset whose value is :class:`~isaaclab_newton.physics.NewtonCfg`.
60+
* Add a ``newton_kamino`` preset whose value is :class:`~isaaclab_newton.physics.NewtonCfg`.
6161
* Set ``solver_cfg=KaminoSolverCfg(...)`` inside that Newton config.
6262
* Keep the preset at the same config path used by the task's
6363
:class:`~isaaclab.sim.SimulationCfg`, for example ``env.sim.physics``.
@@ -66,17 +66,17 @@ You can select the preset globally:
6666

6767
.. code-block:: bash
6868
69-
./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Cartpole-v0 presets=kamino
69+
./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Cartpole-v0 presets=newton_kamino
7070
7171
or select the physics field directly:
7272

7373
.. code-block:: bash
7474
75-
./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Cartpole-v0 env.sim.physics=kamino
75+
./isaaclab.sh -p scripts/reinforcement_learning/rsl_rl/train.py --task=Isaac-Cartpole-v0 env.sim.physics=newton_kamino
7676
7777
Use the direct path override when only one task field should use the Kamino preset.
78-
Use ``presets=kamino`` when you want every matching preset field in the task config
79-
to resolve to ``kamino``.
78+
Use ``presets=newton_kamino`` when you want every matching preset field in the task config
79+
to resolve to ``newton_kamino``.
8080
Isaac Lab training scripts accept these Hydra overrides after the regular command
8181
line flags; no separator is needed for the examples above.
8282

@@ -87,7 +87,7 @@ Check Task and Asset Compatibility
8787
Kamino uses the Newton model built from the task assets. When adding Kamino to a
8888
new task, validate the following before tuning solver parameters:
8989

90-
* The task must already be compatible with the Newton backend. If ``presets=newton``
90+
* The task must already be compatible with the Newton backend. If ``presets=newton_mjwarp``
9191
fails during model construction, fix the asset or task configuration first.
9292
* The assets should use Newton-supported rigid bodies, articulations, and collision
9393
geometry. PhysX-only features, unsupported schemas, or missing collision shapes
@@ -226,9 +226,9 @@ Tuning Workflow
226226

227227
Use the following sequence when bringing up a new Kamino task:
228228

229-
1. Run the task with ``presets=newton`` and fix Newton model construction or task
229+
1. Run the task with ``presets=newton_mjwarp`` and fix Newton model construction or task
230230
compatibility issues first.
231-
2. Add a ``kamino`` preset with conservative values copied from the closest
231+
2. Add a ``newton_kamino`` preset with conservative values copied from the closest
232232
validated task.
233233
3. Run a small smoke test with a low environment count and a visualizer.
234234
4. Increase ``num_envs`` and profile only after the task is stable.

0 commit comments

Comments
 (0)