From aa1e44781a6fd64fe89a174f6ff57d31ef0f2762 Mon Sep 17 00:00:00 2001 From: Dominik Roth Date: Thu, 18 Jan 2024 16:43:20 +0100 Subject: [PATCH] More and better internal crosslinking --- docs/source/guide/upgrading_envs.rst | 2 ++ docs/source/index.rst | 11 ++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/guide/upgrading_envs.rst b/docs/source/guide/upgrading_envs.rst index 19c7563..9981b2b 100644 --- a/docs/source/guide/upgrading_envs.rst +++ b/docs/source/guide/upgrading_envs.rst @@ -1,6 +1,8 @@ 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 `__. + 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 `interface `__ diff --git a/docs/source/index.rst b/docs/source/index.rst index 2655d01..89afec3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,7 +10,7 @@ Key Features ------------ - **New Challenging Environments**: ``fancy_gym`` includes several new - environments (Panda Box Pushing, Table Tennis, etc.) that present a + 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 @@ -22,13 +22,13 @@ Key Features 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 + 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 `__ + `guide `__ will assist you. We encourage and highly appreciate submissions via PRs to integrate these environments into ``fancy_gym``. @@ -96,8 +96,9 @@ can be found .. raw:: html -
+
+