Skip to content

K
KincoActuatorIsaacLab
Commit 23953760 authored by Kelly Guo's avatar Kelly Guo Committed by Kelly Guo
Browse files
Options

Updates document around installation and Hub (#264) 

# Description

Documentation only change for installation and Hub pages.
parent 51731eb1
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 16 deletions
docs/source/deployment/docker.rst
View file @ 23953760
...@@ -272,7 +272,7 @@ To run the Isaac Lab container with an interactive bash session, run: ...@@ -272,7 +272,7 @@ To run the Isaac Lab container with an interactive bash session, run:
.. code:: bash .. 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" \ -e "PRIVACY_CONSENT=Y" \
-v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \ -v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \
-v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \ -v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \
......
docs/source/setup/installation/asset_caching.rst
View file @ 23953760
...@@ -35,12 +35,12 @@ There may be a message indicating ``HUB NOT DETECTED`` or ``NEW VERSION DETECTED ...@@ -35,12 +35,12 @@ There may be a message indicating ``HUB NOT DETECTED`` or ``NEW VERSION DETECTED
:figwidth: 100% :figwidth: 100%
:alt: Simulator with cache messaging. :alt: Simulator with cache messaging.
Click on the message, which will download HUB for asset caching. Click on the message, which will enable `Hub <https://docs.omniverse.nvidia.com/utilities/latest/cache/hub-workstation.html>`_
Once installed, HUB will run automatically each time an Isaac Lab or Isaac Sim instance is run. 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. 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. 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. Hub will provide better control for caching of assets used in Isaac Lab.
Nucleus Nucleus
------- -------
......
docs/source/setup/installation/binaries_installation.rst
View file @ 23953760
...@@ -434,6 +434,7 @@ Train a robot! ...@@ -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! 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:: .. tab-set::
:sync-group: os :sync-group: os
...@@ -443,14 +444,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q ...@@ -443,14 +444,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
.. code:: bash .. 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 .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
.. code:: batch .. 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! ... Or a robot dog!
...@@ -462,18 +463,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q ...@@ -462,18 +463,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
.. code:: bash .. 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 .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
.. code:: batch .. 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. 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 :align: center
:figwidth: 100% :figwidth: 100%
:alt: Idle hands... :alt: Idle hands...
docs/source/setup/installation/pip_installation.rst
View file @ 23953760
...@@ -345,6 +345,7 @@ Train a robot! ...@@ -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! 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:: .. tab-set::
:sync-group: os :sync-group: os
...@@ -354,14 +355,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q ...@@ -354,14 +355,14 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
.. code:: bash .. 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 .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
.. code:: batch .. 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! ... Or a robot dog!
...@@ -373,18 +374,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q ...@@ -373,18 +374,18 @@ You can now use Isaac Lab to train a robot through Reinforcement Learning! The q
.. code:: bash .. 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 .. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows :sync: windows
.. code:: batch .. 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. 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 :align: center
:figwidth: 100% :figwidth: 100%
:alt: Idle hands... :alt: Idle hands...
source/isaaclab/docs/CHANGELOG.rst
View file @ 23953760
...@@ -10,7 +10,7 @@ Changelog ...@@ -10,7 +10,7 @@ Changelog
0.33.12 (2025-01-28) 0.33.12 (2025-01-28)
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
Fixed Fixed
^^^^^ ^^^^^
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment