From 7fa9702cd4b469163aa31f1efe8b275c3848712a Mon Sep 17 00:00:00 2001 From: Mark Towers Date: Thu, 30 Mar 2023 15:49:37 +0100 Subject: [PATCH] Make atari documentation consistent (#418) --- docs/environments/atari/adventure.md | 13 ++++++------- docs/environments/atari/air_raid.md | 14 ++++++-------- docs/environments/atari/alien.md | 13 ++++++------- docs/environments/atari/amidar.md | 14 ++++++-------- docs/environments/atari/assault.md | 14 ++++++-------- docs/environments/atari/asterix.md | 14 ++++++-------- docs/environments/atari/asteroids.md | 14 ++++++-------- docs/environments/atari/atlantis.md | 14 ++++++-------- docs/environments/atari/atlantis2.md | 14 ++++++-------- docs/environments/atari/backgammon.md | 14 ++++++-------- docs/environments/atari/bank_heist.md | 13 ++++++------- docs/environments/atari/basic_math.md | 14 ++++++-------- docs/environments/atari/battle_zone.md | 13 ++++++------- docs/environments/atari/beam_rider.md | 14 ++++++-------- docs/environments/atari/berzerk.md | 13 ++++++------- docs/environments/atari/blackjack.md | 14 ++++++-------- docs/environments/atari/bowling.md | 14 ++++++-------- docs/environments/atari/boxing.md | 13 ++++++------- docs/environments/atari/breakout.md | 14 ++++++-------- docs/environments/atari/carnival.md | 14 ++++++-------- docs/environments/atari/casino.md | 14 ++++++-------- docs/environments/atari/centipede.md | 13 ++++++------- docs/environments/atari/chopper_command.md | 13 ++++++------- docs/environments/atari/crazy_climber.md | 14 ++++++-------- docs/environments/atari/crossbow.md | 13 ++++++------- docs/environments/atari/darkchambers.md | 13 ++++++------- docs/environments/atari/defender.md | 13 ++++++------- docs/environments/atari/demon_attack.md | 14 ++++++-------- docs/environments/atari/donkey_kong.md | 13 ++++++------- docs/environments/atari/double_dunk.md | 13 ++++++------- docs/environments/atari/earthworld.md | 13 ++++++------- docs/environments/atari/elevator_action.md | 13 ++++++------- docs/environments/atari/enduro.md | 14 ++++++-------- docs/environments/atari/entombed.md | 13 ++++++------- docs/environments/atari/et.md | 13 ++++++------- docs/environments/atari/fishing_derby.md | 13 ++++++------- docs/environments/atari/flag_capture.md | 13 ++++++------- docs/environments/atari/freeway.md | 14 ++++++-------- docs/environments/atari/frogger.md | 14 ++++++-------- docs/environments/atari/frostbite.md | 13 ++++++------- docs/environments/atari/galaxian.md | 14 ++++++-------- docs/environments/atari/gopher.md | 14 ++++++-------- docs/environments/atari/gravitar.md | 13 ++++++------- docs/environments/atari/hangman.md | 13 ++++++------- docs/environments/atari/haunted_house.md | 13 ++++++------- docs/environments/atari/hero.md | 13 ++++++------- docs/environments/atari/human_cannonball.md | 13 ++++++------- docs/environments/atari/ice_hockey.md | 13 ++++++------- docs/environments/atari/jamesbond.md | 13 ++++++------- docs/environments/atari/journey_escape.md | 14 ++++++-------- docs/environments/atari/kaboom.md | 14 ++++++-------- docs/environments/atari/kangaroo.md | 13 ++++++------- docs/environments/atari/keystone_kapers.md | 14 ++++++-------- docs/environments/atari/king_kong.md | 14 ++++++-------- docs/environments/atari/klax.md | 13 ++++++------- docs/environments/atari/koolaid.md | 14 ++++++-------- docs/environments/atari/krull.md | 13 ++++++------- docs/environments/atari/kung_fu_master.md | 14 ++++++-------- docs/environments/atari/laser_gates.md | 13 ++++++------- docs/environments/atari/lost_luggage.md | 14 ++++++-------- docs/environments/atari/mario_bros.md | 13 ++++++------- docs/environments/atari/miniature_golf.md | 13 ++++++------- docs/environments/atari/montezuma_revenge.md | 13 ++++++------- docs/environments/atari/mr_do.md | 14 ++++++-------- docs/environments/atari/ms_pacman.md | 14 ++++++-------- docs/environments/atari/name_this_game.md | 14 ++++++-------- docs/environments/atari/othello.md | 14 ++++++-------- docs/environments/atari/pacman.md | 14 ++++++-------- docs/environments/atari/phoenix.md | 14 ++++++-------- docs/environments/atari/pitfall.md | 13 ++++++------- docs/environments/atari/pitfall2.md | 13 ++++++------- docs/environments/atari/pong.md | 14 ++++++-------- docs/environments/atari/pooyan.md | 14 ++++++-------- docs/environments/atari/private_eye.md | 13 ++++++------- docs/environments/atari/qbert.md | 14 ++++++-------- docs/environments/atari/riverraid.md | 13 ++++++------- docs/environments/atari/road_runner.md | 13 ++++++------- docs/environments/atari/robotank.md | 13 ++++++------- docs/environments/atari/seaquest.md | 13 ++++++------- docs/environments/atari/sir_lancelot.md | 14 ++++++-------- docs/environments/atari/skiing.md | 14 ++++++-------- docs/environments/atari/solaris.md | 13 ++++++------- docs/environments/atari/space_invaders.md | 14 ++++++-------- docs/environments/atari/space_war.md | 13 ++++++------- docs/environments/atari/star_gunner.md | 13 ++++++------- docs/environments/atari/superman.md | 13 ++++++------- docs/environments/atari/surround.md | 14 ++++++-------- docs/environments/atari/tennis.md | 13 ++++++------- docs/environments/atari/tetris.md | 14 ++++++-------- docs/environments/atari/tic_tac_toe_3d.md | 14 ++++++-------- docs/environments/atari/time_pilot.md | 14 ++++++-------- docs/environments/atari/trondead.md | 13 ++++++------- docs/environments/atari/turmoil.md | 14 ++++++-------- docs/environments/atari/tutankham.md | 14 ++++++-------- docs/environments/atari/up_n_down.md | 14 ++++++-------- docs/environments/atari/venture.md | 13 ++++++------- docs/environments/atari/video_checkers.md | 14 ++++++-------- docs/environments/atari/video_chess.md | 14 ++++++-------- docs/environments/atari/video_cube.md | 13 ++++++------- docs/environments/atari/video_pinball.md | 14 ++++++-------- docs/environments/atari/wizard_of_wor.md | 14 ++++++-------- docs/environments/atari/word_zapper.md | 13 ++++++------- docs/environments/atari/yars_revenge.md | 13 ++++++------- docs/environments/atari/zaxxon.md | 13 ++++++------- docs/scripts/gen_atari_table.py | 18 ++++++++---------- 105 files changed, 632 insertions(+), 790 deletions(-) diff --git a/docs/environments/atari/adventure.md b/docs/environments/atari/adventure.md index e00986f5b..a06d0fcc4 100644 --- a/docs/environments/atari/adventure.md +++ b/docs/environments/atari/adventure.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Adventure-v5")` | For more Adventure variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Adventure has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Adventure has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Adventure uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Adventure uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/air_raid.md b/docs/environments/atari/air_raid.md index 36bacddc1..0cb79cfd5 100644 --- a/docs/environments/atari/air_raid.md +++ b/docs/environments/atari/air_raid.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/AirRaid-v5")` | For more AirRaid variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ You control a ship that can move sideways. You must protect two buildings (one o ## Actions -AirRaid has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As AirRaid uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +AirRaid has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/alien.md b/docs/environments/atari/alien.md index bca3d1d14..81c57b90d 100644 --- a/docs/environments/atari/alien.md +++ b/docs/environments/atari/alien.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Alien-v5")` | For more Alien variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Alien has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Alien has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Alien uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Alien uses the full set of actions then specifying `full_action_space=True` w ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught diff --git a/docs/environments/atari/amidar.md b/docs/environments/atari/amidar.md index 33f1243ac..3ef9357ff 100644 --- a/docs/environments/atari/amidar.md +++ b/docs/environments/atari/amidar.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Amidar-v5")` | For more Amidar variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Amidar has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As Amidar uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Amidar has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -43,13 +40,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points. diff --git a/docs/environments/atari/assault.md b/docs/environments/atari/assault.md index 120752e5d..b57e658ac 100644 --- a/docs/environments/atari/assault.md +++ b/docs/environments/atari/assault.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(7) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Assault-v5")` | For more Assault variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Assault has the action space `Discrete(7)` with the table below lists the meaning of each action's meanings. -As Assault uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Assault has the action space of `Discrete(7)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/asterix.md b/docs/environments/atari/asterix.md index b8b2288f1..21599d014 100644 --- a/docs/environments/atari/asterix.md +++ b/docs/environments/atari/asterix.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Asterix-v5")` | For more Asterix variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Asterix has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As Asterix uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Asterix has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards A table of scores awarded for collecting the different objects is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325). diff --git a/docs/environments/atari/asteroids.md b/docs/environments/atari/asteroids.md index a46e680b8..a94cbd8bf 100644 --- a/docs/environments/atari/asteroids.md +++ b/docs/environments/atari/asteroids.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(14) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Asteroids-v5")` | For more Asteroids variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Asteroids has the action space `Discrete(14)` with the table below lists the meaning of each action's meanings. -As Asteroids uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Asteroids has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -44,13 +41,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score diff --git a/docs/environments/atari/atlantis.md b/docs/environments/atari/atlantis.md index 41e14f206..4348bd59b 100644 --- a/docs/environments/atari/atlantis.md +++ b/docs/environments/atari/atlantis.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Atlantis-v5")` | For more Atlantis variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Atlantis has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Atlantis uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Atlantis has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying enemies, keeping installations protected during attack waves. You score more points diff --git a/docs/environments/atari/atlantis2.md b/docs/environments/atari/atlantis2.md index 380e0871b..30b09f7ef 100644 --- a/docs/environments/atari/atlantis2.md +++ b/docs/environments/atari/atlantis2.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Atlantis2-v5")` | For more Atlantis2 variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Atlantis2 is missing description documentation. If you are interested in writing ## Actions -Atlantis2 has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Atlantis2 uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Atlantis2 has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/backgammon.md b/docs/environments/atari/backgammon.md index 499e89e23..b3232006c 100644 --- a/docs/environments/atari/backgammon.md +++ b/docs/environments/atari/backgammon.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(3) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Backgammon-v5")` | For more Backgammon variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Backgammon is missing description documentation. If you are interested in writin ## Actions -Backgammon has the action space `Discrete(3)` with the table below lists the meaning of each action's meanings. -As Backgammon uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Backgammon has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -38,13 +35,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/bank_heist.md b/docs/environments/atari/bank_heist.md index e796a082d..7c199f964 100644 --- a/docs/environments/atari/bank_heist.md +++ b/docs/environments/atari/bank_heist.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/BankHeist-v5")` | For more BankHeist variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -BankHeist has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +BankHeist has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As BankHeist uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As BankHeist uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city, diff --git a/docs/environments/atari/basic_math.md b/docs/environments/atari/basic_math.md index aefb35817..c36d84d71 100644 --- a/docs/environments/atari/basic_math.md +++ b/docs/environments/atari/basic_math.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/BasicMath-v5")` | For more BasicMath variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ BasicMath is missing description documentation. If you are interested in writing ## Actions -BasicMath has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As BasicMath uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +BasicMath has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/battle_zone.md b/docs/environments/atari/battle_zone.md index 317cec4df..0b096805f 100644 --- a/docs/environments/atari/battle_zone.md +++ b/docs/environments/atari/battle_zone.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/BattleZone-v5")` | For more BattleZone variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -BattleZone has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +BattleZone has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As BattleZone uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As BattleZone uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You receive points for destroying enemies. diff --git a/docs/environments/atari/beam_rider.md b/docs/environments/atari/beam_rider.md index 5c3455da3..fe409e976 100644 --- a/docs/environments/atari/beam_rider.md +++ b/docs/environments/atari/beam_rider.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/BeamRider-v5")` | For more BeamRider variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -BeamRider has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As BeamRider uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +BeamRider has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying enemies. diff --git a/docs/environments/atari/berzerk.md b/docs/environments/atari/berzerk.md index c3565f4be..053c70f13 100644 --- a/docs/environments/atari/berzerk.md +++ b/docs/environments/atari/berzerk.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Berzerk-v5")` | For more Berzerk variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Berzerk has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Berzerk has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Berzerk uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Berzerk uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying robots. diff --git a/docs/environments/atari/blackjack.md b/docs/environments/atari/blackjack.md index 3c64f14e8..65f5c382b 100644 --- a/docs/environments/atari/blackjack.md +++ b/docs/environments/atari/blackjack.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Blackjack-v5")` | For more Blackjack variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Blackjack is missing description documentation. If you are interested in writing ## Actions -Blackjack has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Blackjack uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Blackjack has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/bowling.md b/docs/environments/atari/bowling.md index 3d66af25f..32982c8b5 100644 --- a/docs/environments/atari/bowling.md +++ b/docs/environments/atari/bowling.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Bowling-v5")` | For more Bowling variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Bowling has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Bowling uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Bowling has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open" diff --git a/docs/environments/atari/boxing.md b/docs/environments/atari/boxing.md index d58fa3605..f0d2620bc 100644 --- a/docs/environments/atari/boxing.md +++ b/docs/environments/atari/boxing.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Boxing-v5")` | For more Boxing variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Boxing has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Boxing has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Boxing uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Boxing uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by landing punches. diff --git a/docs/environments/atari/breakout.md b/docs/environments/atari/breakout.md index 93126839e..42b0ba1e5 100644 --- a/docs/environments/atari/breakout.md +++ b/docs/environments/atari/breakout.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Breakout-v5")` | For more Breakout variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Breakout has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Breakout uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Breakout has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick. diff --git a/docs/environments/atari/carnival.md b/docs/environments/atari/carnival.md index 99de3d8b0..eb9112874 100644 --- a/docs/environments/atari/carnival.md +++ b/docs/environments/atari/carnival.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (214, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (214, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Carnival-v5")` | For more Carnival variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Carnival has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Carnival uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Carnival has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign. diff --git a/docs/environments/atari/casino.md b/docs/environments/atari/casino.md index 4fa45ff25..713d650dd 100644 --- a/docs/environments/atari/casino.md +++ b/docs/environments/atari/casino.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Casino-v5")` | For more Casino variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Casino is missing description documentation. If you are interested in writing up ## Actions -Casino has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Casino uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Casino has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/centipede.md b/docs/environments/atari/centipede.md index afea6949f..6e30d39f5 100644 --- a/docs/environments/atari/centipede.md +++ b/docs/environments/atari/centipede.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Centipede-v5")` | For more Centipede variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Centipede has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Centipede has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Centipede uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Centipede uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round diff --git a/docs/environments/atari/chopper_command.md b/docs/environments/atari/chopper_command.md index f4330dd78..1a747bd75 100644 --- a/docs/environments/atari/chopper_command.md +++ b/docs/environments/atari/chopper_command.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/ChopperCommand-v5")` | For more ChopperCommand variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -ChopperCommand has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +ChopperCommand has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As ChopperCommand uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As ChopperCommand uses the full set of actions then specifying `full_action_spac ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by destroying planes and other helicopters. You score extra points at the end of every wave, depending on the number diff --git a/docs/environments/atari/crazy_climber.md b/docs/environments/atari/crazy_climber.md index ef199b17a..15469c4f6 100644 --- a/docs/environments/atari/crazy_climber.md +++ b/docs/environments/atari/crazy_climber.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/CrazyClimber-v5")` | For more CrazyClimber variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -CrazyClimber has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As CrazyClimber uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +CrazyClimber has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards A table of scores awarded for completing each row of a building is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=113). diff --git a/docs/environments/atari/crossbow.md b/docs/environments/atari/crossbow.md index 712059805..0bd73a2ed 100644 --- a/docs/environments/atari/crossbow.md +++ b/docs/environments/atari/crossbow.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Crossbow-v5")` | For more Crossbow variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Crossbow is missing description documentation. If you are interested in writing ## Actions -Crossbow has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Crossbow has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Crossbow uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Crossbow uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/darkchambers.md b/docs/environments/atari/darkchambers.md index 2a6f13bfb..fbf9696b0 100644 --- a/docs/environments/atari/darkchambers.md +++ b/docs/environments/atari/darkchambers.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Darkchambers-v5")` | For more Darkchambers variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Darkchambers is missing description documentation. If you are interested in writ ## Actions -Darkchambers has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Darkchambers has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Darkchambers uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Darkchambers uses the full set of actions then specifying `full_action_space= ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/defender.md b/docs/environments/atari/defender.md index c306f4bd5..2478a76d8 100644 --- a/docs/environments/atari/defender.md +++ b/docs/environments/atari/defender.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Defender-v5")` | For more Defender variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Defender has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Defender has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Defender uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Defender uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You receive points for destroying enemies, rescuing abducted humans and keeping humans alive. diff --git a/docs/environments/atari/demon_attack.md b/docs/environments/atari/demon_attack.md index f44c64429..81a72a753 100644 --- a/docs/environments/atari/demon_attack.md +++ b/docs/environments/atari/demon_attack.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/DemonAttack-v5")` | For more DemonAttack variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -DemonAttack has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As DemonAttack uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +DemonAttack has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Each enemy you slay gives you points. The amount of points depends on the type of demon and which diff --git a/docs/environments/atari/donkey_kong.md b/docs/environments/atari/donkey_kong.md index a1b1e2669..61e3ec7fb 100644 --- a/docs/environments/atari/donkey_kong.md +++ b/docs/environments/atari/donkey_kong.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/DonkeyKong-v5")` | For more DonkeyKong variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ DonkeyKong is missing description documentation. If you are interested in writin ## Actions -DonkeyKong has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +DonkeyKong has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As DonkeyKong uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As DonkeyKong uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/double_dunk.md b/docs/environments/atari/double_dunk.md index d6a659769..39f419a3e 100644 --- a/docs/environments/atari/double_dunk.md +++ b/docs/environments/atari/double_dunk.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/DoubleDunk-v5")` | For more DoubleDunk variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -DoubleDunk has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +DoubleDunk has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As DoubleDunk uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As DoubleDunk uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Scores follow the rules of basketball. You can get either 3 points, 2 points foul line) depending diff --git a/docs/environments/atari/earthworld.md b/docs/environments/atari/earthworld.md index 29b9ffe75..6c4d303ab 100644 --- a/docs/environments/atari/earthworld.md +++ b/docs/environments/atari/earthworld.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Earthworld-v5")` | For more Earthworld variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Earthworld is missing description documentation. If you are interested in writin ## Actions -Earthworld has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Earthworld has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Earthworld uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Earthworld uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/elevator_action.md b/docs/environments/atari/elevator_action.md index e7348de46..64ac1c7be 100644 --- a/docs/environments/atari/elevator_action.md +++ b/docs/environments/atari/elevator_action.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/ElevatorAction-v5")` | For more ElevatorAction variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -ElevatorAction has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +ElevatorAction has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As ElevatorAction uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As ElevatorAction uses the full set of actions then specifying `full_action_spac ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You start with 4 lives and are awarded 100 points for each enemy shot, and 500 points for each diff --git a/docs/environments/atari/enduro.md b/docs/environments/atari/enduro.md index b8b34af64..bf8b7eeb3 100644 --- a/docs/environments/atari/enduro.md +++ b/docs/environments/atari/enduro.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Enduro-v5")` | For more Enduro variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Enduro has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As Enduro uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Enduro has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You get 1 point for each vehicle you overtake. diff --git a/docs/environments/atari/entombed.md b/docs/environments/atari/entombed.md index e51f08d92..f27e84868 100644 --- a/docs/environments/atari/entombed.md +++ b/docs/environments/atari/entombed.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Entombed-v5")` | For more Entombed variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Entombed is missing description documentation. If you are interested in writing ## Actions -Entombed has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Entombed has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Entombed uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Entombed uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/et.md b/docs/environments/atari/et.md index 1ce1e9d3b..0cac1420b 100644 --- a/docs/environments/atari/et.md +++ b/docs/environments/atari/et.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Et-v5")` | For more Et variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Et is missing description documentation. If you are interested in writing up a d ## Actions -Et has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Et has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Et uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Et uses the full set of actions then specifying `full_action_space=True` will ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/fishing_derby.md b/docs/environments/atari/fishing_derby.md index 65f377f66..0cf8fff28 100644 --- a/docs/environments/atari/fishing_derby.md +++ b/docs/environments/atari/fishing_derby.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/FishingDerby-v5")` | For more FishingDerby variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -FishingDerby has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +FishingDerby has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As FishingDerby uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As FishingDerby uses the full set of actions then specifying `full_action_space= ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can diff --git a/docs/environments/atari/flag_capture.md b/docs/environments/atari/flag_capture.md index a1762758c..77938d5f2 100644 --- a/docs/environments/atari/flag_capture.md +++ b/docs/environments/atari/flag_capture.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/FlagCapture-v5")` | For more FlagCapture variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ FlagCapture is missing description documentation. If you are interested in writi ## Actions -FlagCapture has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +FlagCapture has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As FlagCapture uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As FlagCapture uses the full set of actions then specifying `full_action_space=T ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/freeway.md b/docs/environments/atari/freeway.md index d20b3c1ca..33b440e10 100644 --- a/docs/environments/atari/freeway.md +++ b/docs/environments/atari/freeway.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(3) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Freeway-v5")` | For more Freeway variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Freeway has the action space `Discrete(3)` with the table below lists the meaning of each action's meanings. -As Freeway uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Freeway has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -40,13 +37,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can diff --git a/docs/environments/atari/frogger.md b/docs/environments/atari/frogger.md index 59f1ad9c5..e3bf43dc3 100644 --- a/docs/environments/atari/frogger.md +++ b/docs/environments/atari/frogger.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(5) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Frogger-v5")` | For more Frogger variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Frogger is missing description documentation. If you are interested in writing u ## Actions -Frogger has the action space `Discrete(5)` with the table below lists the meaning of each action's meanings. -As Frogger uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Frogger has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/frostbite.md b/docs/environments/atari/frostbite.md index 0058767f8..3c3c91c1d 100644 --- a/docs/environments/atari/frostbite.md +++ b/docs/environments/atari/frostbite.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Frostbite-v5")` | For more Frostbite variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Frostbite has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Frostbite has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Frostbite uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Frostbite uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can diff --git a/docs/environments/atari/galaxian.md b/docs/environments/atari/galaxian.md index ba6cbd9e1..7ed357977 100644 --- a/docs/environments/atari/galaxian.md +++ b/docs/environments/atari/galaxian.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Galaxian-v5")` | For more Galaxian variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Galaxian is missing description documentation. If you are interested in writing ## Actions -Galaxian has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Galaxian uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Galaxian has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/gopher.md b/docs/environments/atari/gopher.md index 87e38f228..524fa9d3d 100644 --- a/docs/environments/atari/gopher.md +++ b/docs/environments/atari/gopher.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(8) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Gopher-v5")` | For more Gopher variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Gopher has the action space `Discrete(8)` with the table below lists the meaning of each action's meanings. -As Gopher uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Gopher has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can diff --git a/docs/environments/atari/gravitar.md b/docs/environments/atari/gravitar.md index 62c8b884a..d4df6c8aa 100644 --- a/docs/environments/atari/gravitar.md +++ b/docs/environments/atari/gravitar.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Gravitar-v5")` | For more Gravitar variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Gravitar has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Gravitar has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Gravitar uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Gravitar uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can diff --git a/docs/environments/atari/hangman.md b/docs/environments/atari/hangman.md index 77218ca2c..298dfa5a4 100644 --- a/docs/environments/atari/hangman.md +++ b/docs/environments/atari/hangman.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Hangman-v5")` | For more Hangman variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Hangman is missing description documentation. If you are interested in writing u ## Actions -Hangman has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Hangman has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Hangman uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Hangman uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/haunted_house.md b/docs/environments/atari/haunted_house.md index 205ec58c9..9080ec767 100644 --- a/docs/environments/atari/haunted_house.md +++ b/docs/environments/atari/haunted_house.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/HauntedHouse-v5")` | For more HauntedHouse variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ HauntedHouse is missing description documentation. If you are interested in writ ## Actions -HauntedHouse has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +HauntedHouse has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As HauntedHouse uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As HauntedHouse uses the full set of actions then specifying `full_action_space= ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/hero.md b/docs/environments/atari/hero.md index 4bb760d83..39c84aad3 100644 --- a/docs/environments/atari/hero.md +++ b/docs/environments/atari/hero.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Hero-v5")` | For more Hero variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Hero has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Hero has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Hero uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Hero uses the full set of actions then specifying `full_action_space=True` wi ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for shooting critters, rescuing miners, and dynamiting walls. diff --git a/docs/environments/atari/human_cannonball.md b/docs/environments/atari/human_cannonball.md index 069686337..69a966d39 100644 --- a/docs/environments/atari/human_cannonball.md +++ b/docs/environments/atari/human_cannonball.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/HumanCannonball-v5")` | For more HumanCannonball variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ HumanCannonball is missing description documentation. If you are interested in w ## Actions -HumanCannonball has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +HumanCannonball has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As HumanCannonball uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As HumanCannonball uses the full set of actions then specifying `full_action_spa ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/ice_hockey.md b/docs/environments/atari/ice_hockey.md index 7b7641905..a77a68788 100644 --- a/docs/environments/atari/ice_hockey.md +++ b/docs/environments/atari/ice_hockey.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/IceHockey-v5")` | For more IceHockey variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -IceHockey has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +IceHockey has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As IceHockey uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As IceHockey uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points by shooting the puck into your opponent's goal. Your opponent scores in the same manner. diff --git a/docs/environments/atari/jamesbond.md b/docs/environments/atari/jamesbond.md index a210faefe..b67917e88 100644 --- a/docs/environments/atari/jamesbond.md +++ b/docs/environments/atari/jamesbond.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Jamesbond-v5")` | For more Jamesbond variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Jamesbond has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Jamesbond has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Jamesbond uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Jamesbond uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The game ends when you complete the last mission or when you lose the last craft. In either case, you'll receive your final score. diff --git a/docs/environments/atari/journey_escape.md b/docs/environments/atari/journey_escape.md index 31d53abf9..cbcd13bc0 100644 --- a/docs/environments/atari/journey_escape.md +++ b/docs/environments/atari/journey_escape.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(16) | -| Observation Shape | (230, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (230, 160, 3), uint8) | | Import | `gymnasium.make("ALE/JourneyEscape-v5")` | For more JourneyEscape variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -JourneyEscape has the action space `Discrete(16)` with the table below lists the meaning of each action's meanings. -As JourneyEscape uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +JourneyEscape has the action space of `Discrete(16)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -45,13 +42,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards At the start of the game, you will have $50,000 and 60 units of time. diff --git a/docs/environments/atari/kaboom.md b/docs/environments/atari/kaboom.md index 465967c32..8167228f4 100644 --- a/docs/environments/atari/kaboom.md +++ b/docs/environments/atari/kaboom.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(4) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Kaboom-v5")` | For more Kaboom variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Kaboom is missing description documentation. If you are interested in writing up ## Actions -Kaboom has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings. -As Kaboom uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Kaboom has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/kangaroo.md b/docs/environments/atari/kangaroo.md index d1992b612..2db659ce0 100644 --- a/docs/environments/atari/kangaroo.md +++ b/docs/environments/atari/kangaroo.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Kangaroo-v5")` | For more Kangaroo variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Kangaroo has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Kangaroo has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Kangaroo uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Kangaroo uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Your score will be shown at the top right corner of the game. diff --git a/docs/environments/atari/keystone_kapers.md b/docs/environments/atari/keystone_kapers.md index 29ec97248..263327344 100644 --- a/docs/environments/atari/keystone_kapers.md +++ b/docs/environments/atari/keystone_kapers.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(14) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/KeystoneKapers-v5")` | For more KeystoneKapers variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ KeystoneKapers is missing description documentation. If you are interested in wr ## Actions -KeystoneKapers has the action space `Discrete(14)` with the table below lists the meaning of each action's meanings. -As KeystoneKapers uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +KeystoneKapers has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/king_kong.md b/docs/environments/atari/king_kong.md index 2353be1ff..35e3b71c2 100644 --- a/docs/environments/atari/king_kong.md +++ b/docs/environments/atari/king_kong.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/KingKong-v5")` | For more KingKong variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ KingKong is missing description documentation. If you are interested in writing ## Actions -KingKong has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As KingKong uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +KingKong has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/klax.md b/docs/environments/atari/klax.md index 699b921b2..73c6cd3e2 100644 --- a/docs/environments/atari/klax.md +++ b/docs/environments/atari/klax.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Klax-v5")` | For more Klax variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Klax is missing description documentation. If you are interested in writing up a ## Actions -Klax has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Klax has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Klax uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Klax uses the full set of actions then specifying `full_action_space=True` wi ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/koolaid.md b/docs/environments/atari/koolaid.md index 28827c21d..0de5df128 100644 --- a/docs/environments/atari/koolaid.md +++ b/docs/environments/atari/koolaid.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Koolaid-v5")` | For more Koolaid variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Koolaid is missing description documentation. If you are interested in writing u ## Actions -Koolaid has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As Koolaid uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Koolaid has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -40,13 +37,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/krull.md b/docs/environments/atari/krull.md index a8bb02d46..94ebbefc9 100644 --- a/docs/environments/atari/krull.md +++ b/docs/environments/atari/krull.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Krull-v5")` | For more Krull variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Krull has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Krull has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Krull uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Krull uses the full set of actions then specifying `full_action_space=True` w ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You will receive various scores for each monster you kill. diff --git a/docs/environments/atari/kung_fu_master.md b/docs/environments/atari/kung_fu_master.md index 59bc8049e..b66c33402 100644 --- a/docs/environments/atari/kung_fu_master.md +++ b/docs/environments/atari/kung_fu_master.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(14) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/KungFuMaster-v5")` | For more KungFuMaster variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -KungFuMaster has the action space `Discrete(14)` with the table below lists the meaning of each action's meanings. -As KungFuMaster uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +KungFuMaster has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -44,13 +41,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/laser_gates.md b/docs/environments/atari/laser_gates.md index cc8c822eb..db80eaace 100644 --- a/docs/environments/atari/laser_gates.md +++ b/docs/environments/atari/laser_gates.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/LaserGates-v5")` | For more LaserGates variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ LaserGates is missing description documentation. If you are interested in writin ## Actions -LaserGates has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +LaserGates has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As LaserGates uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As LaserGates uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/lost_luggage.md b/docs/environments/atari/lost_luggage.md index 654e6b33f..a53f6e59c 100644 --- a/docs/environments/atari/lost_luggage.md +++ b/docs/environments/atari/lost_luggage.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/LostLuggage-v5")` | For more LostLuggage variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ LostLuggage is missing description documentation. If you are interested in writi ## Actions -LostLuggage has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As LostLuggage uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +LostLuggage has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -40,13 +37,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/mario_bros.md b/docs/environments/atari/mario_bros.md index 10ab04fc5..b030507f6 100644 --- a/docs/environments/atari/mario_bros.md +++ b/docs/environments/atari/mario_bros.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/MarioBros-v5")` | For more MarioBros variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ MarioBros is missing description documentation. If you are interested in writing ## Actions -MarioBros has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +MarioBros has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As MarioBros uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As MarioBros uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/miniature_golf.md b/docs/environments/atari/miniature_golf.md index 75c3c6199..4843d13ff 100644 --- a/docs/environments/atari/miniature_golf.md +++ b/docs/environments/atari/miniature_golf.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/MiniatureGolf-v5")` | For more MiniatureGolf variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ MiniatureGolf is missing description documentation. If you are interested in wri ## Actions -MiniatureGolf has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +MiniatureGolf has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As MiniatureGolf uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As MiniatureGolf uses the full set of actions then specifying `full_action_space ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/montezuma_revenge.md b/docs/environments/atari/montezuma_revenge.md index c4b1df3f1..42e4d978d 100644 --- a/docs/environments/atari/montezuma_revenge.md +++ b/docs/environments/atari/montezuma_revenge.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/MontezumaRevenge-v5")` | For more MontezumaRevenge variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -MontezumaRevenge has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +MontezumaRevenge has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As MontezumaRevenge uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As MontezumaRevenge uses the full set of actions then specifying `full_action_sp ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/mr_do.md b/docs/environments/atari/mr_do.md index 6ce78d57b..7a509334d 100644 --- a/docs/environments/atari/mr_do.md +++ b/docs/environments/atari/mr_do.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/MrDo-v5")` | For more MrDo variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ MrDo is missing description documentation. If you are interested in writing up a ## Actions -MrDo has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As MrDo uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +MrDo has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/ms_pacman.md b/docs/environments/atari/ms_pacman.md index ea562734d..012dca5d0 100644 --- a/docs/environments/atari/ms_pacman.md +++ b/docs/environments/atari/ms_pacman.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/MsPacman-v5")` | For more MsPacman variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -MsPacman has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As MsPacman uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +MsPacman has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/name_this_game.md b/docs/environments/atari/name_this_game.md index 802a5c725..6daa449bf 100644 --- a/docs/environments/atari/name_this_game.md +++ b/docs/environments/atari/name_this_game.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/NameThisGame-v5")` | For more NameThisGame variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -NameThisGame has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As NameThisGame uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +NameThisGame has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/othello.md b/docs/environments/atari/othello.md index f837e55e6..83fe84868 100644 --- a/docs/environments/atari/othello.md +++ b/docs/environments/atari/othello.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Othello-v5")` | For more Othello variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Othello is missing description documentation. If you are interested in writing u ## Actions -Othello has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As Othello uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Othello has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/pacman.md b/docs/environments/atari/pacman.md index 2a21777b2..5a0e46fc5 100644 --- a/docs/environments/atari/pacman.md +++ b/docs/environments/atari/pacman.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(5) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Pacman-v5")` | For more Pacman variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Pacman is missing description documentation. If you are interested in writing up ## Actions -Pacman has the action space `Discrete(5)` with the table below lists the meaning of each action's meanings. -As Pacman uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Pacman has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/phoenix.md b/docs/environments/atari/phoenix.md index 7d51906dd..ece974350 100644 --- a/docs/environments/atari/phoenix.md +++ b/docs/environments/atari/phoenix.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(8) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Phoenix-v5")` | For more Phoenix variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Phoenix has the action space `Discrete(8)` with the table below lists the meaning of each action's meanings. -As Phoenix uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Phoenix has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/pitfall.md b/docs/environments/atari/pitfall.md index 39caf40ef..f5926ab18 100644 --- a/docs/environments/atari/pitfall.md +++ b/docs/environments/atari/pitfall.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Pitfall-v5")` | For more Pitfall variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Pitfall has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Pitfall has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Pitfall uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Pitfall uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You get score points for collecting treasure, you lose points through some misfortunes like falling down a hole. diff --git a/docs/environments/atari/pitfall2.md b/docs/environments/atari/pitfall2.md index a9c5ac4e7..ca3b78cc1 100644 --- a/docs/environments/atari/pitfall2.md +++ b/docs/environments/atari/pitfall2.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Pitfall2-v5")` | For more Pitfall2 variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Pitfall2 is missing description documentation. If you are interested in writing ## Actions -Pitfall2 has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Pitfall2 has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Pitfall2 uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Pitfall2 uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/pong.md b/docs/environments/atari/pong.md index a52af7c8a..6582dc0dc 100644 --- a/docs/environments/atari/pong.md +++ b/docs/environments/atari/pong.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Pong-v5")` | For more Pong variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Pong has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Pong uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Pong has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You get score points for getting the ball to pass the opponent's paddle. You lose points if the ball passes your paddle. diff --git a/docs/environments/atari/pooyan.md b/docs/environments/atari/pooyan.md index 8413553bb..cfd585118 100644 --- a/docs/environments/atari/pooyan.md +++ b/docs/environments/atari/pooyan.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (220, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (220, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Pooyan-v5")` | For more Pooyan variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Pooyan has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Pooyan uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Pooyan has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards If you hit a balloon, wolf or stone with an arrow you score points. diff --git a/docs/environments/atari/private_eye.md b/docs/environments/atari/private_eye.md index d884c5aa4..58a79fbad 100644 --- a/docs/environments/atari/private_eye.md +++ b/docs/environments/atari/private_eye.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/PrivateEye-v5")` | For more PrivateEye variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -PrivateEye has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +PrivateEye has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As PrivateEye uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As PrivateEye uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for completing your tasks like gathering evidence, nabbing questionable characters or closing cases etc. You lose points if you get hit or if your auto is on a pothole. diff --git a/docs/environments/atari/qbert.md b/docs/environments/atari/qbert.md index 57d0e2d38..9e5966ded 100644 --- a/docs/environments/atari/qbert.md +++ b/docs/environments/atari/qbert.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Qbert-v5")` | For more Qbert variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Qbert has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As Qbert uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Qbert has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for changing color of the cubes to their destination colors or by defeating enemies. You also gain points for completing a level. diff --git a/docs/environments/atari/riverraid.md b/docs/environments/atari/riverraid.md index 6df622fa9..753beeb24 100644 --- a/docs/environments/atari/riverraid.md +++ b/docs/environments/atari/riverraid.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Riverraid-v5")` | For more Riverraid variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Riverraid has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Riverraid has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Riverraid uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Riverraid uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Score points are your only reward. You get score points each time you destroy an enemy object: diff --git a/docs/environments/atari/road_runner.md b/docs/environments/atari/road_runner.md index d010cedcf..993e56380 100644 --- a/docs/environments/atari/road_runner.md +++ b/docs/environments/atari/road_runner.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/RoadRunner-v5")` | For more RoadRunner variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -RoadRunner has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +RoadRunner has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As RoadRunner uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As RoadRunner uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Score points are your only reward. You get score points each time you: diff --git a/docs/environments/atari/robotank.md b/docs/environments/atari/robotank.md index f0a5e98f1..fb863a709 100644 --- a/docs/environments/atari/robotank.md +++ b/docs/environments/atari/robotank.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Robotank-v5")` | For more Robotank variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Robotank has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Robotank has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Robotank uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Robotank uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The number of enemies destroyed is the only reward. diff --git a/docs/environments/atari/seaquest.md b/docs/environments/atari/seaquest.md index 000ffeda9..32baf109a 100644 --- a/docs/environments/atari/seaquest.md +++ b/docs/environments/atari/seaquest.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Seaquest-v5")` | For more Seaquest variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Seaquest has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Seaquest has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Seaquest uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Seaquest uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Score points are your only reward. diff --git a/docs/environments/atari/sir_lancelot.md b/docs/environments/atari/sir_lancelot.md index a25bac92e..bd2e6d1c2 100644 --- a/docs/environments/atari/sir_lancelot.md +++ b/docs/environments/atari/sir_lancelot.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/SirLancelot-v5")` | For more SirLancelot variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ SirLancelot is missing description documentation. If you are interested in writi ## Actions -SirLancelot has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As SirLancelot uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +SirLancelot has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/skiing.md b/docs/environments/atari/skiing.md index bf140f3b2..f76c027c3 100644 --- a/docs/environments/atari/skiing.md +++ b/docs/environments/atari/skiing.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(3) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Skiing-v5")` | For more Skiing variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Skiing has the action space `Discrete(3)` with the table below lists the meaning of each action's meanings. -As Skiing uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Skiing has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -40,13 +37,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards Seconds are your only rewards - negative rewards and penalties (e.g. missing a gate) are assigned as additional seconds. diff --git a/docs/environments/atari/solaris.md b/docs/environments/atari/solaris.md index c7b7a047e..6f7bb06fa 100644 --- a/docs/environments/atari/solaris.md +++ b/docs/environments/atari/solaris.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Solaris-v5")` | For more Solaris variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Solaris has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Solaris has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Solaris uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Solaris uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You gain points for destroying enemies, rescuing cadets, making it through a corridor, destroying enemy planets etc. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=450). diff --git a/docs/environments/atari/space_invaders.md b/docs/environments/atari/space_invaders.md index 98adea430..62eb36a2b 100644 --- a/docs/environments/atari/space_invaders.md +++ b/docs/environments/atari/space_invaders.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/SpaceInvaders-v5")` | For more SpaceInvaders variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -SpaceInvaders has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As SpaceInvaders uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +SpaceInvaders has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You gain points for destroying space invaders. The invaders in the back rows are worth more points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=460). diff --git a/docs/environments/atari/space_war.md b/docs/environments/atari/space_war.md index ce7c0a6a9..7303da21c 100644 --- a/docs/environments/atari/space_war.md +++ b/docs/environments/atari/space_war.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (250, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | | Import | `gymnasium.make("ALE/SpaceWar-v5")` | For more SpaceWar variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ SpaceWar is missing description documentation. If you are interested in writing ## Actions -SpaceWar has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +SpaceWar has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As SpaceWar uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As SpaceWar uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/star_gunner.md b/docs/environments/atari/star_gunner.md index 266ea8718..97b613525 100644 --- a/docs/environments/atari/star_gunner.md +++ b/docs/environments/atari/star_gunner.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/StarGunner-v5")` | For more StarGunner variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](http://www.atarimania ## Actions -StarGunner has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +StarGunner has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As StarGunner uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As StarGunner uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying enemies. You get bonus points for clearing a wave and a level. For a more detailed documentation, see [the Atari Mania page](http://www.atarimania.com/game-atari-2600-vcs-stargunner_16921.html). diff --git a/docs/environments/atari/superman.md b/docs/environments/atari/superman.md index 0a8df5e36..e0ac2328e 100644 --- a/docs/environments/atari/superman.md +++ b/docs/environments/atari/superman.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Superman-v5")` | For more Superman variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Superman is missing description documentation. If you are interested in writing ## Actions -Superman has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Superman has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Superman uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Superman uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/surround.md b/docs/environments/atari/surround.md index c1b17081e..1dc50e800 100644 --- a/docs/environments/atari/surround.md +++ b/docs/environments/atari/surround.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(5) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Surround-v5")` | For more Surround variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Surround is missing description documentation. If you are interested in writing ## Actions -Surround has the action space `Discrete(5)` with the table below lists the meaning of each action's meanings. -As Surround uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Surround has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/tennis.md b/docs/environments/atari/tennis.md index 9ed669190..94e7f6bb1 100644 --- a/docs/environments/atari/tennis.md +++ b/docs/environments/atari/tennis.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Tennis-v5")` | For more Tennis variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Tennis has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Tennis has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Tennis uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Tennis uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards The scoring is as per the sport of tennis, played till one set. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=555). diff --git a/docs/environments/atari/tetris.md b/docs/environments/atari/tetris.md index b21fee9e2..6ed504477 100644 --- a/docs/environments/atari/tetris.md +++ b/docs/environments/atari/tetris.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(5) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Tetris-v5")` | For more Tetris variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Tetris is missing description documentation. If you are interested in writing up ## Actions -Tetris has the action space `Discrete(5)` with the table below lists the meaning of each action's meanings. -As Tetris uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Tetris has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/tic_tac_toe_3d.md b/docs/environments/atari/tic_tac_toe_3d.md index c99ea5f05..b3dd27766 100644 --- a/docs/environments/atari/tic_tac_toe_3d.md +++ b/docs/environments/atari/tic_tac_toe_3d.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/TicTacToe3D-v5")` | For more TicTacToe3D variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ TicTacToe3D is missing description documentation. If you are interested in writi ## Actions -TicTacToe3D has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As TicTacToe3D uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +TicTacToe3D has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/time_pilot.md b/docs/environments/atari/time_pilot.md index 02156527f..5ffe51f38 100644 --- a/docs/environments/atari/time_pilot.md +++ b/docs/environments/atari/time_pilot.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/TimePilot-v5")` | For more TimePilot variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](http://www.atarimania ## Actions -TimePilot has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As TimePilot uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +TimePilot has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -43,13 +40,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ### Rewards You score points for destroying enemies, gaining more points for difficult enemies. For a more detailed documentation, see [the Atari Mania page](http://www.atarimania.com/game-atari-2600-vcs-time-pilot_8038.html). diff --git a/docs/environments/atari/trondead.md b/docs/environments/atari/trondead.md index 71b28489c..c22f9f859 100644 --- a/docs/environments/atari/trondead.md +++ b/docs/environments/atari/trondead.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Trondead-v5")` | For more Trondead variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ Trondead is missing description documentation. If you are interested in writing ## Actions -Trondead has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Trondead has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Trondead uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As Trondead uses the full set of actions then specifying `full_action_space=True ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/turmoil.md b/docs/environments/atari/turmoil.md index 0992583cc..8cd1ec605 100644 --- a/docs/environments/atari/turmoil.md +++ b/docs/environments/atari/turmoil.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(12) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Turmoil-v5")` | For more Turmoil variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ Turmoil is missing description documentation. If you are interested in writing u ## Actions -Turmoil has the action space `Discrete(12)` with the table below lists the meaning of each action's meanings. -As Turmoil uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Turmoil has the action space of `Discrete(12)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/tutankham.md b/docs/environments/atari/tutankham.md index 2e4fe84c3..fd4ef03ad 100644 --- a/docs/environments/atari/tutankham.md +++ b/docs/environments/atari/tutankham.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(8) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Tutankham-v5")` | For more Tutankham variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Tutankham has the action space `Discrete(8)` with the table below lists the meaning of each action's meanings. -As Tutankham uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +Tutankham has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/up_n_down.md b/docs/environments/atari/up_n_down.md index 0edf8fbef..8646c2c75 100644 --- a/docs/environments/atari/up_n_down.md +++ b/docs/environments/atari/up_n_down.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(6) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/UpNDown-v5")` | For more UpNDown variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -UpNDown has the action space `Discrete(6)` with the table below lists the meaning of each action's meanings. -As UpNDown uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +UpNDown has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/venture.md b/docs/environments/atari/venture.md index aeed3440f..139fb8081 100644 --- a/docs/environments/atari/venture.md +++ b/docs/environments/atari/venture.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Venture-v5")` | For more Venture variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Venture has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Venture has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Venture uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Venture uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/video_checkers.md b/docs/environments/atari/video_checkers.md index bd5d32ebd..40f36c22f 100644 --- a/docs/environments/atari/video_checkers.md +++ b/docs/environments/atari/video_checkers.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(5) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/VideoCheckers-v5")` | For more VideoCheckers variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ VideoCheckers is missing description documentation. If you are interested in wri ## Actions -VideoCheckers has the action space `Discrete(5)` with the table below lists the meaning of each action's meanings. -As VideoCheckers uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +VideoCheckers has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -39,13 +36,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/video_chess.md b/docs/environments/atari/video_chess.md index 7a146c984..22cc8c487 100644 --- a/docs/environments/atari/video_chess.md +++ b/docs/environments/atari/video_chess.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/VideoChess-v5")` | For more VideoChess variants with different observation and action spaces, see the variants section. @@ -27,8 +25,7 @@ VideoChess is missing description documentation. If you are interested in writin ## Actions -VideoChess has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As VideoChess uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +VideoChess has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -41,13 +38,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/video_cube.md b/docs/environments/atari/video_cube.md index 496c4f6f6..43392b4f2 100644 --- a/docs/environments/atari/video_cube.md +++ b/docs/environments/atari/video_cube.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/VideoCube-v5")` | For more VideoCube variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ VideoCube is missing description documentation. If you are interested in writing ## Actions -VideoCube has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +VideoCube has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As VideoCube uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As VideoCube uses the full set of actions then specifying `full_action_space=Tru ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/video_pinball.md b/docs/environments/atari/video_pinball.md index 0784798ca..c38724da0 100644 --- a/docs/environments/atari/video_pinball.md +++ b/docs/environments/atari/video_pinball.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(9) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/VideoPinball-v5")` | For more VideoPinball variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -VideoPinball has the action space `Discrete(9)` with the table below lists the meaning of each action's meanings. -As VideoPinball uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +VideoPinball has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -42,13 +39,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/wizard_of_wor.md b/docs/environments/atari/wizard_of_wor.md index 0ee9044df..6141b7d1c 100644 --- a/docs/environments/atari/wizard_of_wor.md +++ b/docs/environments/atari/wizard_of_wor.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(10) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/WizardOfWor-v5")` | For more WizardOfWor variants with different observation and action spaces, see the variants section. @@ -29,8 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -WizardOfWor has the action space `Discrete(10)` with the table below lists the meaning of each action's meanings. -As WizardOfWor uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. +WizardOfWor has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`. @@ -43,13 +40,14 @@ initialization or by passing `full_action_space=True` to `gymnasium.make`. ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/word_zapper.md b/docs/environments/atari/word_zapper.md index 28baa2a28..aa4329d4e 100644 --- a/docs/environments/atari/word_zapper.md +++ b/docs/environments/atari/word_zapper.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/WordZapper-v5")` | For more WordZapper variants with different observation and action spaces, see the variants section. @@ -27,7 +25,7 @@ WordZapper is missing description documentation. If you are interested in writin ## Actions -WordZapper has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +WordZapper has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As WordZapper uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -41,13 +39,14 @@ As WordZapper uses the full set of actions then specifying `full_action_space=Tr ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/yars_revenge.md b/docs/environments/atari/yars_revenge.md index c55d7ac3a..f35d6058b 100644 --- a/docs/environments/atari/yars_revenge.md +++ b/docs/environments/atari/yars_revenge.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/YarsRevenge-v5")` | For more YarsRevenge variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -YarsRevenge has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +YarsRevenge has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As YarsRevenge uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As YarsRevenge uses the full set of actions then specifying `full_action_space=T ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/environments/atari/zaxxon.md b/docs/environments/atari/zaxxon.md index 1dc60478c..287d6b735 100644 --- a/docs/environments/atari/zaxxon.md +++ b/docs/environments/atari/zaxxon.md @@ -14,9 +14,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | Discrete(18) | -| Observation Shape | (210, 160, 3) | -| Observation High | 255 | -| Observation Low | 0 | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | | Import | `gymnasium.make("ALE/Zaxxon-v5")` | For more Zaxxon variants with different observation and action spaces, see the variants section. @@ -29,7 +27,7 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ ## Actions -Zaxxon has the action space `Discrete(18)` with the table below lists the meaning of each action's meanings. +Zaxxon has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. As Zaxxon uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. | Value | Meaning | Value | Meaning | Value | Meaning | @@ -43,13 +41,14 @@ As Zaxxon uses the full set of actions then specifying `full_action_space=True` ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` ## Variants diff --git a/docs/scripts/gen_atari_table.py b/docs/scripts/gen_atari_table.py index 67cedb94d..e7ff9d6ea 100644 --- a/docs/scripts/gen_atari_table.py +++ b/docs/scripts/gen_atari_table.py @@ -91,7 +91,7 @@ for rom_id in tqdm(ALL_ATARI_GAMES): if env_data["atariage_url"]: env_url = f""" For a more detailed documentation, see [the AtariAge page]({env_data['atariage_url']}) - """ +""" else: env_url = "" reward_description = env_data["reward_description"] @@ -111,11 +111,10 @@ For a more detailed documentation, see [the AtariAge page]({env_data['atariage_u tablefmt="github", ) if env.action_space.n == 18: - action_description = f"""{env_name} has the action space `{env.action_space}` with the table below lists the meaning of each action's meanings. + action_description = f"""{env_name} has the action space `{env.action_space}` with the table below listing the meaning of each action's meanings. As {env_name} uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`.""" else: - action_description = f"""{env_name} has the action space `{env.action_space}` with the table below lists the meaning of each action's meanings. -As {env_name} uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment. + action_description = f"""{env_name} has the action space of `{env.action_space}` with the table below listing the meaning of each action's meanings. To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during initialization or by passing `full_action_space=True` to `gymnasium.make`.""" @@ -186,9 +185,7 @@ This environment is part of the Atari environments. Please read | | | |---|---| | Action Space | {env.action_space} | -| Observation Shape | {env.observation_space.shape} | -| Observation High | {env.observation_space.high.max()} | -| Observation Low | {env.observation_space.low.min()} | +| Observation Space | {env.observation_space} | | Import | `gymnasium.make("{env.spec.id}")` | For more {env_name} variants with different observation and action spaces, see the variants section. @@ -205,13 +202,14 @@ For more {env_name} variants with different observation and action spaces, see t ## Observations -Atari environment have two possible observation types, the observation space is listed below. -See variants section for the type of observation used by each environment id. +Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` - `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` +- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type + +See variants section for the type of observation used by each environment id by default. -Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)` {reward_description} ## Variants