Avoid confusion about env registration#38
Open
Trenza1ore wants to merge 2 commits intokenjyoung:masterfrom
Open
Avoid confusion about env registration#38Trenza1ore wants to merge 2 commits intokenjyoung:masterfrom
Trenza1ore wants to merge 2 commits intokenjyoung:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hiii,
firstly thanks for making such an interesting project possible.
I've noticed that sometimes when first starting to use MinAtar, there is a big confusion:
I have made the following minor changes to the code base:
from .gym import register_envsin__init__.pyfor user friendlinessimport minatarandminatar.register_envs()to code blocks inREADME.mdREADME.mdthat breaks some Markdown renderersIt would be nice if you can accept this PR to reduce confusion, since
ALE/Atariregister environments at import, it is not uncommon for newcomers to assume the same here without further clarification in README.What would also be nice to have is some example code regarding
gymnasiumwrapper, perhaps an SB3 example? I'm happy to help if that's also desirable.