Skip to content
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

Jump to bottom

Simplify registration to NoFrameskip-v4 and v5 environments #561

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

Simplify registration to NoFrameskip-v4 and v5 environments #561

wants to merge 13 commits into from

Conversation

pseudo-rnd-thoughts
Copy link
Member

@pseudo-rnd-thoughts pseudo-rnd-thoughts commented Sep 18, 2024 •
edited
Loading

Name obs_type= frameskip= repeat_action_probability= full_action_space=
Adventure-v0 "rgb" (2, 5,) 0.25 False
AdventureDeterministic-v0 "rgb" 4 0.25 False
AdventureNoframeskip-v0 "rgb" 1 0.25 False
Adventure-ram-v0 "ram" (2, 5,) 0.25 False
Adventure-ramDeterministic-v0 "ram" 4 0.25 False
Adventure-ramNoframeskip-v0 "ram" 1 0.25 False
Adventure-v4 "rgb" (2, 5,) 0.0 False
AdventureDeterministic-v4 "rgb" 4 0.0 False
AdventureNoframeskip-v4 "rgb" 1 0.0 False
Adventure-ram-v4 "ram" (2, 5,) 0.0 False
Adventure-ramDeterministic-v4 "ram" 4 0.0 False
Adventure-ramNoframeskip-v4 "ram" 1 0.0 False
ALE/Adventure-v5 "rgb" 4 0.25 False
ALE/Adventure-ram-v5 "ram" 4 0.25 False

This table shows all the environment versions registered (a total of 14) for EACH of the 104 environments, resulting in 960 environments registered. This makes testing and viewing the environment registry very messy due to the number of environments.

Importantly, behind the scenes, all these environment versions use the same base environment with different parameters being passed. Theoretically, a single environment version can be registered with users specifying the environment parameters.

Despite over 960 environments registered, a very small subset are regularly used.

This PR reduces the number of ALE registered environments from 960 to 208 to only include {rom_id}NoFrameskip-v4 and ALE/{rom_id}-v5.

Name obs_type= frameskip= repeat_action_probability= full_ation_space=
AdventureNoFrameskip-v4 "rgb" 1 0.00 False
ALE/Adventure-v5 "rgb" 4 0.25 False

These were selected as NoFrameskip-v4, which is the most popular of the v0 or v4 environment, providing a frameskip of 1 for Atari Preprocessing and no repeat action probability.
v5 is the most recent model that follows Machado et al., 2017.

To recreate old environments, users should pass the modified parameters to gym.make, for example to recreate Adventure-ramNoFrameskip-v4, users should run gym.make("ALE/Adventure-v5", obs_type="ram", frameskip=1, repeat_action_probability=0) following the table above for each variable.

@pseudo-rnd-thoughts
Simplify registration
370685a
@pseudo-rnd-thoughts
Merge branch 'refs/heads/master' into simplify-registration
7ad3e65 
# Conflicts:
#	src/ale/python/registration.py
@pseudo-rnd-thoughts
Simplify the registration to v5
0156ff0
@pseudo-rnd-thoughts
Update documentation
b951f45
@pseudo-rnd-thoughts
Update all the environment docs
5792e65
@pseudo-rnd-thoughts
Merge branch 'refs/heads/master' into update-env-md
0ae9753
@pseudo-rnd-thoughts
Fix the gif link
c3207af
@pseudo-rnd-thoughts
Merge branch 'refs/heads/update-env-md' into simplify-registration
b688245 
# Conflicts:
#	docs/_scripts/environment-docs.json
#	docs/_scripts/gen_environments_md.py
#	docs/environments/amidar.md
#	docs/environments/assault.md
#	docs/environments/asterix.md
#	docs/environments/asteroids.md
#	docs/environments/atlantis.md
#	docs/environments/atlantis2.md
#	docs/environments/backgammon.md
#	docs/environments/bank_heist.md
#	docs/environments/basic_math.md
#	docs/environments/battle_zone.md
#	docs/environments/beam_rider.md
#	docs/environments/berzerk.md
#	docs/environments/blackjack.md
#	docs/environments/bowling.md
#	docs/environments/boxing.md
#	docs/environments/breakout.md
#	docs/environments/carnival.md
#	docs/environments/casino.md
#	docs/environments/centipede.md
#	docs/environments/chopper_command.md
#	docs/environments/crazy_climber.md
#	docs/environments/crossbow.md
#	docs/environments/darkchambers.md
#	docs/environments/defender.md
#	docs/environments/demon_attack.md
#	docs/environments/donkey_kong.md
#	docs/environments/double_dunk.md
#	docs/environments/earthworld.md
#	docs/environments/elevator_action.md
#	docs/environments/enduro.md
#	docs/environments/entombed.md
#	docs/environments/et.md
#	docs/environments/fishing_derby.md
#	docs/environments/flag_capture.md
#	docs/environments/freeway.md
#	docs/environments/frogger.md
#	docs/environments/frostbite.md
#	docs/environments/galaxian.md
#	docs/environments/gopher.md
#	docs/environments/gravitar.md
#	docs/environments/hangman.md
#	docs/environments/haunted_house.md
#	docs/environments/hero.md
#	docs/environments/human_cannonball.md
#	docs/environments/ice_hockey.md
#	docs/environments/jamesbond.md
#	docs/environments/journey_escape.md
#	docs/environments/kaboom.md
#	docs/environments/kangaroo.md
#	docs/environments/keystone_kapers.md
#	docs/environments/king_kong.md
#	docs/environments/klax.md
#	docs/environments/koolaid.md
#	docs/environments/krull.md
#	docs/environments/kung_fu_master.md
#	docs/environments/laser_gates.md
#	docs/environments/lost_luggage.md
#	docs/environments/mario_bros.md
#	docs/environments/miniature_golf.md
#	docs/environments/montezuma_revenge.md
#	docs/environments/mr_do.md
#	docs/environments/ms_pacman.md
#	docs/environments/name_this_game.md
#	docs/environments/othello.md
#	docs/environments/pacman.md
#	docs/environments/phoenix.md
#	docs/environments/pitfall.md
#	docs/environments/pitfall2.md
#	docs/environments/pong.md
#	docs/environments/pooyan.md
#	docs/environments/private_eye.md
#	docs/environments/qbert.md
#	docs/environments/riverraid.md
#	docs/environments/road_runner.md
#	docs/environments/robotank.md
#	docs/environments/seaquest.md
#	docs/environments/sir_lancelot.md
#	docs/environments/skiing.md
#	docs/environments/solaris.md
#	docs/environments/space_invaders.md
#	docs/environments/space_war.md
#	docs/environments/star_gunner.md
#	docs/environments/superman.md
#	docs/environments/surround.md
#	docs/environments/tennis.md
#	docs/environments/tetris.md
#	docs/environments/tic_tac_toe_3d.md
#	docs/environments/time_pilot.md
#	docs/environments/trondead.md
#	docs/environments/turmoil.md
#	docs/environments/tutankham.md
#	docs/environments/up_n_down.md
#	docs/environments/venture.md
#	docs/environments/video_checkers.md
#	docs/environments/video_chess.md
#	docs/environments/video_cube.md
#	docs/environments/video_pinball.md
#	docs/environments/wizard_of_wor.md
#	docs/environments/word_zapper.md
#	docs/environments/yars_revenge.md
#	docs/environments/zaxxon.md
@pseudo-rnd-thoughts
Update the documentation
f036f69
@pseudo-rnd-thoughts
Merge branch 'refs/heads/master' into simplify-registration
6345f3d 
# Conflicts:
#	docs/_scripts/environment-docs.json
#	docs/_scripts/gen_environments_md.py
#	docs/environments.md
#	docs/environments/amidar.md
#	docs/environments/assault.md
#	docs/environments/asterix.md
#	docs/environments/asteroids.md
#	docs/environments/atlantis.md
#	docs/environments/atlantis2.md
#	docs/environments/backgammon.md
#	docs/environments/bank_heist.md
#	docs/environments/basic_math.md
#	docs/environments/battle_zone.md
#	docs/environments/beam_rider.md
#	docs/environments/berzerk.md
#	docs/environments/blackjack.md
#	docs/environments/bowling.md
#	docs/environments/boxing.md
#	docs/environments/breakout.md
#	docs/environments/carnival.md
#	docs/environments/casino.md
#	docs/environments/centipede.md
#	docs/environments/chopper_command.md
#	docs/environments/crazy_climber.md
#	docs/environments/crossbow.md
#	docs/environments/darkchambers.md
#	docs/environments/defender.md
#	docs/environments/demon_attack.md
#	docs/environments/donkey_kong.md
#	docs/environments/double_dunk.md
#	docs/environments/earthworld.md
#	docs/environments/elevator_action.md
#	docs/environments/enduro.md
#	docs/environments/entombed.md
#	docs/environments/et.md
#	docs/environments/fishing_derby.md
#	docs/environments/flag_capture.md
#	docs/environments/freeway.md
#	docs/environments/frogger.md
#	docs/environments/frostbite.md
#	docs/environments/galaxian.md
#	docs/environments/gopher.md
#	docs/environments/gravitar.md
#	docs/environments/hangman.md
#	docs/environments/haunted_house.md
#	docs/environments/hero.md
#	docs/environments/human_cannonball.md
#	docs/environments/ice_hockey.md
#	docs/environments/jamesbond.md
#	docs/environments/journey_escape.md
#	docs/environments/kaboom.md
#	docs/environments/kangaroo.md
#	docs/environments/keystone_kapers.md
#	docs/environments/king_kong.md
#	docs/environments/klax.md
#	docs/environments/koolaid.md
#	docs/environments/krull.md
#	docs/environments/kung_fu_master.md
#	docs/environments/laser_gates.md
#	docs/environments/lost_luggage.md
#	docs/environments/mario_bros.md
#	docs/environments/miniature_golf.md
#	docs/environments/montezuma_revenge.md
#	docs/environments/mr_do.md
#	docs/environments/ms_pacman.md
#	docs/environments/name_this_game.md
#	docs/environments/othello.md
#	docs/environments/pacman.md
#	docs/environments/phoenix.md
#	docs/environments/pitfall.md
#	docs/environments/pitfall2.md
#	docs/environments/pong.md
#	docs/environments/pooyan.md
#	docs/environments/private_eye.md
#	docs/environments/qbert.md
#	docs/environments/riverraid.md
#	docs/environments/road_runner.md
#	docs/environments/robotank.md
#	docs/environments/seaquest.md
#	docs/environments/sir_lancelot.md
#	docs/environments/skiing.md
#	docs/environments/solaris.md
#	docs/environments/space_invaders.md
#	docs/environments/space_war.md
#	docs/environments/star_gunner.md
#	docs/environments/superman.md
#	docs/environments/surround.md
#	docs/environments/tennis.md
#	docs/environments/tetris.md
#	docs/environments/tic_tac_toe_3d.md
#	docs/environments/time_pilot.md
#	docs/environments/trondead.md
#	docs/environments/turmoil.md
#	docs/environments/tutankham.md
#	docs/environments/up_n_down.md
#	docs/environments/venture.md
#	docs/environments/video_checkers.md
#	docs/environments/video_chess.md
#	docs/environments/video_cube.md
#	docs/environments/video_pinball.md
#	docs/environments/wizard_of_wor.md
#	docs/environments/word_zapper.md
#	docs/environments/yars_revenge.md
#	docs/environments/zaxxon.md
#	src/ale/python/registration.py
@pseudo-rnd-thoughts
Update the registration list to include NoFrameskip-v4
7e744e5
@pseudo-rnd-thoughts
pre-commit
b26a69d
@pseudo-rnd-thoughts pseudo-rnd-thoughts changed the title Simplify registration to only the v5 environments Simplify registration to NoFrameskip-v4 and v5 environments Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@pseudo-rnd-thoughts