Skip to content

Commit 2395376

Browse files
kellyguo11kellyguo11
committed
Updates document around installation and Hub (#264)
# Description Documentation only change for installation and Hub pages.
1 parent 51731eb commit 2395376

File tree

5 files changed

+18
-16
lines changed

5 files changed

+18
-16
lines changed

‎docs/source/deployment/docker.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ To run the Isaac Lab container with an interactive bash session, run:
272272

273273
.. code:: bash
274274
275-
docker run --name isaac-lab --entrypoint bash -it --runtime=nvidia --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \
275+
docker run --name isaac-lab --entrypoint bash -it --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \
276276
-e "PRIVACY_CONSENT=Y" \
277277
-v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \
278278
-v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \

‎docs/source/setup/installation/asset_caching.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ There may be a message indicating ``HUB NOT DETECTED`` or ``NEW VERSION DETECTED
3535
:figwidth: 100%
3636
:alt: Simulator with cache messaging.
3737

38-
Click on the message, which will download HUB for asset caching.
39-
Once installed, HUB will run automatically each time an Isaac Lab or Isaac Sim instance is run.
38+
Click on the message, which will enable `Hub <https://docs.omniverse.nvidia.com/utilities/latest/cache/hub-workstation.html>`_
39+
for asset caching. Once enabled, Hub will run automatically each time an Isaac Lab or Isaac Sim instance is run.
4040

4141
Note that for the first run, assets will still need to be pulled from the cloud, which could lead to longer loading times.
42-
However, subsequent runs that use the same assets will be able to use the cached files from HUB.
43-
HUB will provide better control for caching of assets used in Isaac Lab.
42+
However, subsequent runs that use the same assets will be able to use the cached files from Hub.
43+
Hub will provide better control for caching of assets used in Isaac Lab.
4444

4545
Nucleus
4646
-------

‎docs/source/setup/installation/binaries_installation.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,7 @@ Train a robot!
434434
~~~~~~~~~~~~~~~
435435

436436
You can now use Isaac Lab to train a robot through Reinforcement Learning! The quickest way to use Isaac Lab is through the predefined workflows using one of our **Batteries-included** robot tasks. Execute the following command to quickly train an ant to walk!
437+
We recommend adding ``--headless`` for faster training.
437438

438439
.. tab-set::
439440
:sync-group: os
@@ -443,14 +444,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
443444

444445
.. code:: bash
445446
446-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
447+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
447448
448449
.. tab-item:: :icon:`fa-brands fa-windows` Windows
449450
:sync: windows
450451

451452
.. code:: batch
452453
453-
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
454+
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
454455
455456
... Or a robot dog!
456457

@@ -462,18 +463,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
462463

463464
.. code:: bash
464465
465-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
466+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
466467
467468
.. tab-item:: :icon:`fa-brands fa-windows` Windows
468469
:sync: windows
469470

470471
.. code:: batch
471472
472-
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
473+
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
473474
474475
Isaac Lab provides the tools you'll need to create your own **Tasks** and **Workflows** for whatever your project needs may be. Take a look at our :ref:`how-to` guides like `Adding your own learning Library <source/how-to/add_own_library>`_ or `Wrapping Environments <source/how-to/wrap_rl_env>`_ for details.
475476

476-
.. figure:: ../../_static/setup/shadow_hands_example.jpg
477+
.. figure:: ../../_static/setup/isaac_ants_example.jpg
477478
:align: center
478479
:figwidth: 100%
479480
:alt: Idle hands...

‎docs/source/setup/installation/pip_installation.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,7 @@ Train a robot!
345345
~~~~~~~~~~~~~~~
346346

347347
You can now use Isaac Lab to train a robot through Reinforcement Learning! The quickest way to use Isaac Lab is through the predefined workflows using one of our **Batteries-included** robot tasks. Execute the following command to quickly train an ant to walk!
348+
We recommend adding ``--headless`` for faster training.
348349

349350
.. tab-set::
350351
:sync-group: os
@@ -354,14 +355,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
354355

355356
.. code:: bash
356357
357-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
358+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
358359
359360
.. tab-item:: :icon:`fa-brands fa-windows` Windows
360361
:sync: windows
361362

362363
.. code:: batch
363364
364-
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
365+
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
365366
366367
... Or a robot dog!
367368

@@ -373,18 +374,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
373374

374375
.. code:: bash
375376
376-
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
377+
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
377378
378379
.. tab-item:: :icon:`fa-brands fa-windows` Windows
379380
:sync: windows
380381

381382
.. code:: batch
382383
383-
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
384+
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
384385
385386
Isaac Lab provides the tools you'll need to create your own **Tasks** and **Workflows** for whatever your project needs may be. Take a look at our :ref:`how-to` guides like `Adding your own learning Library <source/how-to/add_own_library>`_ or `Wrapping Environments <source/how-to/wrap_rl_env>`_ for details.
386387

387-
.. figure:: ../../_static/setup/shadow_hands_example.jpg
388+
.. figure:: ../../_static/setup/isaac_ants_example.jpg
388389
:align: center
389390
:figwidth: 100%
390391
:alt: Idle hands...

‎source/isaaclab/docs/CHANGELOG.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Changelog
1010

1111

1212
0.33.12 (2025-01-28)
13-
~~~~~~~~~~~~~~~~~~~
13+
~~~~~~~~~~~~~~~~~~~~
1414

1515
Fixed
1616
^^^^^

0 commit comments

Comments
 (0)