diff --git a/docs/_scripts/environment-docs.json b/docs/_scripts/environment-docs.json
index 16fece669..11ce24986 100644
--- a/docs/_scripts/environment-docs.json
+++ b/docs/_scripts/environment-docs.json
@@ -12,12 +12,12 @@
"alien": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=815",
"env_description": "You are stuck in a maze-like space ship with three aliens. You goal is to destroy their eggs that are scattered all over the ship while simultaneously avoiding the aliens (they are trying to kill you). You have a flamethrower that can help you turn them away in tricky situations. Moreover, you can occasionally collect a power-up (pulsar) that gives you the temporary ability to kill aliens.",
- "reward_description": "### Rewards\n\nYou score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught\nby an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a\ntable of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).\n"
+ "reward_description": "You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a table of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815)."
},
"amidar": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=817",
"env_description": "This game is similar to Pac-Man: You are trying to visit all places on a 2-dimensional grid while simultaneously avoiding your enemies. You can turn the tables at one point in the game: Your enemies turn into chickens and you can catch them.",
- "reward_description": "### Rewards\n\nYou score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).\n"
+ "reward_description": "You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817)."
},
"assault": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=827",
@@ -27,22 +27,22 @@
"asterix": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=3325",
"env_description": "You are Asterix and can move horizontally (continuously) and vertically (discretely). Objects move horizontally across the screen: lyres and other (more useful) objects. Your goal is to guideAsterix in such a way as to avoid lyres and collect as many other objects as possible. You score points by collecting objects and lose a life whenever you collect a lyre. You have three lives available at the beginning. If you score sufficiently many points, you will be awarded additional points.",
- "reward_description": "### Rewards\n\nA table of scores awarded for collecting the different objects is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325).\n"
+ "reward_description": "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)."
},
"asteroids": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=828",
"env_description": "This is a well-known arcade game: You control a spaceship in an asteroid field and must break up asteroids by shooting them. Once all asteroids are destroyed, you enter a new level and new asteroids will appear. You will occasionally be attacked by a flying saucer.",
- "reward_description": "### Rewards\n\nYou score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score\nfor destroying it.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).\n"
+ "reward_description": "You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score for destroying it. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL)."
},
"atlantis": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=835",
"env_description": "Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts.You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.",
- "reward_description": "### Rewards\n\nYou score points for destroying enemies, keeping installations protected during attack waves. You score more points\nif you manage to destroy your enemies with one of the outer defense posts.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).\n"
+ "reward_description": "You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)."
},
"atlantis2": {
- "atariage_url": "",
- "env_description": "Atlantis2 is missing description documentation. If you are interested in writing up a description, please create an issue or PR with the information on the Gymnasium github.",
- "reward_description": ""
+ "atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=835",
+ "env_description": "Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts.You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.",
+ "reward_description": "You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)."
},
"backgammon": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=12",
@@ -52,27 +52,27 @@
"bank_heist": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=1008",
"env_description": "You are a bank robber and (naturally) want to rob as many banks as possible. You control your getaway car and must navigate maze-like cities. The police chases you and will appear whenever you rob a bank. You may destroy police cars by dropping sticks of dynamite. You can fill up your gas tank by entering a new city.At the beginning of the game you have four lives. Lives are lost if you run out of gas, are caught by the police,or run over the dynamite you have previously dropped.",
- "reward_description": "### Rewards\n\nYou score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city,\nyou will score extra points.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).\n"
+ "reward_description": "You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city, you will score extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008)."
},
"basic_math": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=14",
- "env_description": "You must solve basic math problems using a joystick\nto scroll to the correct numeric answer.",
+ "env_description": "You must solve basic math problems using a joystick to scroll to the correct numeric answer.",
"reward_description": ""
},
"battle_zone": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=859",
"env_description": "You control a tank and must destroy enemy vehicles. This game is played in a first-person perspective and creates a 3D illusion. A radar screen shows enemies around you. You start with 5 lives and gain up to 2 extra lives if you reach a sufficient score.",
- "reward_description": "### Rewards\n\nYou receive points for destroying enemies.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).\n"
+ "reward_description": "You receive points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL)."
},
"beam_rider": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=860",
"env_description": "You control a space-ship that travels forward at a constant speed. You can only steer it sideways between discrete positions. Your goal is to destroy enemy ships, avoid their attacks and dodge space debris.",
- "reward_description": "### Rewards\n\nYou score points for destroying enemies.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).\n"
+ "reward_description": "You score points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL)."
},
"berzerk": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=866",
"env_description": "You are stuck in a maze with evil robots. You must destroy them and avoid touching the walls of the maze, as this will kill you. You may be awarded extra lives after scoring a sufficient number of points, depending on the game mode.You may also be chased by an undefeatable enemy, Evil Otto, that you must avoid. Evil Otto does not appear in the default mode.",
- "reward_description": "### Rewards\n\nYou score points for destroying robots.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).\n"
+ "reward_description": "You score points for destroying robots. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL)."
},
"blackjack": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=34",
@@ -82,22 +82,22 @@
"bowling": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=879",
"env_description": "Your goal is to score as many points as possible in the game of Bowling. A game consists of 10 frames and you have two tries per frame. Knocking down all pins on the first try is called a \"strike\". Knocking down all pins on the second roll is called a \"spar\". Otherwise, the frame is called \"open\".",
- "reward_description": "### Rewards\n\nYou receive points for knocking down pins. The exact score depends on whether you manage a \"strike\", \"spare\" or \"open\"\nframe. Moreover, the points you score for one frame may depend on following frames.\nYou can score up to 300 points in one game (if you manage to do 12 strikes).\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).\n"
+ "reward_description": "You receive points for knocking down pins. The exact score depends on whether you manage a \"strike\", \"spare\" or \"open\" frame. Moreover, the points you score for one frame may depend on following frames. You can score up to 300 points in one game (if you manage to do 12 strikes). For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879)."
},
"boxing": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=882",
"env_description": "You fight an opponent in a boxing ring. You score points for hitting the opponent. If you score 100 points, your opponent is knocked out.",
- "reward_description": "### Rewards\n\nYou score points by landing punches.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).\n"
+ "reward_description": "You score points by landing punches. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882)."
},
"breakout": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=889",
"env_description": "Another famous Atari game. The dynamics are similar to pong: You move a paddle and hit the ball in a brick wall at the top of the screen. Your goal is to destroy the brick wall. You can try to break through the wall and let the ball wreak havoc on the other side, all on its own! You have five lives.",
- "reward_description": "### Rewards\n\nYou score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).\n"
+ "reward_description": "You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889)."
},
"carnival": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=908",
"env_description": "This is a \"shoot 'em up\" game. Targets move horizontally across the screen and you must shoot them. You are in control of a gun that can be moved horizontally. The supply of ammunition is limited and chickens may steal some bullets from you if you don't hit them in time.",
- "reward_description": "### Rewards\n\nYou score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign.\nYou will score extra points if it shows a plus sign!\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).\n"
+ "reward_description": "You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign. You will score extra points if it shows a plus sign! For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908)."
},
"casino": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=70",
@@ -107,17 +107,17 @@
"centipede": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=911",
"env_description": "You are an elf and must use your magic wands to fend off spiders, fleas and centipedes. Your goal is to protect mushrooms in an enchanted forest. If you are bitten by a spider, flea or centipede, you will be temporally paralyzed and you will lose a magic wand. The game ends once you have lost all wands. You may receive additional wands after scoring a sufficient number of points.",
- "reward_description": "### Rewards\n\nYou score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round\n(i.e. after you have lost a wand) for mushrooms that were not destroyed.\nDetailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).\n"
+ "reward_description": "You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round (i.e. after you have lost a wand) for mushrooms that were not destroyed. Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911)."
},
"chopper_command": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=921",
"env_description": "You control a helicopter and must protect truck convoys. To that end, you need to shoot down enemy aircraft.A mini-map is displayed at the bottom of the screen.",
- "reward_description": "### Rewards\n\nYou score points by destroying planes and other helicopters. You score extra points at the end of every wave, depending on the number\nof trucks that have survived.\nDetailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=921).\n"
+ "reward_description": "You score points by destroying planes and other helicopters. You score extra points at the end of every wave, depending on the number of trucks that have survived. Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=921)."
},
"crazy_climber": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=113",
"env_description": "You are a climber trying to reach the top of four buildings, while avoiding obstacles like closing windows and falling objects. When you receive damage (windows closing or objects) you will fall and lose one life; you have a total of 5 lives before the end games. At the top of each building, there's a helicopter which you need to catch to get to the next building. The goal is to climb as fast as possible while receiving the least amount of damage.",
- "reward_description": "### Rewards\n\nA 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).\n"
+ "reward_description": "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)."
},
"crossbow": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=115",
@@ -132,12 +132,12 @@
"defender": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=128",
"env_description": "Aliens attack the earth. You control a spaceship and must defend humanity by destroying alien ships and rescuing humanoids.You have three lives and three smart bombs. You lose a live when you are shot down by an alien spaceship.Points are scored by destroying enemies and retrieving humans that are being abducted. You have an unlimited number of laser missiles.",
- "reward_description": "### Rewards\n\nYou receive points for destroying enemies, rescuing abducted humans and keeping humans alive.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=128).\n"
+ "reward_description": "You receive points for destroying enemies, rescuing abducted humans and keeping humans alive. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=128)."
},
"demon_attack": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=135",
"env_description": "You are facing waves of demons in the ice planet of Krybor. Points are accumulated by destroying demons. You begin with 3 reserve bunkers, and can increase its number (up to 6) by avoiding enemy attacks. Each attack wave you survive without any hits, grants you a new bunker. Every time an enemy hits you, a bunker is destroyed. When the last bunker falls, the next enemy hit will destroy you and the game ends.",
- "reward_description": "### Rewards\n\nEach enemy you slay gives you points. The amount of points depends on the type of demon and which\nwave you are in. A detailed table of scores is provided on [the AtariAge\npage](https://atariage.com/manual_html_page.php?SoftwareLabelID=135).\n"
+ "reward_description": "Each enemy you slay gives you points. The amount of points depends on the type of demon and which wave you are in. A detailed table of scores is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=135)."
},
"donkey_kong": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=149",
@@ -147,7 +147,7 @@
"double_dunk": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=153",
"env_description": "You are playing a 2v2 game of basketball. At the start of each possession, you select between a set of different plays and then execute them to either score or prevent your rivals from scoring.",
- "reward_description": "### Rewards\n\nScores follow the rules of basketball. You can get either 3 points, 2 points foul line) depending\nfrom where you shoot. After a defensive foul, a successful shot from the foul line gives you 1\npoint.\n"
+ "reward_description": "Scores follow the rules of basketball. You can get either 3 points, 2 points foul line) depending from where you shoot. After a defensive foul, a successful shot from the foul line gives you 1 point."
},
"earthworld": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=541",
@@ -157,12 +157,12 @@
"elevator_action": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=1131",
"env_description": "You are a secret agent that must retrieve some secret documents and reach the ground level of a building by going down an elevator/stairs. Once you reach the ground level, you are picked up and taken to the next level. You are equipped with a gun to defend yourself against enemy agents waiting for you in each floor. You gather points by shooting down enemy agents and visiting apartments marked with a red door, which contain the secret documents.This is an unreleased prototype based on the arcade game.",
- "reward_description": "### Rewards\n\nYou start with 4 lives and are awarded 100 points for each enemy shot, and 500 points for each\nsecret document collected (visiting a red door). Each time you get shot you lose one life and the\ngame ends when losing all lives.\n"
+ "reward_description": "You start with 4 lives and are awarded 100 points for each enemy shot, and 500 points for each secret document collected (visiting a red door). Each time you get shot you lose one life and the game ends when losing all lives."
},
"enduro": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=163",
"env_description": "You are a racer in the National Enduro, a long-distance endurance race. You must overtake a certain amount of cars each day to stay on the race. The first day you need to pass 200 cars, and 300 foreach following day. The game ends if you do not meet your overtake quota for the day.",
- "reward_description": "### Rewards\n\nYou get 1 point for each vehicle you overtake.\n"
+ "reward_description": "You get 1 point for each vehicle you overtake."
},
"entombed": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=165",
@@ -177,7 +177,7 @@
"fishing_derby": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=182",
"env_description": "Your objective is to catch more sunfish than your opponent.",
- "reward_description": "### Rewards\n\nThe exact reward dynamics depend on the environment and are usually documented in the game's manual. You can\nfind these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=182).\n\nAtari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
+ "reward_description": "The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=182). Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
},
"flag_capture": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=183",
@@ -187,7 +187,7 @@
"freeway": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=192",
"env_description": "Your objective is to guide your chicken across lane after lane of busy rush hour traffic. You receive a point for every chicken that makes it to the top of the screen after crossing all the lanes of traffic.",
- "reward_description": "### Rewards\n\nThe exact reward dynamics depend on the environment and are usually documented in the game's manual. You can\nfind these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=192).\n\nAtari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
+ "reward_description": "The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=192)."
},
"frogger": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=194",
@@ -197,7 +197,7 @@
"frostbite": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=199",
"env_description": "In Frostbite, the player controls \"Frostbite Bailey\" who hops back and forth across across an Arctic river, changing the color of the ice blocks from white to blue. Each time he does so, a block is added to his igloo.",
- "reward_description": "### Rewards\n\nThe exact reward dynamics depend on the environment and are usually documented in the game's manual. You can\nfind these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=199).\n\nAtari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
+ "reward_description": "The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=199)."
},
"galaxian": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=202",
@@ -207,12 +207,12 @@
"gopher": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=218",
"env_description": "The player controls a shovel-wielding farmer who protects a crop of three carrots from a gopher.",
- "reward_description": "### Rewards\n\nThe exact reward dynamics depend on the environment and are usually documented in the game's manual. You can\nfind these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=218).\n\nAtari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
+ "reward_description": "The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=218)."
},
"gravitar": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=223",
"env_description": "The player controls a small blue spacecraft. The game starts in a fictional solar system with several planets to explore. If the player moves his ship into a planet, he will be taken to a side-view landscape.",
- "reward_description": "### Rewards\n\nThe exact reward dynamics depend on the environment and are usually documented in the game's manual. You can\nfind these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=223).\n\nAtari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1)."
+ "reward_description": "The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=223)."
},
"hangman": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=231",
@@ -227,7 +227,7 @@
"hero": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=228",
"env_description": "You need to rescue miners that are stuck in a mine shaft. You have access to various tools: A propeller backpack that allows you to fly wherever you want, sticks of dynamite that can be used to blast through walls, a laser beam to kill vermin, and a raft to float across stretches of lava.You have a limited amount of power. Once you run out, you lose a live.",
- "reward_description": "### Rewards\n\nYou score points for shooting critters, rescuing miners, and dynamiting walls.\nExtra points are rewarded for any power remaining after rescuing a miner.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228).\n"
+ "reward_description": "You score points for shooting critters, rescuing miners, and dynamiting walls. Extra points are rewarded for any power remaining after rescuing a miner. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228)."
},
"human_cannonball": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=238",
@@ -237,17 +237,17 @@
"ice_hockey": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=241",
"env_description": "Your goal is to score as many points as possible in a standard game of Ice Hockey over a 3-minute time period. The ball is usually called \"the puck\".There are 32 shot angles ranging from the extreme left to the extreme right. The angles can only aim towards the opponent's goal.Just as in real hockey, you can pass the puck by shooting it off the sides of the rink. This can be really key when you're in position to score a goal.",
- "reward_description": "### Rewards\n\nYou score points by shooting the puck into your opponent's goal. Your opponent scores in the same manner.\nThere are no limits to how many points you can get per game, other than the time limit of 3-minute games.\nFor a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=241).\n"
+ "reward_description": "You score points by shooting the puck into your opponent's goal. Your opponent scores in the same manner. There are no limits to how many points you can get per game, other than the time limit of 3-minute games. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=241)."
},
"jamesbond": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=250",
"env_description": "Your mission is to control Mr. Bond's specially designed multipurpose craft to complete a variety of missions.The craft moves forward with a right motion and slightly back with a left motion.An up or down motion causes the craft to jump or dive.You can also fire by either lobbing a bomb to the bottom of the screen or firing a fixed angle shot to the top of the screen.",
- "reward_description": "### Rewards\n\nThe game ends when you complete the last mission or when you lose the last craft. In either case, you'll receive your final score.\nThere will be a rating based on your score. The highest rating in NOVICE is 006. The highest rating in AGENT is 007.\nFor a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=250).\n"
+ "reward_description": "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. There will be a rating based on your score. The highest rating in NOVICE is 006. The highest rating in AGENT is 007. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=250)."
},
"journey_escape": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=252",
"env_description": "You must lead all 5 members of JOURNEY through waves of pesky characters and backstage obstacles to the Scarab Escape Vehicle before time runs out.You must also protect $50,000 in concert cash from grasping groupies, photographers, and promoters.",
- "reward_description": "### Rewards\n\nAt the start of the game, you will have $50,000 and 60 units of time.\nYour end game score with be dependent on how much time you have remaining and who you encounter along the way.\nFor a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=252).\n"
+ "reward_description": "At the start of the game, you will have $50,000 and 60 units of time. Your end game score with be dependent on how much time you have remaining and who you encounter along the way. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=252)."
},
"kaboom": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=257",
@@ -257,7 +257,7 @@
"kangaroo": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=923",
"env_description": "The object of the game is to score as many points as you can while controlling Mother Kangaroo to rescue her precious baby. You start the game with three lives.During this rescue mission, Mother Kangaroo encounters many obstacles. You need to help her climb ladders, pick bonus fruit, and throw punches at monkeys.",
- "reward_description": "### Rewards\n\nYour score will be shown at the top right corner of the game.\nYour end game score with be dependent on how much time you have remaining and who you encounter along the way.\nFor a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=923).\n"
+ "reward_description": "Your score will be shown at the top right corner of the game. Your end game score with be dependent on how much time you have remaining and who you encounter along the way. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=923)."
},
"keystone_kapers": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=261",
@@ -282,7 +282,7 @@
"krull": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=267",
"env_description": "Your mission is to find and enter the Beast's Black Fortress, rescue Princess Lyssa, and destroy the Beast.The task is not an easy one, for the location of the Black Fortress changes with each sunrise on Krull.",
- "reward_description": "### Rewards\n\nYou will receive various scores for each monster you kill.\nYou can play the game until you have lost all your lives.\nFor a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=267).\n"
+ "reward_description": "You will receive various scores for each monster you kill. You can play the game until you have lost all your lives. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=267)."
},
"kung_fu_master": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=268",
@@ -291,7 +291,7 @@
},
"laser_gates": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=271",
- "env_description": "The Cryptic Computer is malfunctioning! Use your Dante Dart to navigate through the computer and deestroy the four Failsafe Detonators.",
+ "env_description": "The Cryptic Computer is malfunctioning! Use your Dante Dart to navigate through the computer and destroy the four Failsafe Detonators.",
"reward_description": ""
},
"lost_luggage": {
@@ -347,7 +347,7 @@
"pitfall": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=360",
"env_description": "You control Pitfall Harry and are tasked with collecting all the treasures in a jungle within 20 minutes. You have three lives. The game is over if you collect all the treasures or if you die or if the time runs out.",
- "reward_description": "### Rewards\n\nYou get score points for collecting treasure, you lose points through some misfortunes like falling down a hole.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=360).\n"
+ "reward_description": "You get score points for collecting treasure, you lose points through some misfortunes like falling down a hole. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=360)."
},
"pitfall2": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=359",
@@ -357,42 +357,42 @@
"pong": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=587",
"env_description": "You control the right paddle, you compete against the left paddle controlled by the computer. You each try to keep deflecting the ball away from your goal and into your opponent's goal.",
- "reward_description": "### Rewards\n\nYou get score points for getting the ball to pass the opponent's paddle. You lose points if the ball passes your paddle.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=587).\n"
+ "reward_description": "You get score points for getting the ball to pass the opponent's paddle. You lose points if the ball passes your paddle. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=587)."
},
"pooyan": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=372",
"env_description": "You are a mother pig protecting her piglets (Pooyans) from wolves. In the first scene, you can move up and down a rope. Try to shoot the worker's balloons, while guarding yourself from attacks. If the wolves reach the ground safely they will get behind and try to eat you. In the second scene, the wolves try to float up. You have to try and stop them using arrows and bait. You die if a wolf eats you, or a stone or rock hits you.",
- "reward_description": "### Rewards\n\nIf you hit a balloon, wolf or stone with an arrow you score points.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=372).\n"
+ "reward_description": "If you hit a balloon, wolf or stone with an arrow you score points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=372)."
},
"private_eye": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=376",
"env_description": "You control the French Private Eye Pierre Touche. Navigate the city streets, parks, secret passages, dead-ends and one-ways in search of the ringleader, Henri Le Fiend and his gang. You also need to find evidence and stolen goods that are scattered about. There are five cases, complete each case before its statute of limitations expires.",
- "reward_description": "### Rewards\n\nYou 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.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=376).\n"
+ "reward_description": "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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=376)."
},
"qbert": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareID=1224",
"env_description": "You are Q*bert. Your goal is to change the color of all the cubes on the pyramid to the pyramid's 'destination' color. To do this, you must hop on each cube on the pyramid one at a time while avoiding nasty creatures that lurk there.",
- "reward_description": "### Rewards\n\nYou score points for changing color of the cubes to their destination colors or by defeating enemies. You also gain points for completing a level.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=1224&itemTypeID=HTMLMANUAL).\n"
+ "reward_description": "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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=1224&itemTypeID=HTMLMANUAL)."
},
"riverraid": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=409",
"env_description": "You control a jet that flies over a river: you can move it sideways and fire missiles to destroy enemy objects. Each time an enemy object is destroyed you score points (i.e. rewards).You lose a jet when you run out of fuel: fly over a fuel depot when you begin to run low.You lose a jet even when it collides with the river bank or one of the enemy objects (except fuel depots).The game begins with a squadron of three jets in reserve and you're given an additional jet (up to 9) for each 10,000 points you score.",
- "reward_description": "### Rewards\n\nScore points are your only reward. You get score points each time you destroy an enemy object:\n\n| Enemy Object | Score Points |\n|--------------|--------------|\n| Tanker | 30 |\n| Helicopter | 60 |\n| Fuel Depot | 80 |\n| Jet | 100 |\n| Bridge | 500 |\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=409).\n"
+ "reward_description": "Score points are your only reward. You get score points each time you destroy an enemy object: \n\n| Enemy Object | Score Points |\n|--------------|--------------|\n| Tanker | 30 |\n| Helicopter | 60 |\n| Fuel Depot | 80 |\n| Jet | 100 |\n| Bridge | 500 |\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=409)."
},
"road_runner": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=412",
"env_description": "You control the Road Runner(TM) in a race; you can control the direction to run in and times to jumps.The goal is to outrun Wile E. Coyote(TM) while avoiding the hazards of the desert.The game begins with three lives. You lose a life when the coyote catches you, picks you up in a rocket, or shoots you with a cannon. You also lose a life when a truck hits you, you hit a land mine, you fall off a cliff,or you get hit by a falling rock.You score points (i.e. rewards) by eating seeds along the road, eating steel shot, and destroying the coyote.",
- "reward_description": "### Rewards\n\nScore points are your only reward. You get score points each time you:\n\n| actions | points |\n|-------------------------------------------------------|--------|\n| eat a pile of birdseed | 100 |\n| eat steel shot | 100 |\n| get the coyote hit by a mine (cannonball, rock, etc.) | 200 |\n| get the coyote hit by a truck | 1000 |\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=412).\n"
+ "reward_description": "Score points are your only reward. You get score points each time you:\n\n| actions | points |\n|-------------------------------------------------------|--------|\n| eat a pile of birdseed | 100 |\n| eat steel shot | 100 |\n| get the coyote hit by a mine (cannonball, rock, etc.) | 200 |\n| get the coyote hit by a truck | 1000 |\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=412)."
},
"robotank": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=416",
"env_description": "You control your Robot Tanks to destroy enemies and avoid enemy fire.Game ends when all of your Robot Tanks are destroyed or all 12 enemy squadrons are destroyed.The game begins with one active Robot Tank and three reserves.Your Robot Tank may get lost when it is hit by enemy rocket fire - your video scrambles with static interference when this happens - or just become damaged - sensors report the damage by flashing on your control panel (look at V/C/R/T squares).You earn one bonus Robot Tank for every enemy squadron destroyed. The maximum number of bonus Robot Tanks allowed at any one time is 12.",
- "reward_description": "### Rewards\n\nThe number of enemies destroyed is the only reward.\n\nA small tank appears at the top of your screen for each enemy\n you destroy. A square with the number 12 appears each time a squadron of twelve enemies are\n destroyed.\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=416).\n"
+ "reward_description": "The number of enemies destroyed is the only reward. A small tank appears at the top of your screen for each enemy you destroy. A square with the number 12 appears each time a squadron of twelve enemies are destroyed. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=416)."
},
"seaquest": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=424",
"env_description": "You control a sub able to move in all directions and fire torpedoes.The goal is to retrieve as many divers as you can, while dodging and blasting enemy subs and killer sharks; points will be awarded accordingly.The game begins with one sub and three waiting on the horizon. Each time you increase your score by 10,000 points, an extra sub will be delivered to yourbase. You can only have six reserve subs on the screen at one time.Your sub will explode if it collides with anything except your own divers.The sub has a limited amount of oxygen that decreases at a constant rate during the game. When the oxygen tank is almost empty, you need to surface and if you don't do it in time, your sub will blow up and you'll lose one diver. Each time you're forced to surface, with less than six divers, you lose one diver as well.",
- "reward_description": "### Rewards\n\nScore points are your only reward.\n\nBlasting enemy sub and killer shark is worth\n20 points. Every time you surface with six divers, the value of enemy subs\nand killer sharks increases by 10, up to a maximum of 90 points each.\n\nRescued divers start at 50 points each. Then, their point value increases by 50, every\ntime you surface, up to a maximum of 1000 points each.\n\nYou'll be further rewarded with bonus points for all the oxygen you have remaining the\nmoment you surface. The more oxygen you have left, the more bonus points\nyou're given.\n\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=424).\n"
+ "reward_description": "Score points are your only reward. Blasting enemy sub and killer shark is worth 20 points. Every time you surface with six divers, the value of enemy subs and killer sharks increases by 10, up to a maximum of 90 points each. Rescued divers start at 50 points each. Then, their point value increases by 50, every time you surface, up to a maximum of 1000 points each. You'll be further rewarded with bonus points for all the oxygen you have remaining the moment you surface. The more oxygen you have left, the more bonus points you're given. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=424)."
},
"sir_lancelot": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=431",
@@ -402,17 +402,17 @@
"skiing": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=434",
"env_description": "You control a skier who can move sideways.The goal is to run through all gates (between the poles) in the fastest time.You are penalized five seconds for each gate you miss.If you hit a gate or a tree, your skier will jump back up and keep going.",
- "reward_description": "### Rewards\n\nSeconds are your only rewards - negative rewards and penalties (e.g. missing a gate) are assigned as additional seconds.\n\nFor a more detailed documentation, see [the AtariAge page [SLALOM RACING section]](https://atariage.com/manual_html_page.php?SoftwareLabelID=434).\n"
+ "reward_description": "Seconds are your only rewards - negative rewards and penalties (e.g. missing a gate) are assigned as additional seconds. For a more detailed documentation, see [the AtariAge page [SLALOM RACING section]](https://atariage.com/manual_html_page.php?SoftwareLabelID=434)."
},
"solaris": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=450",
"env_description": "You control a spaceship. Blast enemies before they can blast you. You can warp to different sectors. You have to defend Federation planets, and destroy Zylon forces. Keep track of your fuel, if you run out you lose a life. Warp to a Federation planet to refuel. The game ends if all your ships are destroyed or if you reach the Solaris planet.",
- "reward_description": "### Rewards\n\nYou gain points for destroying enemies, rescuing cadets, making it through a corridor, destroying enemy planets etc.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=450).\n"
+ "reward_description": "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)."
},
"space_invaders": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=460",
"env_description": "Your objective is to destroy the space invaders by shooting your laser cannon at them before they reach the Earth. The game ends when all your lives are lost after taking enemy fire, or when they reach the earth.",
- "reward_description": "### Rewards\n\nYou gain points for destroying space invaders. The invaders in the back rows are worth more points.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=460).\n"
+ "reward_description": "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)."
},
"space_war": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=470",
@@ -422,7 +422,7 @@
"star_gunner": {
"atariage_url": "http://www.atarimania.com/game-atari-2600-vcs-stargunner_16921.html",
"env_description": "Stop the alien invasion by shooting down alien saucers and creatures while avoiding bombs.",
- "reward_description": "### Rewards\n\nYou score points for destroying enemies. You get bonus points for clearing a wave and a level.\nFor a more detailed documentation, see [the Atari Mania page](http://www.atarimania.com/game-atari-2600-vcs-stargunner_16921.html).\n"
+ "reward_description": "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)."
},
"superman": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=533",
@@ -437,7 +437,7 @@
"tennis": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=555",
"env_description": "You control the orange player playing against a computer-controlled blue player. The game follows the rules of tennis.The first player to win at least 6 games with a margin of at least two games wins the match. If the score is tied at 6-6, the first player to go 2 games up wins the match.",
- "reward_description": "### Rewards\n\nThe scoring is as per the sport of tennis, played till one set.\nFor a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=555).\n"
+ "reward_description": "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)."
},
"tetris": {
"atariage_url": "",
@@ -452,7 +452,7 @@
"time_pilot": {
"atariage_url": "http://www.atarimania.com/game-atari-2600-vcs-time-pilot_8038.html",
"env_description": "You control an aircraft. Use it to destroy your enemies. As you progress in the game, you encounter enemies with technology that is increasingly from the future.",
- "reward_description": "### Rewards\n\nYou score points for destroying enemies, gaining more points for difficult enemies.\nFor a more detailed documentation, see [the Atari Mania page](http://www.atarimania.com/game-atari-2600-vcs-time-pilot_8038.html).\n"
+ "reward_description": "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)."
},
"trondead": {
"atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=569",
diff --git a/docs/_scripts/gen_environment_page.py b/docs/_scripts/gen_environment_page.py
new file mode 100644
index 000000000..2cc84c901
--- /dev/null
+++ b/docs/_scripts/gen_environment_page.py
@@ -0,0 +1,77 @@
+import itertools
+
+import ale_py
+import gymnasium
+import tabulate
+from ale_py.registration import _rom_id_to_name
+from tqdm import tqdm
+
+gymnasium.register_envs(ale_py)
+
+impossible_roms = {"maze_craze", "joust", "warlords", "combat"}
+ALL_ATARI_GAMES = {
+ env_spec.kwargs["game"]
+ for env_spec in gymnasium.registry.values()
+ if isinstance(env_spec.entry_point, str)
+ and "ale_py" in env_spec.entry_point
+ and env_spec.kwargs["game"] not in impossible_roms
+}
+
+# Generate the list of all atari games on atari.md
+for rom_id in sorted(ALL_ATARI_GAMES):
+ print(f"atari/{rom_id}")
+
+
+def generate_value_ranges(values):
+ for a, b in itertools.groupby(enumerate(values), lambda pair: pair[1] - pair[0]):
+ b = list(b)
+ yield b[0][1], b[-1][1]
+
+
+def shortened_repr(values):
+ output = []
+ for low, high in generate_value_ranges(values):
+ if high - low < 5:
+ output.append(", ".join(map(str, range(low, high + 1))))
+ else:
+ output.append(f"{low}, ..., {high}")
+ return "[" + ", ".join(output) + "]"
+
+
+# # Generate difficult levels table on atari.md
+headers = [
+ "Environment",
+ "Possible Modes",
+ "Default Mode",
+ "Possible Difficulties",
+ "Default Difficulty",
+]
+rows = []
+
+for rom_id in tqdm(ALL_ATARI_GAMES):
+ env_name = _rom_id_to_name(rom_id)
+
+ env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped
+
+ available_difficulties = env.ale.getAvailableDifficulties()
+ default_difficulty = env.ale.cloneState().getDifficulty()
+ available_modes = env.ale.getAvailableModes()
+ default_mode = env.ale.cloneState().getCurrentMode()
+
+ if env_name == "VideoCube":
+ available_modes = "[0, 1, 2, 100, 101, 102, ..., 5000, 5001, 5002]"
+ else:
+ available_modes = shortened_repr(available_modes)
+
+ rows.append(
+ [
+ env_name,
+ available_modes,
+ default_mode,
+ shortened_repr(available_difficulties),
+ default_difficulty,
+ ]
+ )
+ env.close()
+
+print(tabulate.tabulate(rows, headers=headers, tablefmt="github"))
diff --git a/docs/_scripts/gen_environments_md.py b/docs/_scripts/gen_environments_md.py
index b3ac5ed34..a1dd02d87 100644
--- a/docs/_scripts/gen_environments_md.py
+++ b/docs/_scripts/gen_environments_md.py
@@ -18,10 +18,6 @@
and env_spec.kwargs["game"] not in impossible_roms
}
-# Generate the list of all atari games on atari.md
-for rom_id in sorted(ALL_ATARI_GAMES):
- print(f"atari/{rom_id}")
-
def generate_value_ranges(values):
for a, b in itertools.groupby(enumerate(values), lambda pair: pair[1] - pair[0]):
@@ -39,83 +35,40 @@ def shortened_repr(values):
return "[" + ", ".join(output) + "]"
-# # Test examples
-# print(shortened_repr([0]))
-# print(shortened_repr([1, 2, 3]))
-# print(shortened_repr([0, 1, 2, 3]))
-# print(shortened_repr([0, 4, 8, 12, 16, 20, 24, 28]))
-# print(shortened_repr(list(range(32)) + [128]))
-
-
-# # Generate difficult levels table on atari.md
-headers = [
- "Environment",
- "Possible Modes",
- "Default Mode",
- "Possible Difficulties",
- "Default Difficulty",
-]
-rows = []
-
-for rom_id in tqdm(ALL_ATARI_GAMES):
- env_name = _rom_id_to_name(rom_id)
-
- env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped
-
- available_difficulties = env.ale.getAvailableDifficulties()
- default_difficulty = env.ale.cloneState().getDifficulty()
- available_modes = env.ale.getAvailableModes()
- default_mode = env.ale.cloneState().getCurrentMode()
-
- if env_name == "VideoCube":
- available_modes = "[0, 1, 2, 100, 101, 102, ..., 5000, 5001, 5002]"
- else:
- available_modes = shortened_repr(available_modes)
-
- rows.append(
- [
- env_name,
- available_modes,
- default_mode,
- shortened_repr(available_difficulties),
- default_difficulty,
- ]
- )
- env.close()
-
-print(tabulate.tabulate(rows, headers=headers, tablefmt="github"))
-
# Generate each pages results
-with open("atari-docs.json") as file:
+with open("environment-docs.json") as file:
atari_data = json.load(file)
for rom_id in tqdm(ALL_ATARI_GAMES):
env_name = _rom_id_to_name(rom_id)
env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped
- if rom_id in atari_data:
- env_data = atari_data[rom_id]
+ env_data = atari_data[rom_id]
- env_description = env_data["env_description"]
- if env_data["atariage_url"]:
- env_url = f"""
+ env_description = env_data["env_description"]
+
+ 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"]
else:
- # Add the information to `atari_docs.json` and rerun this file to generate the new documentation
- env_description = f"{env_name} is missing description documentation. If you are interested in writing up a description, please create an issue or PR with the information on the Gymnasium github."
env_url = ""
+
+ if env_data["reward_description"]:
+ reward_description = f"""
+### Reward
+
+{env_data["reward_description"]}
+"""
+ else:
reward_description = ""
- table_values = map(
+ action_table_values = map(
lambda s: f"`{s}`",
itertools.chain(*zip(range(env.action_space.n), env.get_action_meanings())),
)
default_action_table = tabulate.tabulate(
- list(itertools.zip_longest(*([iter(table_values)] * 6), fillvalue="")),
+ list(itertools.zip_longest(*([iter(action_table_values)] * 6), fillvalue="")),
headers=["Value", "Meaning", "Value", "Meaning", "Value", "Meaning"],
tablefmt="github",
)
@@ -176,6 +129,16 @@ def shortened_repr(values):
difficulty_mode_row, headers=difficulty_mode_header, tablefmt="github"
)
+ top_table = tabulate.tabulate(
+ [
+ ["Action Space", str(env.action_space)],
+ ["Observation Space", str(env.observation_space)],
+ ["Import", f'`gymnasium.make("{env.spec.id}")`'],
+ ],
+ headers=["", ""],
+ tablefmt="github",
+ )
+
env.close()
TEMPLATE = f"""---
@@ -184,18 +147,14 @@ def shortened_repr(values):
# {env_name}
-```{{figure}} ../../_static/videos/atari/{rom_id}.gif
+```{{figure}} ../_static/videos/environments/{rom_id}.gif
:width: 120px
:name: {env_name}
```
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | {env.action_space} |
-| Observation Space | {env.observation_space} |
-| Import | `gymnasium.make("{env.spec.id}")` |
+{top_table}
For more {env_name} variants with different observation and action spaces, see the variants section.
@@ -213,16 +172,14 @@ def shortened_repr(values):
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
{reward_description}
-
## Variants
{env_name} has the following variants of the environment id which have the following differences in observation,
@@ -246,5 +203,5 @@ def shortened_repr(values):
* v4: Stickiness of actions was removed
* v0: Initial versions release
"""
- with open(f"../environments/atari/{rom_id}.md", "w") as file:
+ with open(f"../environments/{rom_id}.md", "w") as file:
file.write(TEMPLATE)
diff --git a/docs/environments/adventure.md b/docs/environments/adventure.md
index e98d489fe..ec4bde66e 100644
--- a/docs/environments/adventure.md
+++ b/docs/environments/adventure.md
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Adventure has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/air_raid.md b/docs/environments/air_raid.md
index ca44d69a7..c99f4051e 100644
--- a/docs/environments/air_raid.md
+++ b/docs/environments/air_raid.md
@@ -38,15 +38,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
AirRaid has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/alien.md b/docs/environments/alien.md
index 2f0590d19..786995c02 100644
--- a/docs/environments/alien.md
+++ b/docs/environments/alien.md
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught
-by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a
-table of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).
+You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a table of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).
## Variants
diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md
index 5d90d356c..aa61a3e4d 100644
--- a/docs/environments/amidar.md
+++ b/docs/environments/amidar.md
@@ -11,11 +11,11 @@ title: Amidar
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(10) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Amidar-v5")` |
+| Import | `gymnasium.make("ALE/Amidar-v5")` |
For more Amidar variants with different observation and action spaces, see the variants section.
@@ -42,18 +42,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).
+You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).
## Variants
diff --git a/docs/environments/assault.md b/docs/environments/assault.md
index 950c9086e..02f101a62 100644
--- a/docs/environments/assault.md
+++ b/docs/environments/assault.md
@@ -11,11 +11,11 @@ title: Assault
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(7) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Assault-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(7) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Assault has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/asterix.md b/docs/environments/asterix.md
index a54b7eb7b..6b853aee5 100644
--- a/docs/environments/asterix.md
+++ b/docs/environments/asterix.md
@@ -11,11 +11,11 @@ title: Asterix
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Asterix-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,15 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
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/asteroids.md b/docs/environments/asteroids.md
index 60e509514..8af07b4de 100644
--- a/docs/environments/asteroids.md
+++ b/docs/environments/asteroids.md
@@ -11,11 +11,11 @@ title: Asteroids
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(14) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Asteroids-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(14) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score
-for destroying it.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).
+You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score for destroying it. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).
## Variants
diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md
index a58ed9f1c..45ca3c58f 100644
--- a/docs/environments/atlantis.md
+++ b/docs/environments/atlantis.md
@@ -11,11 +11,11 @@ title: Atlantis
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Atlantis-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(4) |
+| 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.
@@ -40,19 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for destroying enemies, keeping installations protected during attack waves. You score more points
-if you manage to destroy your enemies with one of the outer defense posts.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
+You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
## Variants
diff --git a/docs/environments/atlantis2.md b/docs/environments/atlantis2.md
index b9f463f52..92e5c3e5e 100644
--- a/docs/environments/atlantis2.md
+++ b/docs/environments/atlantis2.md
@@ -11,17 +11,19 @@ title: Atlantis2
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Atlantis2-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(4) |
+| 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.
## Description
-Atlantis2 is missing description documentation. If you are interested in writing up a description, please create an issue or PR with the information on the Gymnasium github.
+Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts.You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.
+
+For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)
## Actions
@@ -38,14 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
+### Reward
+
+You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
## Variants
diff --git a/docs/environments/backgammon.md b/docs/environments/backgammon.md
index b73a16445..e7eb8acf2 100644
--- a/docs/environments/backgammon.md
+++ b/docs/environments/backgammon.md
@@ -11,11 +11,11 @@ title: Backgammon
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(3) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Backgammon-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(3) |
+| 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.
@@ -39,15 +39,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Backgammon has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/bank_heist.md b/docs/environments/bank_heist.md
index b29ada37b..9863fc405 100644
--- a/docs/environments/bank_heist.md
+++ b/docs/environments/bank_heist.md
@@ -11,11 +11,11 @@ title: BankHeist
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/BankHeist-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city,
-you will score extra points.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).
+You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city, you will score extra points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).
## Variants
diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md
index 65271b72f..5d598d32d 100644
--- a/docs/environments/basic_math.md
+++ b/docs/environments/basic_math.md
@@ -11,18 +11,17 @@ title: BasicMath
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/BasicMath-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
## Description
-You must solve basic math problems using a joystick
-to scroll to the correct numeric answer.
+You must solve basic math problems using a joystick to scroll to the correct numeric answer.
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=14)
@@ -41,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
BasicMath has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/battle_zone.md b/docs/environments/battle_zone.md
index a006a3594..995f7cc08 100644
--- a/docs/environments/battle_zone.md
+++ b/docs/environments/battle_zone.md
@@ -11,11 +11,11 @@ title: BattleZone
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/BattleZone-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You receive points for destroying enemies.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).
+You receive points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).
## Variants
diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md
index eb282790b..14c1b71a8 100644
--- a/docs/environments/beam_rider.md
+++ b/docs/environments/beam_rider.md
@@ -11,11 +11,11 @@ title: BeamRider
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/BeamRider-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,18 +41,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for destroying enemies.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).
+You score points for destroying enemies. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).
## Variants
diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md
index 9977ef9bd..57e64531c 100644
--- a/docs/environments/berzerk.md
+++ b/docs/environments/berzerk.md
@@ -11,11 +11,11 @@ title: Berzerk
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Berzerk-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for destroying robots.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).
+You score points for destroying robots. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).
## Variants
diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md
index 1af52e499..aa27c5dd3 100644
--- a/docs/environments/blackjack.md
+++ b/docs/environments/blackjack.md
@@ -11,11 +11,11 @@ title: Blackjack
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Blackjack-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(4) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Blackjack has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/bowling.md b/docs/environments/bowling.md
index b6c95b285..85b16fed8 100644
--- a/docs/environments/bowling.md
+++ b/docs/environments/bowling.md
@@ -11,11 +11,11 @@ title: Bowling
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Bowling-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,20 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open"
-frame. Moreover, the points you score for one frame may depend on following frames.
-You can score up to 300 points in one game (if you manage to do 12 strikes).
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).
+You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open" frame. Moreover, the points you score for one frame may depend on following frames. You can score up to 300 points in one game (if you manage to do 12 strikes). For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).
## Variants
diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md
index 4116d977c..aa173c698 100644
--- a/docs/environments/boxing.md
+++ b/docs/environments/boxing.md
@@ -11,11 +11,11 @@ title: Boxing
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Boxing-v5")` |
+| Import | `gymnasium.make("ALE/Boxing-v5")` |
For more Boxing variants with different observation and action spaces, see the variants section.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by landing punches.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).
+You score points by landing punches. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).
## Variants
diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md
index 59d629e6a..aca36c90d 100644
--- a/docs/environments/breakout.md
+++ b/docs/environments/breakout.md
@@ -11,11 +11,11 @@ title: Breakout
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Breakout-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(4) |
+| 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.
@@ -40,18 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).
+You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).
## Variants
diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md
index 8736f75de..602d6786c 100644
--- a/docs/environments/carnival.md
+++ b/docs/environments/carnival.md
@@ -11,11 +11,11 @@ title: Carnival
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (214, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Carnival-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,19 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign.
-You will score extra points if it shows a plus sign!
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).
+You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign. You will score extra points if it shows a plus sign! For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).
## Variants
diff --git a/docs/environments/casino.md b/docs/environments/casino.md
index b43f782aa..955ecd15c 100644
--- a/docs/environments/casino.md
+++ b/docs/environments/casino.md
@@ -11,11 +11,11 @@ title: Casino
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(4) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Casino-v5")` |
+| Import | `gymnasium.make("ALE/Casino-v5")` |
For more Casino variants with different observation and action spaces, see the variants section.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Casino has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/centipede.md b/docs/environments/centipede.md
index c46e84aeb..a300345ac 100644
--- a/docs/environments/centipede.md
+++ b/docs/environments/centipede.md
@@ -11,11 +11,11 @@ title: Centipede
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Centipede-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round
-(i.e. after you have lost a wand) for mushrooms that were not destroyed.
-Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).
+You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round (i.e. after you have lost a wand) for mushrooms that were not destroyed. Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).
## Variants
diff --git a/docs/environments/chopper_command.md b/docs/environments/chopper_command.md
index 033cbeb3d..2e3f7d50e 100644
--- a/docs/environments/chopper_command.md
+++ b/docs/environments/chopper_command.md
@@ -11,11 +11,11 @@ title: ChopperCommand
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/ChopperCommand-v5")` |
+| | |
+|-------------------|-------------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by destroying planes and other helicopters. You score extra points at the end of every wave, depending on the number
-of trucks that have survived.
-Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=921).
+You score points by destroying planes and other helicopters. You score extra points at the end of every wave, depending on the number of trucks that have survived. Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=921).
## Variants
diff --git a/docs/environments/crazy_climber.md b/docs/environments/crazy_climber.md
index bac52d24c..110261818 100644
--- a/docs/environments/crazy_climber.md
+++ b/docs/environments/crazy_climber.md
@@ -11,11 +11,11 @@ title: CrazyClimber
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/CrazyClimber-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,15 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
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/crossbow.md b/docs/environments/crossbow.md
index 701124b72..1f0d9f982 100644
--- a/docs/environments/crossbow.md
+++ b/docs/environments/crossbow.md
@@ -11,11 +11,11 @@ title: Crossbow
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Crossbow-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Crossbow has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/darkchambers.md b/docs/environments/darkchambers.md
index cb1974cb5..deaefdc0a 100644
--- a/docs/environments/darkchambers.md
+++ b/docs/environments/darkchambers.md
@@ -11,11 +11,11 @@ title: Darkchambers
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Darkchambers-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Darkchambers has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/defender.md b/docs/environments/defender.md
index 611faf013..9e026037b 100644
--- a/docs/environments/defender.md
+++ b/docs/environments/defender.md
@@ -11,11 +11,11 @@ title: Defender
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Defender-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You receive points for destroying enemies, rescuing abducted humans and keeping humans alive.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=128).
+You receive points for destroying enemies, rescuing abducted humans and keeping humans alive. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=128).
## Variants
diff --git a/docs/environments/demon_attack.md b/docs/environments/demon_attack.md
index bc213e027..187f40506 100644
--- a/docs/environments/demon_attack.md
+++ b/docs/environments/demon_attack.md
@@ -11,11 +11,11 @@ title: DemonAttack
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/DemonAttack-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,19 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-Each enemy you slay gives you points. The amount of points depends on the type of demon and which
-wave you are in. A detailed table of scores is provided on [the AtariAge
-page](https://atariage.com/manual_html_page.php?SoftwareLabelID=135).
+Each enemy you slay gives you points. The amount of points depends on the type of demon and which wave you are in. A detailed table of scores is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=135).
## Variants
diff --git a/docs/environments/donkey_kong.md b/docs/environments/donkey_kong.md
index df8393507..08d6ac5e8 100644
--- a/docs/environments/donkey_kong.md
+++ b/docs/environments/donkey_kong.md
@@ -11,11 +11,11 @@ title: DonkeyKong
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/DonkeyKong-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
DonkeyKong has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/double_dunk.md b/docs/environments/double_dunk.md
index 4a224cb21..0743b7c33 100644
--- a/docs/environments/double_dunk.md
+++ b/docs/environments/double_dunk.md
@@ -11,11 +11,11 @@ title: DoubleDunk
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/DoubleDunk-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-Scores follow the rules of basketball. You can get either 3 points, 2 points foul line) depending
-from where you shoot. After a defensive foul, a successful shot from the foul line gives you 1
-point.
+Scores follow the rules of basketball. You can get either 3 points, 2 points foul line) depending from where you shoot. After a defensive foul, a successful shot from the foul line gives you 1 point.
## Variants
diff --git a/docs/environments/earthworld.md b/docs/environments/earthworld.md
index c64f2caec..9eb716e49 100644
--- a/docs/environments/earthworld.md
+++ b/docs/environments/earthworld.md
@@ -11,11 +11,11 @@ title: Earthworld
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Earthworld-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Earthworld has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/elevator_action.md b/docs/environments/elevator_action.md
index bef8673b3..782ad8d15 100644
--- a/docs/environments/elevator_action.md
+++ b/docs/environments/elevator_action.md
@@ -11,11 +11,11 @@ title: ElevatorAction
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/ElevatorAction-v5")` |
+| | |
+|-------------------|-------------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You start with 4 lives and are awarded 100 points for each enemy shot, and 500 points for each
-secret document collected (visiting a red door). Each time you get shot you lose one life and the
-game ends when losing all lives.
+You start with 4 lives and are awarded 100 points for each enemy shot, and 500 points for each secret document collected (visiting a red door). Each time you get shot you lose one life and the game ends when losing all lives.
## Variants
diff --git a/docs/environments/enduro.md b/docs/environments/enduro.md
index 39316d6d1..aa47427a1 100644
--- a/docs/environments/enduro.md
+++ b/docs/environments/enduro.md
@@ -11,11 +11,11 @@ title: Enduro
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(9) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Enduro-v5")` |
+| Import | `gymnasium.make("ALE/Enduro-v5")` |
For more Enduro variants with different observation and action spaces, see the variants section.
@@ -41,15 +41,15 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
You get 1 point for each vehicle you overtake.
diff --git a/docs/environments/entombed.md b/docs/environments/entombed.md
index 7ecc53241..8c93634c8 100644
--- a/docs/environments/entombed.md
+++ b/docs/environments/entombed.md
@@ -11,11 +11,11 @@ title: Entombed
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Entombed-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Entombed has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/et.md b/docs/environments/et.md
index a1e15a127..28d0d5119 100644
--- a/docs/environments/et.md
+++ b/docs/environments/et.md
@@ -11,11 +11,11 @@ title: Et
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Et-v5")` |
+| Import | `gymnasium.make("ALE/Et-v5")` |
For more Et variants with different observation and action spaces, see the variants section.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Et has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/fishing_derby.md b/docs/environments/fishing_derby.md
index d5080d0d9..79f2321a5 100644
--- a/docs/environments/fishing_derby.md
+++ b/docs/environments/fishing_derby.md
@@ -11,11 +11,11 @@ title: FishingDerby
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/FishingDerby-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can
-find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=182).
+The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=182). Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1).
## Variants
diff --git a/docs/environments/flag_capture.md b/docs/environments/flag_capture.md
index ac84372c6..5ef4ec920 100644
--- a/docs/environments/flag_capture.md
+++ b/docs/environments/flag_capture.md
@@ -11,11 +11,11 @@ title: FlagCapture
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/FlagCapture-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
FlagCapture has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/freeway.md b/docs/environments/freeway.md
index e975d8240..972bd05e7 100644
--- a/docs/environments/freeway.md
+++ b/docs/environments/freeway.md
@@ -11,11 +11,11 @@ title: Freeway
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(3) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Freeway-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(3) |
+| 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.
@@ -39,18 +39,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can
-find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=192).
+The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=192).
## Variants
diff --git a/docs/environments/frogger.md b/docs/environments/frogger.md
index 18404c2b5..cfdab505b 100644
--- a/docs/environments/frogger.md
+++ b/docs/environments/frogger.md
@@ -11,11 +11,11 @@ title: Frogger
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(5) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Frogger-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(5) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Frogger has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/frostbite.md b/docs/environments/frostbite.md
index daa30f120..d214637cf 100644
--- a/docs/environments/frostbite.md
+++ b/docs/environments/frostbite.md
@@ -11,11 +11,11 @@ title: Frostbite
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Frostbite-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can
-find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=199).
+The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=199).
## Variants
diff --git a/docs/environments/galaxian.md b/docs/environments/galaxian.md
index e82c66540..43a71e1c1 100644
--- a/docs/environments/galaxian.md
+++ b/docs/environments/galaxian.md
@@ -11,11 +11,11 @@ title: Galaxian
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Galaxian-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Galaxian has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/gopher.md b/docs/environments/gopher.md
index 0d6d4624c..17c308613 100644
--- a/docs/environments/gopher.md
+++ b/docs/environments/gopher.md
@@ -11,11 +11,11 @@ title: Gopher
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(8) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(8) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Gopher-v5")` |
+| Import | `gymnasium.make("ALE/Gopher-v5")` |
For more Gopher variants with different observation and action spaces, see the variants section.
@@ -41,18 +41,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can
-find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=218).
+The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=218).
## Variants
diff --git a/docs/environments/gravitar.md b/docs/environments/gravitar.md
index f30091132..e8dc39570 100644
--- a/docs/environments/gravitar.md
+++ b/docs/environments/gravitar.md
@@ -11,11 +11,11 @@ title: Gravitar
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Gravitar-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can
-find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=223).
+The exact reward dynamics depend on the environment and are usually documented in the game's manual. You can find these manuals on [AtariAge](https://atariage.com/manual_html_page.php?SoftwareLabelID=223).
## Variants
diff --git a/docs/environments/hangman.md b/docs/environments/hangman.md
index b0fbd349e..388c35d6c 100644
--- a/docs/environments/hangman.md
+++ b/docs/environments/hangman.md
@@ -11,11 +11,11 @@ title: Hangman
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Hangman-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Hangman has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/haunted_house.md b/docs/environments/haunted_house.md
index 4f8b137d6..a0ac85a44 100644
--- a/docs/environments/haunted_house.md
+++ b/docs/environments/haunted_house.md
@@ -11,11 +11,11 @@ title: HauntedHouse
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/HauntedHouse-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
HauntedHouse has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/hero.md b/docs/environments/hero.md
index 4787c2ef3..ef31dd76f 100644
--- a/docs/environments/hero.md
+++ b/docs/environments/hero.md
@@ -11,11 +11,11 @@ title: Hero
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Hero-v5")` |
+| Import | `gymnasium.make("ALE/Hero-v5")` |
For more Hero variants with different observation and action spaces, see the variants section.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points for shooting critters, rescuing miners, and dynamiting walls.
-Extra points are rewarded for any power remaining after rescuing a miner.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228).
+You score points for shooting critters, rescuing miners, and dynamiting walls. Extra points are rewarded for any power remaining after rescuing a miner. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228).
## Variants
diff --git a/docs/environments/human_cannonball.md b/docs/environments/human_cannonball.md
index 79dcae822..f57ed85dc 100644
--- a/docs/environments/human_cannonball.md
+++ b/docs/environments/human_cannonball.md
@@ -11,11 +11,11 @@ title: HumanCannonball
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/HumanCannonball-v5")` |
+| | |
+|-------------------|--------------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
HumanCannonball has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/ice_hockey.md b/docs/environments/ice_hockey.md
index 041ba6979..c9958f429 100644
--- a/docs/environments/ice_hockey.md
+++ b/docs/environments/ice_hockey.md
@@ -11,11 +11,11 @@ title: IceHockey
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/IceHockey-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You score points by shooting the puck into your opponent's goal. Your opponent scores in the same manner.
-There are no limits to how many points you can get per game, other than the time limit of 3-minute games.
-For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=241).
+You score points by shooting the puck into your opponent's goal. Your opponent scores in the same manner. There are no limits to how many points you can get per game, other than the time limit of 3-minute games. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=241).
## Variants
diff --git a/docs/environments/jamesbond.md b/docs/environments/jamesbond.md
index cf254d77c..95bb74ec4 100644
--- a/docs/environments/jamesbond.md
+++ b/docs/environments/jamesbond.md
@@ -11,11 +11,11 @@ title: Jamesbond
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Jamesbond-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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.
-There will be a rating based on your score. The highest rating in NOVICE is 006. The highest rating in AGENT is 007.
-For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=250).
+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. There will be a rating based on your score. The highest rating in NOVICE is 006. The highest rating in AGENT is 007. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=250).
## Variants
diff --git a/docs/environments/journey_escape.md b/docs/environments/journey_escape.md
index 3a06e57a1..2dda072d5 100644
--- a/docs/environments/journey_escape.md
+++ b/docs/environments/journey_escape.md
@@ -11,11 +11,11 @@ title: JourneyEscape
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(16) |
-| Observation Space | Box(0, 255, (230, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/JourneyEscape-v5")` |
+| | |
+|-------------------|------------------------------------------|
+| Action Space | Discrete(16) |
+| 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.
@@ -44,19 +44,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-At the start of the game, you will have $50,000 and 60 units of time.
-Your end game score with be dependent on how much time you have remaining and who you encounter along the way.
-For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=252).
+At the start of the game, you will have $50,000 and 60 units of time. Your end game score with be dependent on how much time you have remaining and who you encounter along the way. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=252).
## Variants
diff --git a/docs/environments/kaboom.md b/docs/environments/kaboom.md
index 50ed9a303..7e45d7150 100644
--- a/docs/environments/kaboom.md
+++ b/docs/environments/kaboom.md
@@ -11,11 +11,11 @@ title: Kaboom
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(4) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(4) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Kaboom-v5")` |
+| Import | `gymnasium.make("ALE/Kaboom-v5")` |
For more Kaboom variants with different observation and action spaces, see the variants section.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Kaboom has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/kangaroo.md b/docs/environments/kangaroo.md
index 611b0871c..ea8b18bd5 100644
--- a/docs/environments/kangaroo.md
+++ b/docs/environments/kangaroo.md
@@ -11,11 +11,11 @@ title: Kangaroo
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Kangaroo-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-Your score will be shown at the top right corner of the game.
-Your end game score with be dependent on how much time you have remaining and who you encounter along the way.
-For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=923).
+Your score will be shown at the top right corner of the game. Your end game score with be dependent on how much time you have remaining and who you encounter along the way. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=923).
## Variants
diff --git a/docs/environments/keystone_kapers.md b/docs/environments/keystone_kapers.md
index dd98bef62..b792beb79 100644
--- a/docs/environments/keystone_kapers.md
+++ b/docs/environments/keystone_kapers.md
@@ -11,11 +11,11 @@ title: KeystoneKapers
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(14) |
-| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/KeystoneKapers-v5")` |
+| | |
+|-------------------|-------------------------------------------|
+| Action Space | Discrete(14) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
KeystoneKapers has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/king_kong.md b/docs/environments/king_kong.md
index b5f29912b..3f5198a55 100644
--- a/docs/environments/king_kong.md
+++ b/docs/environments/king_kong.md
@@ -11,11 +11,11 @@ title: KingKong
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/KingKong-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
KingKong has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/klax.md b/docs/environments/klax.md
index 456ab1a0e..369edf753 100644
--- a/docs/environments/klax.md
+++ b/docs/environments/klax.md
@@ -11,11 +11,11 @@ title: Klax
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Klax-v5")` |
+| Import | `gymnasium.make("ALE/Klax-v5")` |
For more Klax variants with different observation and action spaces, see the variants section.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Klax has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/koolaid.md b/docs/environments/koolaid.md
index 66f62250b..cef5b6ecd 100644
--- a/docs/environments/koolaid.md
+++ b/docs/environments/koolaid.md
@@ -11,11 +11,11 @@ title: Koolaid
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Koolaid-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Koolaid has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/krull.md b/docs/environments/krull.md
index 2f9b87b19..e3aee4bb8 100644
--- a/docs/environments/krull.md
+++ b/docs/environments/krull.md
@@ -11,11 +11,11 @@ title: Krull
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Krull-v5")` |
+| Import | `gymnasium.make("ALE/Krull-v5")` |
For more Krull variants with different observation and action spaces, see the variants section.
@@ -43,19 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You will receive various scores for each monster you kill.
-You can play the game until you have lost all your lives.
-For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=267).
+You will receive various scores for each monster you kill. You can play the game until you have lost all your lives. For a more detailed documentation, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=267).
## Variants
diff --git a/docs/environments/kung_fu_master.md b/docs/environments/kung_fu_master.md
index ac4cce819..c00b495e3 100644
--- a/docs/environments/kung_fu_master.md
+++ b/docs/environments/kung_fu_master.md
@@ -11,11 +11,11 @@ title: KungFuMaster
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(14) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/KungFuMaster-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(14) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
KungFuMaster has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/laser_gates.md b/docs/environments/laser_gates.md
index 5121d2c93..5c3e7d370 100644
--- a/docs/environments/laser_gates.md
+++ b/docs/environments/laser_gates.md
@@ -11,17 +11,17 @@ title: LaserGates
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/LaserGates-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
## Description
-The Cryptic Computer is malfunctioning! Use your Dante Dart to navigate through the computer and deestroy the four Failsafe Detonators.
+The Cryptic Computer is malfunctioning! Use your Dante Dart to navigate through the computer and destroy the four Failsafe Detonators.
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=271)
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
LaserGates has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/lost_luggage.md b/docs/environments/lost_luggage.md
index 79d2f91ac..e15ea8ac4 100644
--- a/docs/environments/lost_luggage.md
+++ b/docs/environments/lost_luggage.md
@@ -11,11 +11,11 @@ title: LostLuggage
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/LostLuggage-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
LostLuggage has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/mario_bros.md b/docs/environments/mario_bros.md
index b98e18acd..5da734ab1 100644
--- a/docs/environments/mario_bros.md
+++ b/docs/environments/mario_bros.md
@@ -11,11 +11,11 @@ title: MarioBros
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/MarioBros-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
MarioBros has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/miniature_golf.md b/docs/environments/miniature_golf.md
index 599f1db65..622422b7a 100644
--- a/docs/environments/miniature_golf.md
+++ b/docs/environments/miniature_golf.md
@@ -11,11 +11,11 @@ title: MiniatureGolf
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/MiniatureGolf-v5")` |
+| | |
+|-------------------|------------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
MiniatureGolf has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/montezuma_revenge.md b/docs/environments/montezuma_revenge.md
index a66aec96a..2fb88911a 100644
--- a/docs/environments/montezuma_revenge.md
+++ b/docs/environments/montezuma_revenge.md
@@ -11,11 +11,11 @@ title: MontezumaRevenge
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/MontezumaRevenge-v5")` |
+| | |
+|-------------------|---------------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
MontezumaRevenge has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/mr_do.md b/docs/environments/mr_do.md
index 5e8b72a62..0988b0403 100644
--- a/docs/environments/mr_do.md
+++ b/docs/environments/mr_do.md
@@ -11,11 +11,11 @@ title: MrDo
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(10) |
| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/MrDo-v5")` |
+| Import | `gymnasium.make("ALE/MrDo-v5")` |
For more MrDo variants with different observation and action spaces, see the variants section.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
MrDo has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/ms_pacman.md b/docs/environments/ms_pacman.md
index 23f6f5442..1819df5ac 100644
--- a/docs/environments/ms_pacman.md
+++ b/docs/environments/ms_pacman.md
@@ -11,11 +11,11 @@ title: MsPacman
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/MsPacman-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
MsPacman has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/name_this_game.md b/docs/environments/name_this_game.md
index 7d6d0b75e..ac84f21d7 100644
--- a/docs/environments/name_this_game.md
+++ b/docs/environments/name_this_game.md
@@ -11,11 +11,11 @@ title: NameThisGame
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/NameThisGame-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
NameThisGame has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/othello.md b/docs/environments/othello.md
index a4c5b6b93..fc153a185 100644
--- a/docs/environments/othello.md
+++ b/docs/environments/othello.md
@@ -11,11 +11,11 @@ title: Othello
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Othello-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(10) |
+| 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.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Othello has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/pacman.md b/docs/environments/pacman.md
index fe1e61c46..c203d492a 100644
--- a/docs/environments/pacman.md
+++ b/docs/environments/pacman.md
@@ -11,11 +11,11 @@ title: Pacman
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(5) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(5) |
| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Pacman-v5")` |
+| Import | `gymnasium.make("ALE/Pacman-v5")` |
For more Pacman variants with different observation and action spaces, see the variants section.
@@ -38,15 +38,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Pacman has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/phoenix.md b/docs/environments/phoenix.md
index 6fb74c16c..d2d80a170 100644
--- a/docs/environments/phoenix.md
+++ b/docs/environments/phoenix.md
@@ -11,11 +11,11 @@ title: Phoenix
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(8) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Phoenix-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(8) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Phoenix has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/pitfall.md b/docs/environments/pitfall.md
index 62c4bb26d..985b2453b 100644
--- a/docs/environments/pitfall.md
+++ b/docs/environments/pitfall.md
@@ -11,11 +11,11 @@ title: Pitfall
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Pitfall-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You get score points for collecting treasure, you lose points through some misfortunes like falling down a hole.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=360).
+You get score points for collecting treasure, you lose points through some misfortunes like falling down a hole. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=360).
## Variants
diff --git a/docs/environments/pitfall2.md b/docs/environments/pitfall2.md
index fca7ecee2..3308d9446 100644
--- a/docs/environments/pitfall2.md
+++ b/docs/environments/pitfall2.md
@@ -11,11 +11,11 @@ title: Pitfall2
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Pitfall2-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Pitfall2 has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/pong.md b/docs/environments/pong.md
index 147e0451d..401b0bcba 100644
--- a/docs/environments/pong.md
+++ b/docs/environments/pong.md
@@ -11,11 +11,11 @@ title: Pong
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(6) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Pong-v5")` |
+| Import | `gymnasium.make("ALE/Pong-v5")` |
For more Pong variants with different observation and action spaces, see the variants section.
@@ -40,18 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-You get score points for getting the ball to pass the opponent's paddle. You lose points if the ball passes your paddle.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=587).
+You get score points for getting the ball to pass the opponent's paddle. You lose points if the ball passes your paddle. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=587).
## Variants
diff --git a/docs/environments/pooyan.md b/docs/environments/pooyan.md
index a1bcb7d04..4019db12a 100644
--- a/docs/environments/pooyan.md
+++ b/docs/environments/pooyan.md
@@ -11,11 +11,11 @@ title: Pooyan
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(6) |
| Observation Space | Box(0, 255, (220, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Pooyan-v5")` |
+| Import | `gymnasium.make("ALE/Pooyan-v5")` |
For more Pooyan variants with different observation and action spaces, see the variants section.
@@ -40,18 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-If you hit a balloon, wolf or stone with an arrow you score points.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=372).
+If you hit a balloon, wolf or stone with an arrow you score points. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=372).
## Variants
diff --git a/docs/environments/private_eye.md b/docs/environments/private_eye.md
index e3a45259e..8e8d95b02 100644
--- a/docs/environments/private_eye.md
+++ b/docs/environments/private_eye.md
@@ -11,11 +11,11 @@ title: PrivateEye
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/PrivateEye-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=376).
+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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=376).
## Variants
diff --git a/docs/environments/qbert.md b/docs/environments/qbert.md
index d0e684666..d4ed6872a 100644
--- a/docs/environments/qbert.md
+++ b/docs/environments/qbert.md
@@ -11,11 +11,11 @@ title: Qbert
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(6) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Qbert-v5")` |
+| Import | `gymnasium.make("ALE/Qbert-v5")` |
For more Qbert variants with different observation and action spaces, see the variants section.
@@ -40,18 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=1224&itemTypeID=HTMLMANUAL).
+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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=1224&itemTypeID=HTMLMANUAL).
## Variants
diff --git a/docs/environments/riverraid.md b/docs/environments/riverraid.md
index a02d919d1..7c17f03da 100644
--- a/docs/environments/riverraid.md
+++ b/docs/environments/riverraid.md
@@ -11,11 +11,11 @@ title: Riverraid
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Riverraid-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,15 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
Score points are your only reward. You get score points each time you destroy an enemy object:
diff --git a/docs/environments/road_runner.md b/docs/environments/road_runner.md
index 8343d80e5..c48454729 100644
--- a/docs/environments/road_runner.md
+++ b/docs/environments/road_runner.md
@@ -11,11 +11,11 @@ title: RoadRunner
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/RoadRunner-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,15 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
Score points are your only reward. You get score points each time you:
diff --git a/docs/environments/robotank.md b/docs/environments/robotank.md
index 994334093..bfff2adfa 100644
--- a/docs/environments/robotank.md
+++ b/docs/environments/robotank.md
@@ -11,11 +11,11 @@ title: Robotank
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Robotank-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,23 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-The number of enemies destroyed is the only reward.
-
-A small tank appears at the top of your screen for each enemy
- you destroy. A square with the number 12 appears each time a squadron of twelve enemies are
- destroyed.
-
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=416).
+The number of enemies destroyed is the only reward. A small tank appears at the top of your screen for each enemy you destroy. A square with the number 12 appears each time a squadron of twelve enemies are destroyed. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=416).
## Variants
diff --git a/docs/environments/seaquest.md b/docs/environments/seaquest.md
index d00629643..ea6afbfde 100644
--- a/docs/environments/seaquest.md
+++ b/docs/environments/seaquest.md
@@ -11,11 +11,11 @@ title: Seaquest
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Seaquest-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,30 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-Score points are your only reward.
-
-Blasting enemy sub and killer shark is worth
-20 points. Every time you surface with six divers, the value of enemy subs
-and killer sharks increases by 10, up to a maximum of 90 points each.
-
-Rescued divers start at 50 points each. Then, their point value increases by 50, every
-time you surface, up to a maximum of 1000 points each.
-
-You'll be further rewarded with bonus points for all the oxygen you have remaining the
-moment you surface. The more oxygen you have left, the more bonus points
-you're given.
-
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=424).
+Score points are your only reward. Blasting enemy sub and killer shark is worth 20 points. Every time you surface with six divers, the value of enemy subs and killer sharks increases by 10, up to a maximum of 90 points each. Rescued divers start at 50 points each. Then, their point value increases by 50, every time you surface, up to a maximum of 1000 points each. You'll be further rewarded with bonus points for all the oxygen you have remaining the moment you surface. The more oxygen you have left, the more bonus points you're given. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=424).
## Variants
diff --git a/docs/environments/sir_lancelot.md b/docs/environments/sir_lancelot.md
index 4fc6f15f4..d0963ece3 100644
--- a/docs/environments/sir_lancelot.md
+++ b/docs/environments/sir_lancelot.md
@@ -11,11 +11,11 @@ title: SirLancelot
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/SirLancelot-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
SirLancelot has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/skiing.md b/docs/environments/skiing.md
index 44038b936..e3c3455cb 100644
--- a/docs/environments/skiing.md
+++ b/docs/environments/skiing.md
@@ -11,11 +11,11 @@ title: Skiing
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(3) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(3) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Skiing-v5")` |
+| Import | `gymnasium.make("ALE/Skiing-v5")` |
For more Skiing variants with different observation and action spaces, see the variants section.
@@ -39,19 +39,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-Seconds are your only rewards - negative rewards and penalties (e.g. missing a gate) are assigned as additional seconds.
-
-For a more detailed documentation, see [the AtariAge page [SLALOM RACING section]](https://atariage.com/manual_html_page.php?SoftwareLabelID=434).
+Seconds are your only rewards - negative rewards and penalties (e.g. missing a gate) are assigned as additional seconds. For a more detailed documentation, see [the AtariAge page [SLALOM RACING section]](https://atariage.com/manual_html_page.php?SoftwareLabelID=434).
## Variants
diff --git a/docs/environments/solaris.md b/docs/environments/solaris.md
index eaf262ad1..f622e8652 100644
--- a/docs/environments/solaris.md
+++ b/docs/environments/solaris.md
@@ -11,11 +11,11 @@ title: Solaris
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Solaris-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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).
+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).
## Variants
diff --git a/docs/environments/space_invaders.md b/docs/environments/space_invaders.md
index bb7e0838d..61dae8260 100644
--- a/docs/environments/space_invaders.md
+++ b/docs/environments/space_invaders.md
@@ -11,11 +11,11 @@ title: SpaceInvaders
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/SpaceInvaders-v5")` |
+| | |
+|-------------------|------------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,18 +40,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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).
+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).
## Variants
diff --git a/docs/environments/space_war.md b/docs/environments/space_war.md
index 8c602ec99..1406f4a08 100644
--- a/docs/environments/space_war.md
+++ b/docs/environments/space_war.md
@@ -11,11 +11,11 @@ title: SpaceWar
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (250, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/SpaceWar-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
SpaceWar has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/star_gunner.md b/docs/environments/star_gunner.md
index ff49310b4..807efcb93 100644
--- a/docs/environments/star_gunner.md
+++ b/docs/environments/star_gunner.md
@@ -11,11 +11,11 @@ title: StarGunner
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/StarGunner-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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).
+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).
## Variants
diff --git a/docs/environments/superman.md b/docs/environments/superman.md
index 9741db858..ecd467448 100644
--- a/docs/environments/superman.md
+++ b/docs/environments/superman.md
@@ -11,11 +11,11 @@ title: Superman
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Superman-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Superman has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/surround.md b/docs/environments/surround.md
index fe570ffbf..c7ca6c5af 100644
--- a/docs/environments/surround.md
+++ b/docs/environments/surround.md
@@ -11,11 +11,11 @@ title: Surround
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(5) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Surround-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(5) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Surround has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/tennis.md b/docs/environments/tennis.md
index 3e2aa8ed0..02f9e5244 100644
--- a/docs/environments/tennis.md
+++ b/docs/environments/tennis.md
@@ -11,11 +11,11 @@ title: Tennis
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Tennis-v5")` |
+| Import | `gymnasium.make("ALE/Tennis-v5")` |
For more Tennis variants with different observation and action spaces, see the variants section.
@@ -43,18 +43,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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).
+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).
## Variants
diff --git a/docs/environments/tetris.md b/docs/environments/tetris.md
index be71e8acb..97a2d5213 100644
--- a/docs/environments/tetris.md
+++ b/docs/environments/tetris.md
@@ -11,11 +11,11 @@ title: Tetris
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(5) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(5) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Tetris-v5")` |
+| Import | `gymnasium.make("ALE/Tetris-v5")` |
For more Tetris variants with different observation and action spaces, see the variants section.
@@ -38,15 +38,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Tetris has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/tic_tac_toe_3d.md b/docs/environments/tic_tac_toe_3d.md
index ed79f1b8a..f97743e47 100644
--- a/docs/environments/tic_tac_toe_3d.md
+++ b/docs/environments/tic_tac_toe_3d.md
@@ -11,11 +11,11 @@ title: TicTacToe3D
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/TicTacToe3D-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(10) |
+| 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.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
TicTacToe3D has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/time_pilot.md b/docs/environments/time_pilot.md
index 43c93ccf9..c94ee30af 100644
--- a/docs/environments/time_pilot.md
+++ b/docs/environments/time_pilot.md
@@ -11,11 +11,11 @@ title: TimePilot
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/TimePilot-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(10) |
+| 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.
@@ -42,18 +42,17 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-### Rewards
+### Reward
-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).
+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).
## Variants
diff --git a/docs/environments/trondead.md b/docs/environments/trondead.md
index 8d50f296a..a08e457d4 100644
--- a/docs/environments/trondead.md
+++ b/docs/environments/trondead.md
@@ -11,11 +11,11 @@ title: Trondead
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Trondead-v5")` |
+| | |
+|-------------------|-------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Trondead has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/turmoil.md b/docs/environments/turmoil.md
index 303b979f1..25bd5ce1f 100644
--- a/docs/environments/turmoil.md
+++ b/docs/environments/turmoil.md
@@ -11,11 +11,11 @@ title: Turmoil
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(12) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Turmoil-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(12) |
+| 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.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Turmoil has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/tutankham.md b/docs/environments/tutankham.md
index d411b8934..642244bdc 100644
--- a/docs/environments/tutankham.md
+++ b/docs/environments/tutankham.md
@@ -11,11 +11,11 @@ title: Tutankham
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(8) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Tutankham-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(8) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Tutankham has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/up_n_down.md b/docs/environments/up_n_down.md
index 394251f7f..8ba823c28 100644
--- a/docs/environments/up_n_down.md
+++ b/docs/environments/up_n_down.md
@@ -11,11 +11,11 @@ title: UpNDown
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(6) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/UpNDown-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(6) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
UpNDown has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/venture.md b/docs/environments/venture.md
index 9af5b2b2f..f93ee95e8 100644
--- a/docs/environments/venture.md
+++ b/docs/environments/venture.md
@@ -11,11 +11,11 @@ title: Venture
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Venture-v5")` |
+| | |
+|-------------------|------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Venture has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/video_checkers.md b/docs/environments/video_checkers.md
index 4c11da45c..626988710 100644
--- a/docs/environments/video_checkers.md
+++ b/docs/environments/video_checkers.md
@@ -11,11 +11,11 @@ title: VideoCheckers
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(5) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/VideoCheckers-v5")` |
+| | |
+|-------------------|------------------------------------------|
+| Action Space | Discrete(5) |
+| 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.
@@ -40,15 +40,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
VideoCheckers has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/video_chess.md b/docs/environments/video_chess.md
index 5640815a5..3ae8aaaef 100644
--- a/docs/environments/video_chess.md
+++ b/docs/environments/video_chess.md
@@ -11,11 +11,11 @@ title: VideoChess
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/VideoChess-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(10) |
+| 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.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
VideoChess has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/video_cube.md b/docs/environments/video_cube.md
index fd1f556fa..aa5150fa1 100644
--- a/docs/environments/video_cube.md
+++ b/docs/environments/video_cube.md
@@ -11,11 +11,11 @@ title: VideoCube
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/VideoCube-v5")` |
+| | |
+|-------------------|--------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
VideoCube has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/video_pinball.md b/docs/environments/video_pinball.md
index 63b21ebca..eb208a33b 100644
--- a/docs/environments/video_pinball.md
+++ b/docs/environments/video_pinball.md
@@ -11,11 +11,11 @@ title: VideoPinball
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(9) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/VideoPinball-v5")` |
+| | |
+|-------------------|-----------------------------------------|
+| Action Space | Discrete(9) |
+| 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.
@@ -41,15 +41,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
VideoPinball has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/wizard_of_wor.md b/docs/environments/wizard_of_wor.md
index ca1f2a0fa..91cdb7680 100644
--- a/docs/environments/wizard_of_wor.md
+++ b/docs/environments/wizard_of_wor.md
@@ -11,11 +11,11 @@ title: WizardOfWor
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(10) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/WizardOfWor-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(10) |
+| 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.
@@ -42,15 +42,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
WizardOfWor has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/word_zapper.md b/docs/environments/word_zapper.md
index ce9e3dd6a..c177bbd33 100644
--- a/docs/environments/word_zapper.md
+++ b/docs/environments/word_zapper.md
@@ -11,11 +11,11 @@ title: WordZapper
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/WordZapper-v5")` |
+| | |
+|-------------------|---------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
WordZapper has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/yars_revenge.md b/docs/environments/yars_revenge.md
index 6a62e3894..713ad7f3a 100644
--- a/docs/environments/yars_revenge.md
+++ b/docs/environments/yars_revenge.md
@@ -11,11 +11,11 @@ title: YarsRevenge
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
-| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/YarsRevenge-v5")` |
+| | |
+|-------------------|----------------------------------------|
+| Action Space | Discrete(18) |
+| 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.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
YarsRevenge has the following variants of the environment id which have the following differences in observation,
diff --git a/docs/environments/zaxxon.md b/docs/environments/zaxxon.md
index cea960e86..0c1a2c613 100644
--- a/docs/environments/zaxxon.md
+++ b/docs/environments/zaxxon.md
@@ -11,11 +11,11 @@ title: Zaxxon
This environment is part of the Atari environments. Please read that page first for general information.
-| | |
-|---|---|
-| Action Space | Discrete(18) |
+| | |
+|-------------------|-----------------------------------|
+| Action Space | Discrete(18) |
| Observation Space | Box(0, 255, (210, 160, 3), uint8) |
-| Import | `gymnasium.make("ALE/Zaxxon-v5")` |
+| Import | `gymnasium.make("ALE/Zaxxon-v5")` |
For more Zaxxon variants with different observation and action spaces, see the variants section.
@@ -43,15 +43,14 @@ See [environment specification](../env-spec) to see more information on the acti
## Observations
-Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
+Atari environments have three possible observation types:
-- `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
+- `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 q"rgb" type
See variants section for the type of observation used by each environment id by default.
-
## Variants
Zaxxon has the following variants of the environment id which have the following differences in observation,