File size: 7,001 Bytes
406662d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | .. _template-generator:
Create new project or task
==========================
Traditionally, building new projects that utilize Isaac Lab's features required creating your own
extensions within the Isaac Lab repository. However, this approach can obscure project visibility and
complicate updates from one version of Isaac Lab to another. To circumvent these challenges,
we now provide a command-line tool (**template generator**) for creating Isaac Lab-based projects and tasks.
The template generator enables you to create an:
* **External project** (recommended): An isolated project that is not part of the Isaac Lab repository. This approach
works outside of the core Isaac Lab repository, ensuring that your development efforts remain self-contained. Also,
it allows your code to be run as an extension in Omniverse.
.. hint::
For the external project, the template generator will initialize a new Git repository in the specified directory.
You can push the generated content to your own remote repository (e.g. GitHub) and share it with others.
* **Internal task**: A task that is part of the Isaac Lab repository. This approach should only be used to create
new tasks within the Isaac Lab repository in order to contribute to it.
.. warning::
Pip installations of Isaac Lab do not support *Internal* templates.
If ``isaaclab`` is loaded from ``site-packages`` or ``dist-packages``, the *Internal* option is disabled
and the *External* template will be used instead.
Running the template generator
------------------------------
Install Isaac Lab by following the `installation guide <../../setup/installation/index.html>`_.
We recommend using conda or uv installation as it simplifies calling Python scripts from the terminal.
Then, run the following command to generate a new external project or internal task:
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
./isaaclab.sh --new # or "./isaaclab.sh -n"
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
isaaclab.bat --new :: or "isaaclab.bat -n"
The generator will guide you in setting up the project/task for your needs by asking you the following questions:
* Type of project/task (external or internal), and project/task path or names according to the selected type.
* Isaac Lab workflows (see :ref:`feature-workflows`).
* Reinforcement learning libraries (see :ref:`rl-frameworks`), and algorithms (if the selected libraries support multiple algorithms).
External project usage (once generated)
---------------------------------------
Once the external project is generated, a ``README.md`` file will be created in the specified directory.
This file will contain instructions on how to install the project and run the tasks.
Here are some general commands to get started with it:
.. note::
If Isaac Lab is not installed in a conda environment or in a (virtual) Python environment, use ``FULL_PATH_TO_ISAACLAB/isaaclab.sh -p``
(or ``FULL_PATH_TO_ISAACLAB\isaaclab.bat -p`` on Windows) instead of ``python`` to run the commands below.
* Install the project (in editable mode).
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python -m pip install -e source/<given-project-name>
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python -m pip install -e source\<given-project-name>
* List the tasks available in the project.
.. warning::
If the task names change, it may be necessary to update the search pattern ``"Template-"``
(in the ``scripts/list_envs.py`` file) so that they can be listed.
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/list_envs.py
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\list_envs.py
* Run a task.
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/<specific-rl-library>/train.py --task=<Task-Name>
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\<specific-rl-library>\train.py --task=<Task-Name>
For more details, please follow the instructions in the generated project's ``README.md`` file.
Internal task usage (once generated)
---------------------------------------
Once the internal task is generated, it will be available along with the rest of the Isaac Lab tasks.
Here are some general commands to get started with it:
.. note::
If Isaac Lab is not installed in a conda environment or in a (virtual) Python environment, use ``./isaaclab.sh -p``
(or ``isaaclab.bat -p`` on Windows) instead of ``python`` to run the commands below.
* List the tasks available in Isaac Lab.
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/environments/list_envs.py
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\environments\list_envs.py
* Run a task.
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/reinforcement_learning/<specific-rl-library>/train.py --task=<Task-Name>
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\reinforcement_learning\<specific-rl-library>\train.py --task=<Task-Name>
* Run a task with dummy agents.
These include dummy agents that output zero or random agents. They are useful to ensure that the environments are configured correctly.
* Zero-action agent
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/zero_agent.py --task=<Task-Name>
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\zero_agent.py --task=<Task-Name>
* Random-action agent
.. tab-set::
:sync-group: os
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux
.. code-block:: bash
python scripts/random_agent.py --task=<Task-Name>
.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows
.. code-block:: batch
python scripts\random_agent.py --task=<Task-Name>
|