Skip to content

Commit dd044a4

Browse files
authored
Updates installation instruction for SKRL JAX (#1570)
# Description SKRL provides examples using JAX, which by default only installs the CPU version. To be compatible with CUDA, it is required to install JAX prior to installing SKRL. This PR updates the installation instructions for SKRL to note this requirement. ## Type of change - This change requires a documentation update ## Checklist - [x] I have run the [`pre-commit` checks](https://pre-commit.com/) with `./isaaclab.sh --format` - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have updated the changelog and the corresponding version in the extension's `config/extension.toml` file - [ ] I have added my name to the `CONTRIBUTORS.md` or my name already exists there <!-- As you go through the checklist above, you can mark something as done by putting an x character in it For example, - [x] I have done this task - [ ] I have not done this task -->
1 parent 052975a commit dd044a4

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -122,11 +122,16 @@ SKRL
122122
123123
.. tab-item:: JAX
124124

125+
.. warning::
126+
127+
It is recommended to `install JAX <https://jax.readthedocs.io/en/latest/installation.html>`_ manually before proceeding to install skrl and its dependencies, as JAX installs its CPU version by default. For example, ``pip install -U "jax[cuda12]"`` can be used to install JAX for CUDA 12.
128+
Visit the **skrl** `installation <https://skrl.readthedocs.io/en/latest/intro/installation.html>`_ page for more details.
129+
125130
.. code:: bash
126131
127132
# install python module (for skrl)
128133
./isaaclab.sh -i skrl
129-
# install skrl dependencies for JAX. Visit https://skrl.readthedocs.io/en/latest/intro/installation.html for more details
134+
# install skrl dependencies for JAX
130135
./isaaclab.sh -p -m pip install skrl["jax"]
131136
# run script for training
132137
./isaaclab.sh -p source/standalone/workflows/skrl/train.py --task Isaac-Reach-Franka-v0 --headless --ml_framework jax

0 commit comments

Comments
 (0)