Skip to content

Commit d603b67

Browse files
Updates code for release 1.3.0 (#1444)
# Description Updates code for release 1.3.0 --------- Signed-off-by: Kelly Guo <[email protected]> Co-authored-by: David Hoeller <[email protected]>
1 parent b3ecfe3 commit d603b67

File tree

7 files changed

+93
-77
lines changed

7 files changed

+93
-77
lines changed

README.md

+21-6
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,28 @@
1313
[![License](https://img.shields.io/badge/license-BSD--3-yellow.svg)](https://opensource.org/licenses/BSD-3-Clause)
1414

1515

16-
**Isaac Lab** is a unified and modular framework for robot learning that aims to simplify common workflows
17-
in robotics research (such as RL, learning from demonstrations, and motion planning). It is built upon
18-
[NVIDIA Isaac Sim](https://docs.omniverse.nvidia.com/isaacsim/latest/overview.html) to leverage the latest
19-
simulation capabilities for photo-realistic scenes and fast and accurate simulation.
16+
**Isaac Lab** is a GPU-accelerated, open-source framework designed to unify and simplify robotics research workflows, such as reinforcement learning, imitation learning, and motion planning. Built on [NVIDIA Isaac Sim](https://docs.omniverse.nvidia.com/isaacsim/latest/overview.html), it combines fast and accurate physics and sensor simulation, making it an ideal choice for sim-to-real transfer in robotics.
17+
18+
Isaac Lab provides developers with a range of essential features for accurate sensor simulation, such as RTX-based cameras, LIDAR, or contact sensors. The framework's GPU acceleration enables users to run complex simulations and computations faster, which is key for iterative processes like reinforcement learning and data-intensive tasks. Moreover, Isaac Lab can run locally or be distributed across the cloud, offering flexibility for large-scale deployments.
19+
20+
## Key Features
21+
22+
Isaac Lab offers a comprehensive set of tools and environments designed to facilitate robot learning:
23+
- **Robots**: A diverse collection of robots, from manipulators, quadrupeds, to humanoids, with 16 commonly available models.
24+
- **Environments**: Ready-to-train implementations of more than 30 environments, which can be trained with popular reinforcement learning frameworks such as RSL RL, SKRL, RL Games, or Stable Baselines. We also support multi-agent reinforcement learning.
25+
- **Physics**: Rigid bodies, articulated systems, deformable objects
26+
- **Sensors**: RGB/depth/segmentation cameras, camera annotations, IMU, contact sensors, ray casters.
27+
28+
29+
## Getting Started
30+
31+
Our [documentation page](https://isaac-sim.github.io/IsaacLab) provides everything you need to get started, including detailed tutorials and step-by-step guides. Follow these links to learn more about:
32+
33+
- [Installation steps](https://isaac-sim.github.io/IsaacLab/main/source/setup/installation/index.html#local-installation)
34+
- [Reinforcement learning](https://isaac-sim.github.io/IsaacLab/main/source/overview/reinforcement-learning/rl_existing_scripts.html)
35+
- [Tutorials](https://isaac-sim.github.io/IsaacLab/main/source/tutorials/index.html)
36+
- [Available environments](https://isaac-sim.github.io/IsaacLab/main/source/overview/environments.html)
2037

21-
Please refer to our [documentation page](https://isaac-sim.github.io/IsaacLab) to learn more about the
22-
installation steps, features, tutorials, and how to set up your project with Isaac Lab.
2338

2439
## Contributing to Isaac Lab
2540

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.2.0
1+
1.3.0

docs/source/overview/reinforcement-learning/rl_existing_scripts.rst

+67-66
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Reinforcement Learning Wrappers
44
We provide wrappers to different reinforcement libraries. These wrappers convert the data
55
from the environments into the respective libraries function argument and return types.
66

7-
Stable-Baselines3
8-
-----------------
7+
8+
RL-Games
9+
--------
910

1011
- Training an agent with
11-
`Stable-Baselines3 <https://stable-baselines3.readthedocs.io/en/master/index.html>`__
12-
on ``Isaac-Cartpole-v0``:
12+
`RL-Games <https://github.com/Denys88/rl_games>`__ on ``Isaac-Ant-v0``:
1313

1414
.. tab-set::
1515
:sync-group: os
@@ -19,30 +19,65 @@ Stable-Baselines3
1919

2020
.. code:: bash
2121
22-
# install python module (for stable-baselines3)
23-
./isaaclab.sh -i sb3
22+
# install python module (for rl-games)
23+
./isaaclab.sh -i rl_games
2424
# run script for training
25-
# note: we set the device to cpu since SB3 doesn't optimize for GPU anyway
26-
./isaaclab.sh -p source/standalone/workflows/sb3/train.py --task Isaac-Cartpole-v0 --headless --device cpu
25+
./isaaclab.sh -p source/standalone/workflows/rl_games/train.py --task Isaac-Ant-v0 --headless
2726
# run script for playing with 32 environments
28-
./isaaclab.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32 --checkpoint /PATH/TO/model.zip
27+
./isaaclab.sh -p source/standalone/workflows/rl_games/play.py --task Isaac-Ant-v0 --num_envs 32 --checkpoint /PATH/TO/model.pth
2928
# run script for recording video of a trained agent (requires installing `ffmpeg`)
30-
./isaaclab.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --headless --video --video_length 200
29+
./isaaclab.sh -p source/standalone/workflows/rl_games/play.py --task Isaac-Ant-v0 --headless --video --video_length 200
3130
3231
.. tab-item:: :icon:`fa-brands fa-windows` Windows
3332
:sync: windows
3433

3534
.. code:: batch
3635
37-
:: install python module (for stable-baselines3)
38-
isaaclab.bat -i sb3
36+
:: install python module (for rl-games)
37+
isaaclab.bat -i rl_games
3938
:: run script for training
40-
:: note: we set the device to cpu since SB3 doesn't optimize for GPU anyway
41-
isaaclab.bat -p source\standalone\workflows\sb3\train.py --task Isaac-Cartpole-v0 --headless --device cpu
39+
isaaclab.bat -p source\standalone\workflows\rl_games\train.py --task Isaac-Ant-v0 --headless
4240
:: run script for playing with 32 environments
43-
isaaclab.bat -p source\standalone\workflows\sb3\play.py --task Isaac-Cartpole-v0 --num_envs 32 --checkpoint /PATH/TO/model.zip
41+
isaaclab.bat -p source\standalone\workflows\rl_games\play.py --task Isaac-Ant-v0 --num_envs 32 --checkpoint /PATH/TO/model.pth
4442
:: run script for recording video of a trained agent (requires installing `ffmpeg`)
45-
isaaclab.bat -p source\standalone\workflows\sb3\play.py --task Isaac-Cartpole-v0 --headless --video --video_length 200
43+
isaaclab.bat -p source\standalone\workflows\rl_games\play.py --task Isaac-Ant-v0 --headless --video --video_length 200
44+
45+
RSL-RL
46+
------
47+
48+
- Training an agent with
49+
`RSL-RL <https://github.com/leggedrobotics/rsl_rl>`__ on ``Isaac-Reach-Franka-v0``:
50+
51+
.. tab-set::
52+
:sync-group: os
53+
54+
.. tab-item:: :icon:`fa-brands fa-linux` Linux
55+
:sync: linux
56+
57+
.. code:: bash
58+
59+
# install python module (for rsl-rl)
60+
./isaaclab.sh -i rsl_rl
61+
# run script for training
62+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task Isaac-Reach-Franka-v0 --headless
63+
# run script for playing with 32 environments
64+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/play.py --task Isaac-Reach-Franka-v0 --num_envs 32 --load_run run_folder_name --checkpoint model.pt
65+
# run script for recording video of a trained agent (requires installing `ffmpeg`)
66+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/play.py --task Isaac-Reach-Franka-v0 --headless --video --video_length 200
67+
68+
.. tab-item:: :icon:`fa-brands fa-windows` Windows
69+
:sync: windows
70+
71+
.. code:: batch
72+
73+
:: install python module (for rsl-rl)
74+
isaaclab.bat -i rsl_rl
75+
:: run script for training
76+
isaaclab.bat -p source\standalone\workflows\rsl_rl\train.py --task Isaac-Reach-Franka-v0 --headless
77+
:: run script for playing with 32 environments
78+
isaaclab.bat -p source\standalone\workflows\rsl_rl\play.py --task Isaac-Reach-Franka-v0 --num_envs 32 --load_run run_folder_name --checkpoint model.pt
79+
:: run script for recording video of a trained agent (requires installing `ffmpeg`)
80+
isaaclab.bat -p source\standalone\workflows\rsl_rl\play.py --task Isaac-Reach-Franka-v0 --headless --video --video_length 200
4681
4782
SKRL
4883
----
@@ -129,48 +164,12 @@ SKRL
129164
:: run script for playing with 32 environments with the MAPPO algorithm (IPPO is also supported)
130165
isaaclab.bat -p source\standalone\workflows\skrl\play.py --task Isaac-Shadow-Hand-Over-Direct-v0 --num_envs 32 --algorithm MAPPO --checkpoint /PATH/TO/model.pt
131166
132-
RL-Games
133-
--------
134-
135-
- Training an agent with
136-
`RL-Games <https://github.com/Denys88/rl_games>`__ on ``Isaac-Ant-v0``:
137-
138-
.. tab-set::
139-
:sync-group: os
140-
141-
.. tab-item:: :icon:`fa-brands fa-linux` Linux
142-
:sync: linux
143-
144-
.. code:: bash
145-
146-
# install python module (for rl-games)
147-
./isaaclab.sh -i rl_games
148-
# run script for training
149-
./isaaclab.sh -p source/standalone/workflows/rl_games/train.py --task Isaac-Ant-v0 --headless
150-
# run script for playing with 32 environments
151-
./isaaclab.sh -p source/standalone/workflows/rl_games/play.py --task Isaac-Ant-v0 --num_envs 32 --checkpoint /PATH/TO/model.pth
152-
# run script for recording video of a trained agent (requires installing `ffmpeg`)
153-
./isaaclab.sh -p source/standalone/workflows/rl_games/play.py --task Isaac-Ant-v0 --headless --video --video_length 200
154-
155-
.. tab-item:: :icon:`fa-brands fa-windows` Windows
156-
:sync: windows
157-
158-
.. code:: batch
159-
160-
:: install python module (for rl-games)
161-
isaaclab.bat -i rl_games
162-
:: run script for training
163-
isaaclab.bat -p source\standalone\workflows\rl_games\train.py --task Isaac-Ant-v0 --headless
164-
:: run script for playing with 32 environments
165-
isaaclab.bat -p source\standalone\workflows\rl_games\play.py --task Isaac-Ant-v0 --num_envs 32 --checkpoint /PATH/TO/model.pth
166-
:: run script for recording video of a trained agent (requires installing `ffmpeg`)
167-
isaaclab.bat -p source\standalone\workflows\rl_games\play.py --task Isaac-Ant-v0 --headless --video --video_length 200
168-
169-
RSL-RL
170-
------
167+
Stable-Baselines3
168+
-----------------
171169

172170
- Training an agent with
173-
`RSL-RL <https://github.com/leggedrobotics/rsl_rl>`__ on ``Isaac-Reach-Franka-v0``:
171+
`Stable-Baselines3 <https://stable-baselines3.readthedocs.io/en/master/index.html>`__
172+
on ``Isaac-Cartpole-v0``:
174173

175174
.. tab-set::
176175
:sync-group: os
@@ -180,28 +179,30 @@ RSL-RL
180179

181180
.. code:: bash
182181
183-
# install python module (for rsl-rl)
184-
./isaaclab.sh -i rsl_rl
182+
# install python module (for stable-baselines3)
183+
./isaaclab.sh -i sb3
185184
# run script for training
186-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task Isaac-Reach-Franka-v0 --headless
185+
# note: we set the device to cpu since SB3 doesn't optimize for GPU anyway
186+
./isaaclab.sh -p source/standalone/workflows/sb3/train.py --task Isaac-Cartpole-v0 --headless --device cpu
187187
# run script for playing with 32 environments
188-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/play.py --task Isaac-Reach-Franka-v0 --num_envs 32 --load_run run_folder_name --checkpoint model.pt
188+
./isaaclab.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --num_envs 32 --checkpoint /PATH/TO/model.zip
189189
# run script for recording video of a trained agent (requires installing `ffmpeg`)
190-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/play.py --task Isaac-Reach-Franka-v0 --headless --video --video_length 200
190+
./isaaclab.sh -p source/standalone/workflows/sb3/play.py --task Isaac-Cartpole-v0 --headless --video --video_length 200
191191
192192
.. tab-item:: :icon:`fa-brands fa-windows` Windows
193193
:sync: windows
194194

195195
.. code:: batch
196196
197-
:: install python module (for rsl-rl)
198-
isaaclab.bat -i rsl_rl
197+
:: install python module (for stable-baselines3)
198+
isaaclab.bat -i sb3
199199
:: run script for training
200-
isaaclab.bat -p source\standalone\workflows\rsl_rl\train.py --task Isaac-Reach-Franka-v0 --headless
200+
:: note: we set the device to cpu since SB3 doesn't optimize for GPU anyway
201+
isaaclab.bat -p source\standalone\workflows\sb3\train.py --task Isaac-Cartpole-v0 --headless --device cpu
201202
:: run script for playing with 32 environments
202-
isaaclab.bat -p source\standalone\workflows\rsl_rl\play.py --task Isaac-Reach-Franka-v0 --num_envs 32 --load_run run_folder_name --checkpoint model.pt
203+
isaaclab.bat -p source\standalone\workflows\sb3\play.py --task Isaac-Cartpole-v0 --num_envs 32 --checkpoint /PATH/TO/model.zip
203204
:: run script for recording video of a trained agent (requires installing `ffmpeg`)
204-
isaaclab.bat -p source\standalone\workflows\rsl_rl\play.py --task Isaac-Reach-Franka-v0 --headless --video --video_length 200
205+
isaaclab.bat -p source\standalone\workflows\sb3\play.py --task Isaac-Cartpole-v0 --headless --video --video_length 200
205206
206207
All the scripts above log the training progress to `Tensorboard`_ in the ``logs`` directory in the root of
207208
the repository. The logs directory follows the pattern ``logs/<library>/<task>/<date-time>``, where ``<library>``

source/apps/isaaclab.python.headless.kit

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[package]
66
title = "Isaac Lab Python Headless"
77
description = "An app for running Isaac Lab headlessly"
8-
version = "1.2.0"
8+
version = "1.3.0"
99

1010
# That makes it browsable in UI with "experience" filter
1111
keywords = ["experience", "app", "isaaclab", "python", "headless"]

source/apps/isaaclab.python.headless.rendering.kit

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[package]
1010
title = "Isaac Lab Python Headless Camera"
1111
description = "An app for running Isaac Lab headlessly with rendering enabled"
12-
version = "1.2.0"
12+
version = "1.3.0"
1313

1414
# That makes it browsable in UI with "experience" filter
1515
keywords = ["experience", "app", "isaaclab", "python", "camera", "minimal"]

source/apps/isaaclab.python.kit

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[package]
66
title = "Isaac Lab Python"
77
description = "An app for running Isaac Lab"
8-
version = "1.2.0"
8+
version = "1.3.0"
99

1010
# That makes it browsable in UI with "experience" filter
1111
keywords = ["experience", "app", "usd"]

source/apps/isaaclab.python.rendering.kit

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[package]
1010
title = "Isaac Lab Python Camera"
1111
description = "An app for running Isaac Lab with rendering enabled"
12-
version = "1.2.0"
12+
version = "1.3.0"
1313

1414
# That makes it browsable in UI with "experience" filter
1515
keywords = ["experience", "app", "isaaclab", "python", "camera", "minimal"]

0 commit comments

Comments
 (0)