From 57c3d36490bd36a83ec66b165afe0eada5f0f7b7 Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Tue, 5 Dec 2023 18:16:47 +0100 Subject: [PATCH] New index.rst, added assests --- docs/source/_static/imgs/alr.svg | 281 ++++++++++ docs/source/_static/imgs/icon.svg | 101 ++++ docs/source/_static/imgs/kit.svg | 23 + docs/source/_static/imgs/uni_tuebingen.svg | 568 +++++++++++++++++++++ docs/source/_static/style.css | 38 ++ docs/source/index.rst | 110 +++- 6 files changed, 1107 insertions(+), 14 deletions(-) create mode 100644 docs/source/_static/imgs/alr.svg create mode 100644 docs/source/_static/imgs/icon.svg create mode 100644 docs/source/_static/imgs/kit.svg create mode 100644 docs/source/_static/imgs/uni_tuebingen.svg create mode 100644 docs/source/_static/style.css diff --git a/docs/source/_static/imgs/alr.svg b/docs/source/_static/imgs/alr.svg new file mode 100644 index 0000000..58afbdd --- /dev/null +++ b/docs/source/_static/imgs/alr.svg @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/imgs/icon.svg b/docs/source/_static/imgs/icon.svg new file mode 100644 index 0000000..64ec435 --- /dev/null +++ b/docs/source/_static/imgs/icon.svg @@ -0,0 +1,101 @@ + + + + diff --git a/docs/source/_static/imgs/kit.svg b/docs/source/_static/imgs/kit.svg new file mode 100644 index 0000000..33b825e --- /dev/null +++ b/docs/source/_static/imgs/kit.svg @@ -0,0 +1,23 @@ + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + diff --git a/docs/source/_static/imgs/uni_tuebingen.svg b/docs/source/_static/imgs/uni_tuebingen.svg new file mode 100644 index 0000000..758f021 --- /dev/null +++ b/docs/source/_static/imgs/uni_tuebingen.svg @@ -0,0 +1,568 @@ + + + + + + + diff --git a/docs/source/_static/style.css b/docs/source/_static/style.css new file mode 100644 index 0000000..dbacd55 --- /dev/null +++ b/docs/source/_static/style.css @@ -0,0 +1,38 @@ +/* Main colors adapted from pytorch doc */ +:root{ + --main-bg-color: #343A40; +} + +/* Header fonts y */ +h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend, p.caption { + font-family: "Lato","proxima-nova","Helvetica Neue",Arial,sans-serif; +} + + +/* Docs background */ +.wy-side-nav-search{ + background-color: var(--main-bg-color); +} + +/* Mobile version */ +.wy-nav-top{ + background-color: var(--main-bg-color); +} + +a.icon.icon-home { + color: #b3b3b3; +} + +/* Make code blocks have a background */ +.codeblock,pre.literal-block,.rst-content .literal-block,.rst-content pre.literal-block,div[class^='highlight'] { + background: #f8f8f8;; +} + +/* Change style of types in the docstrings .rst-content .field-list */ +.field-list .xref.py.docutils, .field-list code.docutils, .field-list .docutils.literal.notranslate +{ + border: None; + padding-left: 0; + padding-right: 0; + color: #404040; +} \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 0e4c043..88c8751 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,21 +1,103 @@ -.. fancy_gym documentation master file, created by - sphinx-quickstart on Sat Sep 30 17:30:55 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +Fancy Gym +========= -Welcome to Fancy Gym's documentation! -===================================== +Built upon the foundation of +`Gymnasium `__ (a maintained fork of +OpenAI’s renowned Gym library) ``fancy_gym`` offers a comprehensive +collection of reinforcement learning environments. + +Key Features +------------ + + - **New Challenging Environments**: ``fancy_gym`` includes several new + environments (Panda Box Pushing, Table Tennis, etc.) that present a + higher degree of difficulty, pushing the boundaries of reinforcement + learning research. + - **Support for Movement Primitives**: ``fancy_gym`` supports a range + of movement primitives (MPs), including Dynamic Movement Primitives + (DMPs), Probabilistic Movement Primitives (ProMP), and Probabilistic + Dynamic Movement Primitives (ProDMP). + - **Upgrade to Movement Primitives**: With our framework, it’s + straightforward to transform standard Gymnasium environments into + environments that support movement primitives. + - **Benchmark Suite Compatibility**: ``fancy_gym`` makes it easy to + access renowned benchmark suites such as `DeepMind + Control `__ + and `Metaworld `__, whether you want + to use them in the regular step-based setting or using MPs. + - **Contribute Your Own Environments**: If you’re inspired to create + custom gym environments, both step-based and with movement + primitives, this + `guide `__ + will assist you. We encourage and highly appreciate submissions via + PRs to integrate these environments into ``fancy_gym``. .. toctree:: - :maxdepth: 5 - :caption: Contents: + :maxdepth: 3 + :caption: User Guide + + guide/installation + guide/episodic_rl + guide/basic_usage + guide/upgrading_envs + +.. toctree:: + :maxdepth: 3 + :caption: Examples + + examples/general + examples/dmc + examples/metaworld + examples/open_ai + examples/movement_primitives + examples/mp_params_tuning + examples/replanning_envs + +.. toctree:: + :maxdepth: 3 + :caption: Environments + + envs/fancy/index + envs/airhockey + envs/dmc + envs/meta + envs/open_ai + +.. toctree:: + :maxdepth: 3 + :caption: API api - envs/index -Indices and tables -================== +Citing the Project +------------------ -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +To cite this repository in publications: + +.. code:: bibtex + + @software{fancy_gym, + title = {Fancy Gym}, + author = {Otto, Fabian and Celik, Onur and Roth, Dominik and Zhou, Hongyi}, + abstract = {Fancy Gym: Unifying interface for various RL benchmarks with support for Black Box approaches.}, + url = {https://github.com/ALRhub/fancy_gym}, + organization = {Autonomous Learning Robots Lab (ALR) at KIT}, + } + +Icon Attribution +---------------- + +The icon is based on the +`Gymnasium `__ icon as +can be found +`here `__. + +================= + +.. raw:: html + +
+ + + +