Skip to content

Improve docs adding "--gym-packages" argument #445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve docs adding "--gym-packages" argument #445

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
891ddef
improve docs adding "--gym-packages" argument
turbotimon Apr 23, 2024
03f5a29
fix double backticks
turbotimon Apr 23, 2024
13becf4
Merge branch 'master' into patch-1
araffin Jul 29, 2024
2d5c936
Update docs/guide/custom_env.rst
araffin Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guide/custom_env.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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_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
Expand Down