Commit e92c001b authored by David Hoeller's avatar David Hoeller

Updates documentation (#125)

# Description

- Adds description on running multi-agents environments in docs
- Add driver requirement for Windows

## Type of change

- New feature (non-breaking change which adds functionality)

## 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
- [ ] 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
- [x] I have added my name to the `CONTRIBUTORS.md` or my name already
exists there
parent 84543312
...@@ -245,6 +245,13 @@ Others ...@@ -245,6 +245,13 @@ Others
Multi-agent Multi-agent
------------ ------------
.. note::
True mutli-agent training is only available with the `skrl` library, see the `Multi-Agents Documentation <https://skrl.readthedocs.io/en/latest/api/multi_agents.html>`_ for more information.
It supports the `IPPO` and `MAPPO` algorithms, which can be activated by adding the command line input ``--algorithm IPPO`` or ``--algorithm MAPPO`` to the train/play script.
If these environments are run with other libraries or without the `IPPO` or `MAPPO` flags, they will be converted to single-agent environments under the hood.
Classic Classic
~~~~~~~ ~~~~~~~
......
...@@ -59,6 +59,18 @@ SKRL ...@@ -59,6 +59,18 @@ SKRL
# run script for recording video of a trained agent (requires installing `ffmpeg`) # run script for recording video of a trained agent (requires installing `ffmpeg`)
./isaaclab.sh -p source/standalone/workflows/skrl/play.py --task Isaac-Reach-Franka-v0 --headless --ml_framework jax --video --video_length 200 ./isaaclab.sh -p source/standalone/workflows/skrl/play.py --task Isaac-Reach-Franka-v0 --headless --ml_framework jax --video --video_length 200
- Training the multi-agent environment ``Isaac-Shadow-Hand-Over-Direct-v0`` with skrl:
.. code:: bash
# install python module (for skrl)
./isaaclab.sh -i skrl
# run script for training with the MAPPO algorithm (IPPO is also supported)
./isaaclab.sh -p source/standalone/workflows/skrl/train.py --task Isaac-Shadow-Hand-Over-Direct-v0 --headless --algorithm MAPPO
# run script for playing with 32 environments with the MAPPO algorithm (IPPO is also supported)
./isaaclab.sh -p source/standalone/workflows/skrl/play.py --task Isaac-Shadow-Hand-Over-Direct-v0 --num_envs 32 --algorithm MAPPO --checkpoint /PATH/TO/model.pt
RL-Games RL-Games
-------- --------
......
...@@ -20,6 +20,10 @@ compatibility issues with some Linux distributions. If you encounter any issues, ...@@ -20,6 +20,10 @@ compatibility issues with some Linux distributions. If you encounter any issues,
by default. If you encounter compatibility issues, we recommend following the by default. If you encounter compatibility issues, we recommend following the
:ref:`Isaac Sim Binaries Installation <isaacsim-binaries-installation>` approach. :ref:`Isaac Sim Binaries Installation <isaacsim-binaries-installation>` approach.
.. attention::
On Windows with CUDA 12, the GPU driver version 552.86 is required.
- To use the pip installation approach for Isaac Sim, we recommend first creating a virtual environment. - To use the pip installation approach for Isaac Sim, we recommend first creating a virtual environment.
Ensure that the python version of the virtual environment is **Python 3.10**. Ensure that the python version of the virtual environment is **Python 3.10**.
......
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