From 891ddef2ff83ef175051d343833efab16dbdc18f Mon Sep 17 00:00:00 2001 From: Timon Erhart <57718207+turbotimon@users.noreply.github.com> Date: Tue, 23 Apr 2024 10:24:18 +0200 Subject: [PATCH 1/3] improve docs adding "--gym-packages" argument source: https://github.com/DLR-RM/rl-baselines3-zoo/blob/e06914e9835b8f3233b18d59943b1464b89ddb90/rl_zoo3/train.py#L107 --- docs/guide/custom_env.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/custom_env.rst b/docs/guide/custom_env.rst index 5c6ab016d..2a604584b 100644 --- a/docs/guide/custom_env.rst +++ b/docs/guide/custom_env.rst @@ -4,7 +4,7 @@ Custom Environment ================== -The easiest way to add support for a custom environment is to edit +The easiest way to add support for a custom or external environment is to import it using the `--gym-packages my_custom_env` argument or to edit ``rl_zoo3/import_envs.py`` and register your environment here. Then, you need to add a section for it in the hyperparameters file (``hyperparams/algo.yml`` or a custom yaml file that you can specify From 03f5a29b8f308b62b6dc162a151d721104513ba0 Mon Sep 17 00:00:00 2001 From: Timon Erhart <57718207+turbotimon@users.noreply.github.com> Date: Tue, 23 Apr 2024 10:46:09 +0200 Subject: [PATCH 2/3] fix double backticks --- docs/guide/custom_env.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/custom_env.rst b/docs/guide/custom_env.rst index 2a604584b..7b66ea78b 100644 --- a/docs/guide/custom_env.rst +++ b/docs/guide/custom_env.rst @@ -4,7 +4,7 @@ Custom Environment ================== -The easiest way to add support for a custom or external environment is to import it using the `--gym-packages my_custom_env` argument or to edit +The easiest way to add support for a custom or external environment is to import it using the ``--gym-packages my_custom_env`` argument or to edit ``rl_zoo3/import_envs.py`` and register your environment here. Then, you need to add a section for it in the hyperparameters file (``hyperparams/algo.yml`` or a custom yaml file that you can specify From 2d5c93629af1c543e87ec26cebd40cbfa4e8caf8 Mon Sep 17 00:00:00 2001 From: Antonin RAFFIN Date: Mon, 29 Jul 2024 10:41:15 +0200 Subject: [PATCH 3/3] Update docs/guide/custom_env.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Quentin Gallouédec <45557362+qgallouedec@users.noreply.github.com> --- docs/guide/custom_env.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide/custom_env.rst b/docs/guide/custom_env.rst index 7b66ea78b..1a0ac9b23 100644 --- a/docs/guide/custom_env.rst +++ b/docs/guide/custom_env.rst @@ -4,7 +4,7 @@ Custom Environment ================== -The easiest way to add support for a custom or external environment is to import it using the ``--gym-packages my_custom_env`` argument or to edit +The easiest way to add support for a custom or external environment is to import it using the ``--gym-packages my_package`` argument or to edit ``rl_zoo3/import_envs.py`` and register your environment here. Then, you need to add a section for it in the hyperparameters file (``hyperparams/algo.yml`` or a custom yaml file that you can specify