Unverified Commit 9fafa32a authored by Kelly Guo's avatar Kelly Guo Committed by GitHub

Adds SB-3 instruction into hydra documentation (#897)

# Description

* Fix tested version in docs
* Add sb3 example for Hydra

## 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
parent df184e1c
...@@ -14,7 +14,7 @@ Similarly, the agent's parameters can be modified by using the ``agent`` prefix, ...@@ -14,7 +14,7 @@ Similarly, the agent's parameters can be modified by using the ``agent`` prefix,
The way these command line arguments are set follow the exact structure of the configuration files. Since the different The way these command line arguments are set follow the exact structure of the configuration files. Since the different
RL frameworks use different conventions, there might be differences in the way the parameters are set. For example, RL frameworks use different conventions, there might be differences in the way the parameters are set. For example,
with `rl_games` the seed will be set with ``agent.params.seed``, while with `rsl_rl` and `skrl` it will be set with with `rl_games` the seed will be set with ``agent.params.seed``, while with `rsl_rl`, `skrl` and `sb3` it will be set with
``agent.seed``. ``agent.seed``.
...@@ -44,6 +44,13 @@ As a result, training with hydra arguments can be run with the following syntax: ...@@ -44,6 +44,13 @@ As a result, training with hydra arguments can be run with the following syntax:
python source/standalone/workflows/skrl/train.py --task=Isaac-Cartpole-v0 --headless env.actions.joint_effort.scale=10.0 agent.seed=2024 python source/standalone/workflows/skrl/train.py --task=Isaac-Cartpole-v0 --headless env.actions.joint_effort.scale=10.0 agent.seed=2024
.. tab-item:: sb3
:sync: sb3
.. code-block:: shell
python source/standalone/workflows/sb3/train.py --task=Isaac-Cartpole-v0 --headless env.actions.joint_effort.scale=10.0 agent.seed=2024
The above command will run the training script with the task ``Isaac-Cartpole-v0`` in headless mode, and set the The above command will run the training script with the task ``Isaac-Cartpole-v0`` in headless mode, and set the
``env.actions.joint_effort.scale`` parameter to 10.0 and the ``agent.seed`` parameter to 2024. ``env.actions.joint_effort.scale`` parameter to 10.0 and the ``agent.seed`` parameter to 2024.
......
...@@ -19,7 +19,7 @@ To check the minimum system requirements,refer to the documentation ...@@ -19,7 +19,7 @@ To check the minimum system requirements,refer to the documentation
`here <https://docs.omniverse.nvidia.com/isaacsim/latest/installation/requirements.html>`__. `here <https://docs.omniverse.nvidia.com/isaacsim/latest/installation/requirements.html>`__.
.. note:: .. note::
We have tested Isaac Lab with Isaac Sim 4.0 release on Ubuntu We have tested Isaac Lab with Isaac Sim 4.1 release on Ubuntu
20.04LTS with NVIDIA driver 525.147. 20.04LTS with NVIDIA driver 525.147.
.. tab-set:: .. tab-set::
......
...@@ -62,8 +62,7 @@ Added ...@@ -62,8 +62,7 @@ Added
* ``cpu``: Use CPU. * ``cpu``: Use CPU.
* ``cuda``: Use GPU with device ID ``0``. * ``cuda``: Use GPU with device ID ``0``.
* ``cuda:N``: Use GPU, where N is the device ID. For example, ``cuda:0``. * ``cuda:N``: Use GPU, where N is the device ID. For example, ``cuda:0``. The default value is ``cuda:0``.
The default value is ``cuda:0``.
Changed Changed
^^^^^^^ ^^^^^^^
......
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