From 954daaac376176fad08bfa41766232b94620f388 Mon Sep 17 00:00:00 2001 From: Ashish Dutt Date: Sat, 5 Feb 2022 19:36:36 +0800 Subject: [PATCH] Custom environment page modified. Following fixes are committed in response to issue#755. (#758) * Page modified. Following fixes are committed in response to issue#755. - fixed the broken url on creating custom gym environment. Also added appropriate advice by citing official OpenAi gym documents. - SB3 text tweaked. * modified page - updated the in-line text hyperlinks to follow Sphinx restructured text format. * modified page - updated the in-line text hyperlinks to follow Sphinx restructured text format. - updated text grammar * Language Co-authored-by: Anssi --- docs/guide/custom_env.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/guide/custom_env.rst b/docs/guide/custom_env.rst index 83f387c..d769aa5 100644 --- a/docs/guide/custom_env.rst +++ b/docs/guide/custom_env.rst @@ -3,7 +3,7 @@ Using Custom Environments ========================== -To use the rl baselines with custom environments, they just need to follow the *gym* interface. +To use the RL baselines with custom environments, they just need to follow the *gym* interface. That is to say, your environment must implement the following methods (and inherits from OpenAI Gym Class): @@ -73,15 +73,11 @@ To check that your environment follows the gym interface, please use: -We have created a `colab notebook `_ for -a concrete example of creating a custom environment. +We have created a `colab notebook `_ for a concrete example on creating a custom environment along with an example of using it with Stable-Baselines3 interface. -You can also find a `complete guide online `_ -on creating a custom Gym environment. +Alternatively, you may look at OpenAI Gym `built-in environments `_. However, the readers are cautioned as per OpenAI Gym `official wiki `_, its advised not to customize their built-in environments. It is better to copy and create new ones if you need to modify them. - -Optionally, you can also register the environment with gym, -that will allow you to create the RL agent in one line (and use ``gym.make()`` to instantiate the env): +Optionally, you can also register the environment with gym, that will allow you to create the RL agent in one line (and use ``gym.make()`` to instantiate the env): .. code-block:: python