Skip to content

Commit 1c2548b

Browse files
Mayankm96Copilotooctipus
authored
Adapts FAQ section in docs with Isaac Sim open-sourcing (isaac-sim#3105)
# Description Some of the information in FAQ is now outdated since Isaac Sim is open-sourced. This MR removes that part but also adds more explaination on the goals of Isaac Lab. ## Type of change - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [x] I have added my name to the `CONTRIBUTORS.md` or my name already exists there --------- Signed-off-by: Mayank Mittal <12863862+Mayankm96@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: ooctipus <zhengyuz@nvidia.com>
1 parent 90b20d7 commit 1c2548b

File tree

2 files changed

+51
-10
lines changed

2 files changed

+51
-10
lines changed

docs/index.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Isaac lab is developed with specific robot assets that are now **Batteries-inclu
3333
- **Humanoids**: Unitree H1, Unitree G1
3434
- **Quadcopter**: Crazyflie
3535

36-
The platform is also designed so that you can add your own robots! please refer to the
36+
The platform is also designed so that you can add your own robots! Please refer to the
3737
:ref:`how-to` section for details.
3838

3939
For more information about the framework, please refer to the `paper <https://arxiv.org/abs/2301.04195>`_
@@ -48,12 +48,13 @@ For more information about the framework, please refer to the `paper <https://ar
4848
License
4949
=======
5050

51-
The Isaac Lab framework is open-sourced under the BSD-3-Clause license.
52-
Please refer to :ref:`license` for more details.
51+
The Isaac Lab framework is open-sourced under the BSD-3-Clause license,
52+
with certain parts under Apache-2.0 license. Please refer to :ref:`license` for more details.
5353

5454
Acknowledgement
5555
===============
56-
Isaac Lab development initiated from the `Orbit <https://isaac-orbit.github.io/>`_ framework. We would appreciate if you would cite it in academic publications as well:
56+
Isaac Lab development initiated from the `Orbit <https://isaac-orbit.github.io/>`_ framework.
57+
We would appreciate if you would cite it in academic publications as well:
5758

5859
.. code:: bibtex
5960

docs/source/setup/ecosystem.rst

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,46 @@ be the single robot learning framework for Isaac Sim. Previously released framew
8383
and we encourage users to follow our migration guides to transition over to Isaac Lab.
8484

8585

86+
Is Isaac Lab a simulator?
87+
-------------------------
88+
89+
Often, when people think of simulators, they think of various commonly available engines, such as
90+
`MuJoCo`_, `Bullet`_, and `Flex`_. These engines are powerful and have been used in a number of
91+
research projects. However, they are not designed to be a general purpose simulator for robotics.
92+
Rather they are primarily physics engines that are used to simulate the dynamics of rigid and
93+
deformable bodies. They are shipped with some basic rendering capabilities to visualize the
94+
simulation and provide parsing capabilities of different scene description formats.
95+
96+
Various recent works combine these physics engines with different rendering engines to provide
97+
a more complete simulation environment. They include APIs that allow reading and writing to the
98+
physics and rendering engines. In some cases, they support ROS and hardware-in-the-loop simulation
99+
for more robotic-specific applications. An example of these include `AirSim`_, `DoorGym`_, `ManiSkill`_,
100+
`ThreeDWorld`_ and lastly, `Isaac Sim`_.
101+
102+
At its core, Isaac Lab is **not** a robotics simulator, but a framework for building robot learning
103+
applications on top of Isaac Sim. An equivalent example of such a framework is `RoboSuite`_, which
104+
is built on top of `MuJoCo`_ and is specific to fixed-base robots. Other examples include
105+
`MuJoCo Playground`_ and `Isaac Gym`_ which use `MJX`_ and `PhysX`_ respectively. They
106+
include a number of pre-built tasks with separated out stand-alone implementations for individual
107+
tasks. While this is a good starting point (and often convenient), a lot of code
108+
repetition occurs across different task implementations, which can reduce code-reuse for larger
109+
projects and teams.
110+
111+
The main goal of Isaac Lab is to provide a unified framework for robot learning that includes
112+
a variety of tooling and features that are required for robot learning, while being easy to
113+
use and extend. It includes design patterns that simplify many of the common requirements for
114+
robotics research. These include simulating sensors at different frequencies, connecting to different
115+
teleoperation interfaces for data collection, switching action spaces for policy learning,
116+
using Hydra for configuration management, supporting different learning libraries and more.
117+
Isaac Lab supports designing tasks using *manager-based (modularized)* and *direct (single-script
118+
similar to Isaac Gym)* patterns, leaving it up to the user to choose the best approach for their
119+
use-case. For each of these patterns, Isaac Lab includes a number of pre-built tasks that can be
120+
used for benchmarking and research.
121+
122+
86123
Why should I use Isaac Lab?
87124
---------------------------
88125

89-
Since Isaac Sim remains closed-sourced, it is difficult for users to contribute to the simulator and build a
90-
common framework for research. On its current path, we see the community using the simulator will simply
91-
develop their own frameworks that will result in scattered efforts with a lot of duplication of work.
92-
This has happened in the past with other simulators, and we believe that it is not the best way to move
93-
forward as a community.
94-
95126
Isaac Lab provides an open-sourced platform for the community to drive progress with consolidated efforts
96127
toward designing benchmarks and robot learning systems as a joint initiative. This allows us to reuse
97128
existing components and algorithms, and to build on top of each other's work. Doing so not only saves
@@ -113,3 +144,12 @@ to Isaac Lab, please reach out to us.
113144
.. _OmniIsaacGymEnvs: https://github.com/isaac-sim/OmniIsaacGymEnvs
114145
.. _Orbit: https://isaac-orbit.github.io/
115146
.. _Isaac Automator: https://github.com/isaac-sim/IsaacAutomator
147+
.. _AirSim: https://microsoft.github.io/AirSim/
148+
.. _DoorGym: https://github.com/PSVL/DoorGym/
149+
.. _ManiSkill: https://github.com/haosulab/ManiSkill
150+
.. _ThreeDWorld: https://www.threedworld.org/
151+
.. _RoboSuite: https://robosuite.ai/
152+
.. _MuJoCo Playground: https://playground.mujoco.org/
153+
.. _MJX: https://mujoco.readthedocs.io/en/stable/mjx.html
154+
.. _Bullet: https://github.com/bulletphysics/bullet3
155+
.. _Flex: https://developer.nvidia.com/flex

0 commit comments

Comments
 (0)