Various additions to docs
This commit is contained in:
parent
73d00ddab3
commit
d26233f908
BIN
docs/source/_static/imgs/Box_Pushing.gif
Normal file
BIN
docs/source/_static/imgs/Box_Pushing.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 2.2 MiB |
BIN
docs/source/_static/imgs/Metaworld.gif
Normal file
BIN
docs/source/_static/imgs/Metaworld.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.4 MiB |
5
docs/source/_templates/layout.html
Normal file
5
docs/source/_templates/layout.html
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{% extends "!layout.html" %}
|
||||||
|
|
||||||
|
{% block extrahead %}
|
||||||
|
{{ super() }}
|
||||||
|
{% endblock %}
|
@ -38,6 +38,7 @@ exclude_patterns = ['build', 'Thumbs.db', '.DS_Store']
|
|||||||
|
|
||||||
html_theme = 'sphinx_rtd_theme'
|
html_theme = 'sphinx_rtd_theme'
|
||||||
html_logo = "_static/imgs/icon.svg"
|
html_logo = "_static/imgs/icon.svg"
|
||||||
|
html_favicon = "_static/imgs/icon.svg"
|
||||||
epub_show_urls = 'footnote'
|
epub_show_urls = 'footnote'
|
||||||
html_static_path = ['_static']
|
html_static_path = ['_static']
|
||||||
|
|
||||||
|
4
docs/source/envs/fancy/airhockey.rst
Normal file
4
docs/source/envs/fancy/airhockey.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
AirHockey
|
||||||
|
=========
|
||||||
|
|
||||||
|
TODO
|
@ -1,8 +1,17 @@
|
|||||||
Fancy
|
Fancy
|
||||||
=====
|
=====
|
||||||
|
|
||||||
Fancy gym also adds a couple of environments. Some of these are adaptations of existing environments while others were designed and build by us from the ground up.
|
Fancy gym adds a couple of environments. Some of these are adaptations of existing environments while others were designed and build by us from the ground up.
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<div class='center'>
|
||||||
|
<img src="../../_static/imgs/Box_Pushing.gif" style="margin: 5%; width: 45%;">
|
||||||
|
<p>Box Pushing Task</p>
|
||||||
|
</div>
|
||||||
|
<br>
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
airhockey
|
||||||
mujoco.md
|
mujoco.md
|
||||||
classic_control.md
|
classic_control.md
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
# Custom Mujoco tasks
|
# Mujoco
|
||||||
|
|
||||||
## Step-based Environments
|
## Step-based Environments
|
||||||
|
|
||||||
@ -47,7 +47,6 @@ No longer used?
|
|||||||
| `fancy/BallInACupGoal-v0` | Similar to `fancy/BallInACupSimple-v0` but the ball needs to be caught at a specified goal position | 4000 | 7 | wip |
|
| `fancy/BallInACupGoal-v0` | Similar to `fancy/BallInACupSimple-v0` but the ball needs to be caught at a specified goal position | 4000 | 7 | wip |
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
## MP Environments
|
## MP Environments
|
||||||
|
|
||||||
Many of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.
|
Many of these envs also exist as MP-variants. Refer to them using `fancy_DMP/<name>` `fancy_ProMP/<name>` or `fancy_ProDMP/<name>`.
|
||||||
|
@ -41,6 +41,15 @@ Key Features
|
|||||||
guide/basic_usage
|
guide/basic_usage
|
||||||
guide/upgrading_envs
|
guide/upgrading_envs
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
:caption: Environments
|
||||||
|
|
||||||
|
envs/fancy/index
|
||||||
|
envs/dmc
|
||||||
|
envs/meta
|
||||||
|
envs/open_ai
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:caption: Examples
|
:caption: Examples
|
||||||
@ -51,18 +60,9 @@ Key Features
|
|||||||
examples/open_ai
|
examples/open_ai
|
||||||
examples/movement_primitives
|
examples/movement_primitives
|
||||||
examples/mp_params_tuning
|
examples/mp_params_tuning
|
||||||
|
examples/pd_control_gain_tuning
|
||||||
examples/replanning_envs
|
examples/replanning_envs
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 3
|
|
||||||
:caption: Environments
|
|
||||||
|
|
||||||
envs/fancy/index
|
|
||||||
envs/airhockey
|
|
||||||
envs/dmc
|
|
||||||
envs/meta
|
|
||||||
envs/open_ai
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:caption: API
|
:caption: API
|
||||||
|
Loading…
Reference in New Issue
Block a user