Skip to content

Avoid confusion about env registration#38

Open
Trenza1ore wants to merge 2 commits intokenjyoung:masterfrom
Trenza1ore:master
Open

Avoid confusion about env registration#38
Trenza1ore wants to merge 2 commits intokenjyoung:masterfrom
Trenza1ore:master

Conversation

@Trenza1ore
Copy link

@Trenza1ore Trenza1ore commented Nov 3, 2025

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:

Example code in README.md did not show that environments need to be registered into gymnasium before gym.make(...). Since there is no example code regarding gymnasium wrapper, README is the main source of info.

I have made the following minor changes to the code base:

  • Add from .gym import register_envs in __init__.py for user friendliness
  • Include import minatar and minatar.register_envs() to code blocks in README.md
  • Also removed an incorrect ```` in README.md that breaks some Markdown renderers

It would be nice if you can accept this PR to reduce confusion, since ALE/Atari register 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 gymnasium wrapper, perhaps an SB3 example? I'm happy to help if that's also desirable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant