diff --git a/docs/source/guide/basic_usage.rst b/docs/source/guide/basic_usage.rst index 7bb4100..8cb90fe 100644 --- a/docs/source/guide/basic_usage.rst +++ b/docs/source/guide/basic_usage.rst @@ -1,9 +1,7 @@ Basic Usage ----------- -We will only show the basics here and prepared `multiple -examples `__ -for a more detailed look. +We will only show the basics here and prepared :ref:`multiple examples ` for a more detailed look. Step-Based Environments ~~~~~~~~~~~~~~~~~~~~~~~ @@ -34,7 +32,7 @@ Regular step based environments added by Fancy Gym are added into the if terminated or truncated: observation, info = env.reset() -Black-box Environments +Black-Box Environments ~~~~~~~~~~~~~~~~~~~~~~ All environments provide by default the cumulative episode reward, this @@ -67,13 +65,13 @@ a MP-variant of an environment is given by ``_/``. Just keep in mind, calling ``step()`` executes a full trajectory. - | **Note:** - | Currently, we are also in the process of enabling replanning as - well as learning of sub-trajectories. This allows to split the - episode into multiple trajectories and is a hybrid setting between - step-based and black-box leaning. While this is already - implemented, it is still in beta and requires further testing. Feel - free to try it and open an issue with any problems that occur. +.. note:: + Currently, we are also in the process of enabling replanning as + well as learning of sub-trajectories. This allows to split the + episode into multiple trajectories and is a hybrid setting between + step-based and black-box leaning. While this is already + implemented, it is still in beta and requires further testing. Feel + free to try it and open an issue with any problems that occur. .. code:: python diff --git a/docs/source/guide/episodic_rl.rst b/docs/source/guide/episodic_rl.rst index 4c0b7bc..b2491f9 100644 --- a/docs/source/guide/episodic_rl.rst +++ b/docs/source/guide/episodic_rl.rst @@ -3,7 +3,7 @@ What is Episodic RL? .. raw:: html -

+

Movement primitive (MP) environments differ from traditional step-based environments. They align more with concepts from stochastic search, @@ -14,13 +14,6 @@ produced by trajectory generators like Dynamic Movement Primitives (DMP), Probabilistic Movement Primitives (ProMP) or Probabilistic Dynamic Movement Primitives (ProDMP). -.. raw:: html - -

- -.. raw:: html - -

Once generated, these trajectories are converted into step-by-step actions using a trajectory tracking controller. The specific controller @@ -29,13 +22,6 @@ position, velocity, and PD-Controllers tailored for position, velocity, and torque control. Additionally, we have a specialized controller designed for the MetaWorld control suite. -.. raw:: html - -

- -.. raw:: html - -

While the overarching objective of MP environments remains the learning of an optimal policy, the actions here represent the parametrization of @@ -47,4 +33,4 @@ every unique context. .. raw:: html -

\ No newline at end of file +
diff --git a/docs/source/guide/installation.rst b/docs/source/guide/installation.rst index 5885d43..0077ba4 100644 --- a/docs/source/guide/installation.rst +++ b/docs/source/guide/installation.rst @@ -1,10 +1,11 @@ Installation ------------ -We recommend installing ``fancy_gym`` into a virtual environment as -provided by `venv `__. 3rd -party alternatives to venv like `Poetry `__ -or `Conda `__ can also be used. +.. note:: + We recommend installing ``fancy_gym`` into a virtual environment as + provided by `venv `__. 3rd + party alternatives to venv like `Poetry `__ + or `Conda `__ can also be used. Installation from PyPI (recommended) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/guide/upgrading_envs.rst b/docs/source/guide/upgrading_envs.rst index f04e8a0..19c7563 100644 --- a/docs/source/guide/upgrading_envs.rst +++ b/docs/source/guide/upgrading_envs.rst @@ -92,7 +92,7 @@ If you created a new task wrapper, feel free to open a PR, so we can integrate it for others to use as well. Without the integration the task can still be used. A rough outline can be shown here, for more details we recommend having a look at the -`examples `__. +:ref:`multiple examples `. If the step-based is already registered with gym, you can simply do the following: