dodox/fancy_gym
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

More and better internal crosslinking

Browse Source
This commit is contained in:
Dominik Moritz Roth 2024-01-18 16:43:20 +01:00
parent fcc36ccb17
commit aa1e44781a
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/guide/upgrading_envs.rst
View File

@ -1,6 +1,8 @@
Creating new MP Environments Creating new MP Environments
---------------------------- ----------------------------
This guide will explain to you how to upgrade an existing step-based Gymnasium environment into one, that supports Movement Primitives (MPs). If you are looking for a guide to build such a Gymnasium environment instead, please have a look at `this guide <https://gymnasium.farama.org/tutorials/gymnasium_basics/environment_creation/>`__.
In case a required task is not supported yet in the MP framework, it can In case a required task is not supported yet in the MP framework, it can
be created relatively easy. For the task at hand, the following be created relatively easy. For the task at hand, the following
`interface <https://github.com/ALRhub/fancy_gym/tree/master/fancy_gym/black_box/raw_interface_wrapper.py>`__ `interface <https://github.com/ALRhub/fancy_gym/tree/master/fancy_gym/black_box/raw_interface_wrapper.py>`__

11
docs/source/index.rst
View File

@ -10,7 +10,7 @@ Key Features
------------ ------------
- **New Challenging Environments**: ``fancy_gym`` includes several new - **New Challenging Environments**: ``fancy_gym`` includes several new
environments (Panda Box Pushing, Table Tennis, etc.) that present a environments (`Panda Box Pushing <envs/fancy/mujoco.html#box-pushing>`_, `Table Tennis <envs/fancy/mujoco.html#table-tennis>`_, `etc. <envs/fancy/index.html>`_) that present a
higher degree of difficulty, pushing the boundaries of reinforcement higher degree of difficulty, pushing the boundaries of reinforcement
learning research. learning research.
- **Support for Movement Primitives**: ``fancy_gym`` supports a range - **Support for Movement Primitives**: ``fancy_gym`` supports a range
@ -22,13 +22,13 @@ Key Features
environments that support movement primitives. environments that support movement primitives.
- **Benchmark Suite Compatibility**: ``fancy_gym`` makes it easy to - **Benchmark Suite Compatibility**: ``fancy_gym`` makes it easy to
access renowned benchmark suites such as `DeepMind access renowned benchmark suites such as `DeepMind
Control <https://deepmind.com/research/publications/2020/dm-control-Software-and-Tasks-for-Continuous-Control>`__ Control <envs/dmc.html>`__
and `Metaworld <https://meta-world.github.io/>`__, whether you want and `Metaworld <envs/meta.html>`__, whether you want
to use them in the regular step-based setting or using MPs. to use them in the regular step-based setting or using MPs.
- **Contribute Your Own Environments**: If you’re inspired to create - **Contribute Your Own Environments**: If you’re inspired to create
custom gym environments, both step-based and with movement custom gym environments, both step-based and with movement
primitives, this primitives, this
`guide <https://gymnasium.farama.org/tutorials/gymnasium_basics/environment_creation/>`__ `guide <guide/upgrading_envs.html>`__
will assist you. We encourage and highly appreciate submissions via will assist you. We encourage and highly appreciate submissions via
PRs to integrate these environments into ``fancy_gym``. PRs to integrate these environments into ``fancy_gym``.
@ -96,8 +96,9 @@ can be found
.. raw:: html .. raw:: html
<div style="text-align: center;"> <div style="text-align: center; background: white; border-radius: 10px;">
<a href="https://alr.anthropomatik.kit.edu/"><img src="_static/imgs/alr.svg" style="margin: 5%; width: 20%;"></a> <a href="https://alr.anthropomatik.kit.edu/"><img src="_static/imgs/alr.svg" style="margin: 5%; width: 20%;"></a>
<a href="https://www.kit.edu/"><img src="_static/imgs/kit.svg" style="margin: 5%; width: 20%;"></a> <a href="https://www.kit.edu/"><img src="_static/imgs/kit.svg" style="margin: 5%; width: 20%;"></a>
<a href="https://uni-tuebingen.de/"><img src="_static/imgs/uni_tuebingen.svg" style="margin: 5%; width: 20%;"></a> <a href="https://uni-tuebingen.de/"><img src="_static/imgs/uni_tuebingen.svg" style="margin: 5%; width: 20%;"></a>
</div> </div>
<br>