Skip to content

Commit 31adca7

Browse files
committed
Merge develop into docs/consolidate-migration-guide
2 parents 9c091cd + 493e3e3 commit 31adca7

111 files changed

Lines changed: 3409 additions & 1601 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

apps/isaaclab.python.headless.kit

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,6 @@ enabled=true # Enable this for DLSS
198198
########################
199199
[dependencies]
200200
"isaacsim.core.version" = {}
201-
# USD schema plugins must load before the schema registry is first accessed.
202-
"omni.usd.schema.mujoco" = {}
203201

204202
# Asset path
205203
# set the S3 directory manually to the latest published S3

apps/isaaclab.python.kit

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ keywords = ["experience", "app", "usd"]
1616
"isaacsim.gui.components" = {}
1717
"isaacsim.simulation_app" = {}
1818
"isaacsim.storage.native" = {}
19-
# USD schema plugins must load before the schema registry is first accessed.
20-
"omni.usd.schema.mujoco" = {}
2119

2220
# Kit based editor extensions
2321
"omni.anim.curve.core" = {}

docs/_extensions/isaaclab_docs.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,13 +189,20 @@ def _quickstart_kitless(branch: str, platform: str) -> str:
189189

190190

191191
class IsaacLabIsaacSimInstall(SphinxDirective):
192-
"""Render the ``uv pip install isaacsim`` command pinned to the pyproject version."""
192+
"""Render the Isaac Sim install command pinned to the pyproject version."""
193193

194-
has_content = False
194+
optional_arguments = 1 # installer: "pip" (default is "uv pip")
195195

196196
def run(self) -> list[nodes.Node]:
197197
version = self.config.isaacsim_version
198-
content = f"""\
198+
if self.arguments and self.arguments[0] == "pip":
199+
content = f"""\
200+
.. code-block:: bash
201+
202+
python -m pip install "isaacsim[all,extscache]=={version}" --extra-index-url https://pypi.nvidia.com
203+
"""
204+
else:
205+
content = f"""\
199206
.. code-block:: bash
200207
201208
uv pip install "isaacsim[all,extscache]=={version}" --extra-index-url https://pypi.nvidia.com --index-strategy unsafe-best-match --prerelease=allow
@@ -260,7 +267,7 @@ class IsaacLabTorchInstall(SphinxDirective):
260267

261268
def run(self) -> list[nodes.Node]:
262269
cuda_tag = self.arguments[0]
263-
installer = "pip" if len(self.arguments) > 1 and self.arguments[1] == "pip" else "uv pip"
270+
installer = "python -m pip" if len(self.arguments) > 1 and self.arguments[1] == "pip" else "uv pip"
264271
torch_version = self.config.torch_version
265272
torchvision_version = self.config.torchvision_version
266273
content = f"""\
75.4 KB
Loading

docs/source/api/lab/isaaclab.renderers.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ isaaclab.renderers
88
.. autosummary::
99

1010
BaseRenderer
11-
Renderer
1211
RendererCfg
1312

1413
Base Renderer
@@ -19,14 +18,6 @@ Base Renderer
1918
:show-inheritance:
2019
:exclude-members: __init__
2120

22-
Renderer Factory
23-
----------------
24-
25-
.. autoclass:: Renderer
26-
:members:
27-
:show-inheritance:
28-
:exclude-members: __init__
29-
3021
Renderer Configuration
3122
-----------------------
3223

docs/source/api/lab/isaaclab.sim.schemas.rst

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,47 @@ isaaclab.sim.schemas
3030
BoundingCubePropertiesCfg
3131
BoundingSpherePropertiesCfg
3232

33+
.. rubric:: Schema fragments
34+
35+
A fragment mirrors exactly one USD applied schema and writes into a single attribute
36+
namespace. The family writers below dispatch lists of fragments to the prims matched by
37+
a target expression. See :ref:`schema-fragments` for the concept and the spawner-level
38+
usage. Backend fragments live in :mod:`isaaclab_physx.sim.schemas` and
39+
:mod:`isaaclab_newton.sim.schemas`.
40+
41+
.. autosummary::
42+
43+
SchemaFragment
44+
RigidBodyFragment
45+
CollisionFragment
46+
MassFragment
47+
ArticulationRootFragment
48+
JointDriveFragment
49+
MeshCollisionFragment
50+
FixedTendonFragment
51+
SpatialTendonFragment
52+
UsdPhysicsRigidBodyCfg
53+
UsdPhysicsCollisionCfg
54+
UsdPhysicsDriveCfg
55+
UsdPhysicsMeshCollisionCfg
56+
MassCfg
57+
58+
.. rubric:: Fragment writers
59+
60+
.. autosummary::
61+
62+
apply_rigid_body_properties
63+
apply_collision_properties
64+
apply_mass_properties
65+
apply_articulation_root_properties
66+
apply_joint_drive_properties
67+
apply_mesh_collision_properties
68+
apply_fixed_tendon_properties
69+
apply_spatial_tendon_properties
70+
apply_namespaced
71+
apply_drive
72+
apply_mesh_collision
73+
3374
.. rubric:: Functions
3475

3576
.. autosummary::
@@ -51,6 +92,90 @@ isaaclab.sim.schemas
5192
define_deformable_curve_properties
5293
modify_deformable_body_properties
5394

95+
Schema Fragments
96+
----------------
97+
98+
.. autoclass:: SchemaFragment
99+
:members:
100+
:exclude-members: __init__
101+
102+
.. autoclass:: RigidBodyFragment
103+
:members:
104+
:show-inheritance:
105+
:exclude-members: __init__
106+
107+
.. autoclass:: CollisionFragment
108+
:members:
109+
:show-inheritance:
110+
:exclude-members: __init__
111+
112+
.. autoclass:: MassFragment
113+
:members:
114+
:show-inheritance:
115+
:exclude-members: __init__
116+
117+
.. autoclass:: ArticulationRootFragment
118+
:members:
119+
:show-inheritance:
120+
:exclude-members: __init__
121+
122+
.. autoclass:: JointDriveFragment
123+
:members:
124+
:show-inheritance:
125+
:exclude-members: __init__
126+
127+
.. autoclass:: MeshCollisionFragment
128+
:members:
129+
:show-inheritance:
130+
:exclude-members: __init__
131+
132+
.. autoclass:: FixedTendonFragment
133+
:members:
134+
:show-inheritance:
135+
:exclude-members: __init__
136+
137+
.. autoclass:: SpatialTendonFragment
138+
:members:
139+
:show-inheritance:
140+
:exclude-members: __init__
141+
142+
.. autoclass:: UsdPhysicsRigidBodyCfg
143+
:members:
144+
:show-inheritance:
145+
:exclude-members: __init__
146+
147+
.. autoclass:: UsdPhysicsCollisionCfg
148+
:members:
149+
:show-inheritance:
150+
:exclude-members: __init__
151+
152+
.. autoclass:: UsdPhysicsDriveCfg
153+
:members:
154+
:show-inheritance:
155+
:exclude-members: __init__
156+
157+
.. autoclass:: UsdPhysicsMeshCollisionCfg
158+
:members:
159+
:show-inheritance:
160+
:exclude-members: __init__
161+
162+
.. autoclass:: MassCfg
163+
:members:
164+
:show-inheritance:
165+
:exclude-members: __init__
166+
167+
.. autofunction:: apply_rigid_body_properties
168+
.. autofunction:: apply_collision_properties
169+
.. autofunction:: apply_mass_properties
170+
.. autofunction:: apply_articulation_root_properties
171+
.. autofunction:: apply_joint_drive_properties
172+
.. autofunction:: apply_mesh_collision_properties
173+
.. autofunction:: apply_fixed_tendon_properties
174+
.. autofunction:: apply_spatial_tendon_properties
175+
.. autofunction:: apply_namespaced
176+
.. autofunction:: apply_drive
177+
.. autofunction:: apply_mesh_collision
178+
54179
Articulation Root
55180
-----------------
56181

docs/source/api/lab/isaaclab.visualizers.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,10 @@ The following classes are part of the public :mod:`isaaclab.visualizers` API.
1414
:nosignatures:
1515

1616
BaseVisualizer
17-
Visualizer
1817
VisualizerCfg
1918

2019
.. autoclass:: BaseVisualizer
2120
:show-inheritance:
2221

23-
.. autoclass:: Visualizer
24-
:show-inheritance:
25-
2622
.. autoclass:: VisualizerCfg
2723
:show-inheritance:

docs/source/experimental-features/rlinf_vla_posttraining.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Quick Start
134134

135135
.. code-block:: bash
136136
137-
uv run isaaclab train --rl_library rlinf \
137+
uv run --extra rlinf isaaclab train --rl_library rlinf \
138138
--config_name isaaclab_ppo_gr00t_assemble_trocar \
139139
--model_path /path/to/base_model
140140
@@ -154,7 +154,7 @@ Quick Start
154154

155155
.. code-block:: bash
156156
157-
uv run --extra video isaaclab play --rl_library rlinf \
157+
uv run --extra rlinf,video isaaclab play --rl_library rlinf \
158158
--config_name isaaclab_ppo_gr00t_assemble_trocar \
159159
--model_path /path/to/base_model \
160160
--video
@@ -176,7 +176,7 @@ Quick Start
176176

177177
.. code-block:: bash
178178
179-
uv run --extra video isaaclab play --rl_library rlinf \
179+
uv run --extra rlinf,video isaaclab play --rl_library rlinf \
180180
--config_name isaaclab_ppo_gr00t_assemble_trocar \
181181
--model_path /path/to/base_model \
182182
--checkpoint /path/to/checkpoints/global_step_N \

docs/source/features/hydra.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ As a result, training with hydra arguments can be run with the following syntax:
4646

4747
.. code-block:: shell
4848
49-
uv run isaaclab train --rl_library rl_games --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.params.seed=2024
49+
uv run --extra rl-games isaaclab train --rl_library rl_games --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.params.seed=2024
5050
5151
.. tab-item:: isaaclab.sh / isaaclab.bat
5252

@@ -63,7 +63,7 @@ As a result, training with hydra arguments can be run with the following syntax:
6363

6464
.. code-block:: shell
6565
66-
uv run isaaclab train --rl_library skrl --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.seed=2024
66+
uv run --extra skrl isaaclab train --rl_library skrl --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.seed=2024
6767
6868
.. tab-item:: isaaclab.sh / isaaclab.bat
6969

@@ -80,7 +80,7 @@ As a result, training with hydra arguments can be run with the following syntax:
8080

8181
.. code-block:: shell
8282
83-
uv run isaaclab train --rl_library sb3 --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.seed=2024
83+
uv run --extra sb3 isaaclab train --rl_library sb3 --task=Isaac-Cartpole env.actions.joint_effort.scale=10.0 agent.seed=2024
8484
8585
.. tab-item:: isaaclab.sh / isaaclab.bat
8686

docs/source/features/multi_gpu.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ For skrl JAX training, pass an integer GPU count and the ``--coordinator_address
473473

474474
.. code-block:: bash
475475
476-
uv run python scripts/reinforcement_learning/train_multigpu.py \
476+
uv run --extra skrl python scripts/reinforcement_learning/train_multigpu.py \
477477
--rl_library skrl --ml_framework jax --num_gpus 4 \
478478
--coordinator_address localhost:5000 \
479479
--task Isaac-Reorient-KukaAllegro \
@@ -494,7 +494,7 @@ For skrl JAX training, pass an integer GPU count and the ``--coordinator_address
494494

495495
.. code-block:: bash
496496
497-
uv run isaaclab train_multigpu --rl_library skrl --ml_framework jax --num_gpus 4 \
497+
uv run --extra skrl isaaclab train_multigpu --rl_library skrl --ml_framework jax --num_gpus 4 \
498498
--coordinator_address localhost:5000 \
499499
--task Isaac-Reorient-KukaAllegro \
500500
--num_envs 4096 --max_iterations 100

0 commit comments

Comments
 (0)