API Reference
=============

This page gives an overview of all the modules and classes in the Isaac Lab extensions.

isaaclab extension
------------------

The following modules are available in the ``isaaclab`` extension:

.. currentmodule:: isaaclab

.. autosummary::
   :toctree: lab

   app
   actuators
   assets
   cloner
   controllers
   devices
   envs
   managers
   markers
   physics
   renderers
   scene
   sensors
   sim
   terrains
   utils
   visualizers

.. toctree::
   :hidden:

   lab/isaaclab.envs.mdp
   lab/isaaclab.envs.ui
   lab/isaaclab.sensors.patterns
   lab/isaaclab.sim.converters
   lab/isaaclab.sim.schemas
   lab/isaaclab.sim.spawners
   lab/isaaclab.sim.views
   lab/isaaclab.sim.utils


isaaclab_rl extension
---------------------

The following wrappers are available in the ``isaaclab_rl`` extension:

.. currentmodule:: isaaclab_rl

.. toctree::
   :maxdepth: 2

   lab_rl/isaaclab_rl


isaaclab_mimic extension
------------------------

The following modules are available in the ``isaaclab_mimic`` extension:

.. currentmodule:: isaaclab_mimic

.. autosummary::
   :toctree: lab_mimic

   datagen
   envs

isaaclab_contrib extension
-----------------------------

The following modules are available in the ``isaaclab_contrib`` extension:

.. currentmodule:: isaaclab_contrib

.. autosummary::
   :toctree: lab_contrib

   actuators
   assets
   mdp
   rl
   sensors

isaaclab_tasks extension
------------------------

This package ``isaaclab_tasks`` contains the tasks that are available in the Isaac Lab.
For more information, please refer to the :ref:`environments`.

It includes the following modules:

.. currentmodule:: isaaclab_tasks

.. autosummary::
   :toctree: lab_tasks

   utils

isaaclab_teleop extension
-------------------------

The following modules are available in the ``isaaclab_teleop`` extension:

.. currentmodule:: isaaclab_teleop

.. toctree::
   :maxdepth: 2

   lab_teleop/isaaclab_teleop

isaaclab_physx extension
------------------------

The following modules are available in the ``isaaclab_physx`` extension:

.. currentmodule:: isaaclab_physx

.. autosummary::
   :toctree: lab_physx

   assets
   cloner
   physics
   renderers
   scene_data_providers
   sensors

.. toctree::
   :hidden:

   lab_physx/isaaclab_physx.assets
   lab_physx/isaaclab_physx.cloner
   lab_physx/isaaclab_physx.physics
   lab_physx/isaaclab_physx.renderers
   lab_physx/isaaclab_physx.scene_data_providers
   lab_physx/isaaclab_physx.sensors

isaaclab_newton extension
-------------------------

The following modules are available in the ``isaaclab_newton`` extension:

.. currentmodule:: isaaclab_newton

.. autosummary::
   :toctree: lab_newton

   assets
   cloner
   physics
   renderers
   scene_data_providers
   sensors

.. toctree::
   :hidden:

   lab_newton/isaaclab_newton.assets
   lab_newton/isaaclab_newton.cloner
   lab_newton/isaaclab_newton.physics
   lab_newton/isaaclab_newton.renderers
   lab_newton/isaaclab_newton.scene_data_providers
   lab_newton/isaaclab_newton.sensors

isaaclab_ov extension
---------------------

The following modules are available in the ``isaaclab_ov`` extension:

.. currentmodule:: isaaclab_ov

.. autosummary::
   :toctree: lab_ov

   renderers

.. toctree::
   :hidden:

   lab_ov/isaaclab_ov.renderers

isaaclab_assets extension
-------------------------

The following modules are available in the ``isaaclab_assets`` extension:

.. currentmodule:: isaaclab_assets

.. autosummary::
   :toctree: lab_assets

   robots
   sensors

.. toctree::
   :hidden:

   lab_assets/isaaclab_assets.robots
   lab_assets/isaaclab_assets.sensors

isaaclab_visualizers extension
------------------------------

The following modules are available in the ``isaaclab_visualizers`` extension:

.. currentmodule:: isaaclab_visualizers

.. autosummary::
   :toctree: lab_visualizers

   kit
   newton
   rerun
   viser

.. toctree::
   :hidden:

   lab_visualizers/isaaclab_visualizers.kit
   lab_visualizers/isaaclab_visualizers.newton
   lab_visualizers/isaaclab_visualizers.rerun
   lab_visualizers/isaaclab_visualizers.viser