Allow random stages to sample from a subset

roclark commented 2 years ago

Description

Random stage selection allows more diverse sampling and exploration for agents, though the wide variety of stages in Super Mario Bros. can be challenging for agents to learn. Specifying a subset of stages to randomly sample allows the user to hand-select similar levels for agents to have more diverse observations, while still being focused enough to learn the mechanics of the environments in question.

For example, several of the castle levels have identical layouts but feature slightly different hazards. Allowing the agent to learn on different castle environments can help it be more generic while still having a reasonable chance of completing the level.

Type of change

Please select all relevant options:

[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] MGMT (non-breaking change to deployment, CI, etc.

Checklist

[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] I have added tests that prove my fix is effective or that my feature works

Kautenja commented 2 years ago

Awesome feature and this code is super clean! Thanks :)

Kautenja commented 2 years ago

Released in version 7.4.0

Kautenja / gym-super-mario-bros