19 |
20 |
21 | **skrl** is an open-source modular library for Reinforcement Learning written in Python (on top of [PyTorch](https://pytorch.org/) and [JAX](https://jax.readthedocs.io)) and designed with a focus on modularity, readability, simplicity, and transparency of algorithm implementation. In addition to supporting the OpenAI [Gym](https://www.gymlibrary.dev), Farama [Gymnasium](https://gymnasium.farama.org) and [PettingZoo](https://pettingzoo.farama.org), Google [DeepMind](https://github.com/deepmind/dm_env) and [Brax](https://github.com/google/brax), among other environment interfaces, it allows loading and configuring NVIDIA [Isaac Lab](https://isaac-sim.github.io/IsaacLab/index.html) (as well as [Isaac Gym](https://developer.nvidia.com/isaac-gym/) and [Omniverse Isaac Gym](https://github.com/isaac-sim/OmniIsaacGymEnvs)) environments, enabling agents' simultaneous training by scopes (subsets of environments among all available environments), which may or may not share resources, in the same run.
22 |
23 |
24 |
25 | ### Please, visit the documentation for usage details and examples
26 |
27 | https://skrl.readthedocs.io
28 |
29 |
30 |
31 | > **Note:** This project is under **active continuous development**. Please make sure you always have the latest version. Visit the [develop](https://github.com/Toni-SM/skrl/tree/develop) branch or its [documentation](https://skrl.readthedocs.io/en/develop) to access the latest updates to be released.
32 |
33 |
34 |
35 | ### Citing this library
36 |
37 | To cite this library in publications, please use the following reference:
38 |
39 | ```bibtex
40 | @article{serrano2023skrl,
41 | author = {Antonio Serrano-Muñoz and Dimitrios Chrysostomou and Simon Bøgh and Nestor Arana-Arexolaleiba},
42 | title = {skrl: Modular and Flexible Library for Reinforcement Learning},
43 | journal = {Journal of Machine Learning Research},
44 | year = {2023},
45 | volume = {24},
46 | number = {254},
47 | pages = {1--9},
48 | url = {http://jmlr.org/papers/v24/23-0112.html}
49 | }
50 | ```
51 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Minimal makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line, and also
5 | # from the environment for the first two.
6 | SPHINXOPTS ?=
7 | SPHINXBUILD ?= sphinx-build
8 | SOURCEDIR = source
9 | BUILDDIR = build
10 |
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 |
15 | .PHONY: help Makefile
16 |
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21 |
--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
1 | # Documentation
2 |
3 | ## Install Sphinx and Read the Docs Sphinx Theme
4 |
5 | ```bash
6 | cd docs
7 | pip install -r requirements.txt
8 | ```
9 |
10 | ## Building the documentation
11 |
12 | ```bash
13 | cd docs
14 | make html
15 | ```
16 |
17 | Building each time a file is changed:
18 |
19 | ```bash
20 | cd docs
21 | sphinx-autobuild ./source/ _build/html
22 | ```
23 |
24 | ## Useful links
25 |
26 | - [Sphinx directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html)
27 | - [Math support in Sphinx](https://www.sphinx-doc.org/en/1.0/ext/math.html)
28 |
--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
1 | @ECHO OFF
2 |
3 | pushd %~dp0
4 |
5 | REM Command file for Sphinx documentation
6 |
7 | if "%SPHINXBUILD%" == "" (
8 | set SPHINXBUILD=sphinx-build
9 | )
10 | set SOURCEDIR=source
11 | set BUILDDIR=build
12 |
13 | if "%1" == "" goto help
14 |
15 | %SPHINXBUILD% >NUL 2>NUL
16 | if errorlevel 9009 (
17 | echo.
18 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19 | echo.installed, then set the SPHINXBUILD environment variable to point
20 | echo.to the full path of the 'sphinx-build' executable. Alternatively you
21 | echo.may add the Sphinx directory to PATH.
22 | echo.
23 | echo.If you don't have Sphinx installed, grab it from
24 | echo.http://sphinx-doc.org/
25 | exit /b 1
26 | )
27 |
28 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29 | goto end
30 |
31 | :help
32 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33 |
34 | :end
35 | popd
36 |
--------------------------------------------------------------------------------
/docs/requirements.txt:
--------------------------------------------------------------------------------
1 | furo==2024.8.6
2 | sphinx
3 | sphinx-tabs
4 | sphinx-autobuild
5 | sphinx-copybutton
6 | sphinx-notfound-page
7 | decorator
8 | numpy
9 |
--------------------------------------------------------------------------------
/docs/source/404.rst:
--------------------------------------------------------------------------------
1 | :orphan:
2 |
3 | Page not found
4 | ==============
5 |
6 | .. image:: _static/data/404-light.svg
7 | :width: 50%
8 | :align: center
9 | :class: only-light
10 | :alt: 404
11 |
12 | .. image:: _static/data/404-dark.svg
13 | :width: 50%
14 | :align: center
15 | :class: only-dark
16 | :alt: 404
17 |
18 | .. raw:: html
19 |
20 |
21 |
16 |
17 | 
](https://huggingface.co/skrl)
3 | 
4 |