Skip to content

Commit

Permalink
Updates document around installation and Hub (#264)
Browse files Browse the repository at this point in the history
# Description

Documentation only change for installation and Hub pages.
  • Loading branch information
kellyguo11 committed Jan 30, 2025
1 parent 51731eb commit 2395376
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/source/deployment/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ To run the Isaac Lab container with an interactive bash session, run:

.. code:: bash
docker run --name isaac-lab --entrypoint bash -it --runtime=nvidia --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \
docker run --name isaac-lab --entrypoint bash -it --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \
-e "PRIVACY_CONSENT=Y" \
-v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \
-v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \
Expand Down
8 changes: 4 additions & 4 deletions docs/source/setup/installation/asset_caching.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ There may be a message indicating ``HUB NOT DETECTED`` or ``NEW VERSION DETECTED
:figwidth: 100%
:alt: Simulator with cache messaging.

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

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

Nucleus
-------
Expand Down
11 changes: 6 additions & 5 deletions docs/source/setup/installation/binaries_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,7 @@ Train a robot!
~~~~~~~~~~~~~~~

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!
We recommend adding ``--headless`` for faster training.

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

.. code:: bash
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code:: batch
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
... Or a robot dog!

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

.. code:: bash
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code:: batch
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
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.

.. figure:: ../../_static/setup/shadow_hands_example.jpg
.. figure:: ../../_static/setup/isaac_ants_example.jpg
:align: center
:figwidth: 100%
:alt: Idle hands...
11 changes: 6 additions & 5 deletions docs/source/setup/installation/pip_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,7 @@ Train a robot!
~~~~~~~~~~~~~~~

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!
We recommend adding ``--headless`` for faster training.

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

.. code:: bash
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code:: batch
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Ant-v0 --headless
... Or a robot dog!

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

.. code:: bash
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
./isaaclab.sh -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. code:: batch
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0
isaaclab.bat -p source/standalone/workflows/rsl_rl/train.py --task=Isaac-Velocity-Rough-Anymal-C-v0 --headless
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.

.. figure:: ../../_static/setup/shadow_hands_example.jpg
.. figure:: ../../_static/setup/isaac_ants_example.jpg
:align: center
:figwidth: 100%
:alt: Idle hands...
2 changes: 1 addition & 1 deletion source/isaaclab/docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Changelog


0.33.12 (2025-01-28)
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~

Fixed
^^^^^
Expand Down

0 comments on commit 2395376

Please sign in to comment.