From 370685a04dda001f7508665d1f20ff7e067d97a1 Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Wed, 18 Sep 2024 00:02:15 +0100 Subject: [PATCH 1/6] Simplify registration --- .pre-commit-config.yaml | 8 +- src/ale/python/__init__.pyi | 2 + src/ale/python/registration.py | 187 +++------------------------------ 3 files changed, 19 insertions(+), 178 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 92591906c..1b1dbba8e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,7 +2,7 @@ # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 + rev: v4.6.0 hooks: - id: check-symlinks - id: destroyed-symlinks @@ -25,7 +25,7 @@ repos: # args: # - --ignore-words-list= - repo: https://github.com/PyCQA/flake8 - rev: 7.0.0 + rev: 7.1.1 hooks: - id: flake8 args: @@ -36,7 +36,7 @@ repos: - --show-source - --statistics - repo: https://github.com/asottile/pyupgrade - rev: v3.15.0 + rev: v3.17.0 hooks: - id: pyupgrade args: ["--py38-plus"] @@ -46,7 +46,7 @@ repos: - id: isort args: ["--profile", "black"] - repo: https://github.com/python/black - rev: 23.12.1 + rev: 24.8.0 hooks: - id: black # - repo: https://github.com/pycqa/pydocstyle diff --git a/src/ale/python/__init__.pyi b/src/ale/python/__init__.pyi index 4025420f0..055dcee7b 100644 --- a/src/ale/python/__init__.pyi +++ b/src/ale/python/__init__.pyi @@ -28,6 +28,7 @@ class LoggerMode: """ :type: str """ + @property def value(self) -> int: """ @@ -54,6 +55,7 @@ class Action: """ :type: str """ + @property def value(self) -> int: """ diff --git a/src/ale/python/registration.py b/src/ale/python/registration.py index adf577534..5b655ec35 100644 --- a/src/ale/python/registration.py +++ b/src/ale/python/registration.py @@ -1,24 +1,10 @@ from __future__ import annotations -from collections import defaultdict -from typing import Any, Callable, Mapping, NamedTuple, Sequence - import ale_py.roms as roms import gymnasium -class EnvFlavour(NamedTuple): - suffix: str - kwargs: Mapping[str, Any] | Callable[[str], Mapping[str, Any]] - - -class EnvConfig(NamedTuple): - version: str - kwargs: Mapping[str, Any] - flavours: Sequence[EnvFlavour] - - -def _rom_id_to_name(rom: str) -> str: +def rom_id_to_name(rom: str) -> str: """ Let the ROM ID be the ROM identifier in snake_case. For example, `space_invaders` @@ -31,168 +17,21 @@ def _rom_id_to_name(rom: str) -> str: return rom.title().replace("_", "") -def _register_rom_configs( - roms: Sequence[str], - obs_types: Sequence[str], - configs: Sequence[EnvConfig], - prefix: str = "", -): - if len(prefix) > 0 and prefix[-1] != "/": - prefix += "/" - - for rom in roms: - for obs_type in obs_types: - for config in configs: - for flavour in config.flavours: - name = _rom_id_to_name(rom) - name = f"{name}-ram" if obs_type == "ram" else name - - # Parse config kwargs - config_kwargs = ( - config.kwargs(rom) if callable(config.kwargs) else config.kwargs - ) - # Parse flavour kwargs - flavour_kwargs = ( - flavour.kwargs(rom) - if callable(flavour.kwargs) - else flavour.kwargs - ) - - # Register the environment - gymnasium.register( - id=f"{prefix}{name}{flavour.suffix}-{config.version}", - entry_point="ale_py.env:AtariEnv", - kwargs=dict( - game=rom, - obs_type=obs_type, - **config_kwargs, - **flavour_kwargs, - ), - ) - - -def register_v0_v4_envs(): - legacy_games = [ - "adventure", - "air_raid", - "alien", - "amidar", - "assault", - "asterix", - "asteroids", - "atlantis", - "bank_heist", - "battle_zone", - "beam_rider", - "berzerk", - "bowling", - "boxing", - "breakout", - "carnival", - "centipede", - "chopper_command", - "crazy_climber", - "defender", - "demon_attack", - "double_dunk", - "elevator_action", - "enduro", - "fishing_derby", - "freeway", - "frostbite", - "gopher", - "gravitar", - "hero", - "ice_hockey", - "jamesbond", - "journey_escape", - "kangaroo", - "krull", - "kung_fu_master", - "montezuma_revenge", - "ms_pacman", - "name_this_game", - "phoenix", - "pitfall", - "pong", - "pooyan", - "private_eye", - "qbert", - "riverraid", - "road_runner", - "robotank", - "seaquest", - "skiing", - "solaris", - "space_invaders", - "star_gunner", - "tennis", - "time_pilot", - "tutankham", - "up_n_down", - "venture", - "video_pinball", - "wizard_of_wor", - "yars_revenge", - "zaxxon", - ] - obs_types = ["rgb", "ram"] - frameskip = defaultdict(lambda: 4, [("space_invaders", 3)]) - - versions = [ - EnvConfig( - version="v0", - kwargs={ - "repeat_action_probability": 0.25, - "full_action_space": False, - "max_num_frames_per_episode": 108_000, - }, - flavours=[ - # Default for v0 has 10k steps, no idea why... - EnvFlavour("", {"frameskip": (2, 5)}), - # Deterministic has 100k steps, close to the standard of 108k (30 mins gameplay) - EnvFlavour("Deterministic", lambda rom: {"frameskip": frameskip[rom]}), - # NoFrameSkip imposes a max episode steps of frameskip * 100k, weird... - EnvFlavour("NoFrameskip", {"frameskip": 1}), - ], - ), - EnvConfig( - version="v4", - kwargs={ - "repeat_action_probability": 0.0, - "full_action_space": False, - "max_num_frames_per_episode": 108_000, - }, - flavours=[ - # Unlike v0, v4 has 100k max episode steps - EnvFlavour("", {"frameskip": (2, 5)}), - EnvFlavour("Deterministic", lambda rom: {"frameskip": frameskip[rom]}), - # Same weird frameskip * 100k max steps for v4? - EnvFlavour("NoFrameskip", {"frameskip": 1}), - ], - ), - ] - - _register_rom_configs(legacy_games, obs_types, versions) - - -def register_v5_envs(): +def register_envs(): all_games = roms.get_all_rom_ids() - obs_types = ["rgb", "ram"] - # max_episode_steps is 108k frames which is 30 mins of gameplay. - # This corresponds to 108k / 4 = 27,000 steps - versions = [ - EnvConfig( - version="v5", + for game in all_games: + gymnasium.register( + id=f"ALE/{game}-v6", + entry_point="ale_py.env:AtariEnv", kwargs={ - "repeat_action_probability": 0.25, - "full_action_space": False, - "frameskip": 4, + "game": game, + "obs_type": "rgb", + "frameskip": 1, + # max_episode_steps is 108k frames which is 30 mins of gameplay. + # This corresponds to 108k / 4 = 27,000 steps "max_num_frames_per_episode": 108_000, + "repeat_action_probability": 0, + "full_action_space": False, }, - flavours=[EnvFlavour("", {})], ) - ] - - _register_rom_configs(all_games, obs_types, versions, prefix="ALE/") From 0156ff0396fc98fd74469b00ac5620234113959f Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Wed, 18 Sep 2024 12:53:16 +0100 Subject: [PATCH 2/6] Simplify the registration to v5 --- src/ale/python/__init__.py | 5 +- src/ale/python/registration.py | 19 +-- tests/python/test_atari_env.py | 151 ++--------------------- tests/python/test_legacy_registration.py | 137 -------------------- 4 files changed, 19 insertions(+), 293 deletions(-) delete mode 100644 tests/python/test_legacy_registration.py diff --git a/src/ale/python/__init__.py b/src/ale/python/__init__.py index b270bcefc..8bc09c493 100644 --- a/src/ale/python/__init__.py +++ b/src/ale/python/__init__.py @@ -63,9 +63,8 @@ __all__ += ["AtariEnv", "AtariEnvStepMetadata"] - from ale_py.registration import register_v0_v4_envs, register_v5_envs + from ale_py.registration import register_envs - register_v0_v4_envs() - register_v5_envs() + register_envs() except ImportError: pass diff --git a/src/ale/python/registration.py b/src/ale/python/registration.py index 613684fd8..815384cfc 100644 --- a/src/ale/python/registration.py +++ b/src/ale/python/registration.py @@ -7,27 +7,20 @@ def rom_id_to_name(rom: str) -> str: - """ - Let the ROM ID be the ROM identifier in snake_case. - For example, `space_invaders` - The ROM name is the ROM ID in pascalcase. - For example, `SpaceInvaders` - - This function converts the ROM ID to the ROM name. - i.e., snakecase -> pascalcase - """ + """Convert a rom id in snake_case to the name in PascalCase.""" return rom.title().replace("_", "") def register_envs(): - all_games = roms.get_all_rom_ids() + """Register all the Atari Environments.""" + all_rom_ids = roms.get_all_rom_ids() - for game in all_games: + for rom_id in all_rom_ids: gymnasium.register( - id=f"ALE/{game}-v6", + id=f"ALE/{rom_id_to_name(rom_id)}-v5", entry_point="ale_py.env:AtariEnv", kwargs={ - "game": game, + "game": rom_id, "obs_type": "rgb", "frameskip": 1, # max_episode_steps is 108k frames which is 30 mins of gameplay. diff --git a/tests/python/test_atari_env.py b/tests/python/test_atari_env.py index f66e63e29..193d2f113 100644 --- a/tests/python/test_atari_env.py +++ b/tests/python/test_atari_env.py @@ -1,18 +1,14 @@ -import itertools import warnings -from itertools import product from unittest.mock import patch import gymnasium import numpy as np import pytest from ale_py.env import AtariEnv -from ale_py.registration import _register_rom_configs, register_v0_v4_envs from gymnasium.utils.env_checker import check_env from utils import tetris_env, tetris_rom_path # noqa: F401 -_ACCEPTABLE_WARNING_SNIPPETS = [ - "is out of date. You should consider upgrading to version", +_VALID_WARNINGS = [ "we recommend using a symmetric and normalized space", "This will error out when the continuous actions are discretized to illegal action spaces", ] @@ -25,32 +21,20 @@ def test_roms_register(): if spec.entry_point == "ale_py.env:AtariEnv" ] - registered_v0_roms = list(filter(lambda env_id: "v0" in env_id, registered_roms)) - registered_v4_roms = list(filter(lambda env_id: "v4" in env_id, registered_roms)) registered_v5_roms = list(filter(lambda env_id: "v5" in env_id, registered_roms)) - - assert ( - len(registered_v0_roms) == 372 - ), f"{len(registered_roms)}, {len(registered_v0_roms)}, {len(registered_v4_roms)}, {len(registered_v5_roms)}" - assert len(registered_v4_roms) == 372 - assert len(registered_v5_roms) == 216 - - assert len(registered_roms) == len(registered_v0_roms) + len( - registered_v4_roms - ) + len(registered_v5_roms) + assert len(registered_v5_roms) == 108 + assert len(registered_roms) == len(registered_v5_roms) @pytest.mark.parametrize( - "env_id,continuous", - itertools.product( - [ - env_id - for env_id, spec in gymnasium.registry.items() - if spec.entry_point == "ale_py.env:AtariEnv" - ], - [True, False], - ), + "env_id", + [ + env_id + for env_id, spec in gymnasium.registry.items() + if spec.entry_point == "ale_py.env:AtariEnv" + ], ) +@pytest.mark.parametrize("continuous", [True, False]) def test_check_env(env_id, continuous): if any( unsupported_game in env_id @@ -65,123 +49,10 @@ def test_check_env(env_id, continuous): env.close() for warning in caught_warnings: - if not any( - (snippet in warning.message.args[0]) - for snippet in _ACCEPTABLE_WARNING_SNIPPETS - ): + if not any((snippet in warning.message.args[0]) for snippet in _VALID_WARNINGS): raise ValueError(warning.message.args[0]) -def test_register_legacy_env_id(): - prefix = "ALETest/" - - _original_register_gym_configs = _register_rom_configs - - def _mocked_register_gym_configs(*args, **kwargs): - return _original_register_gym_configs(*args, **kwargs, prefix=prefix) - - with patch( - "ale_py.registration._register_rom_configs", - new=_mocked_register_gym_configs, - ): - # Register internal IDs - register_v0_v4_envs() - - # Check if we registered the proper environments - envids = set(map(lambda e: e.id, gymnasium.registry.values())) - legacy_games = [ - "Adventure", - "AirRaid", - "Alien", - "Amidar", - "Assault", - "Asterix", - "Asteroids", - "Atlantis", - "BankHeist", - "BattleZone", - "BeamRider", - "Berzerk", - "Bowling", - "Boxing", - "Breakout", - "Carnival", - "Centipede", - "ChopperCommand", - "CrazyClimber", - "Defender", - "DemonAttack", - "DoubleDunk", - "ElevatorAction", - "Enduro", - "FishingDerby", - "Freeway", - "Frostbite", - "Gopher", - "Gravitar", - "Hero", - "IceHockey", - "Jamesbond", - "JourneyEscape", - "Kangaroo", - "Krull", - "KungFuMaster", - "MontezumaRevenge", - "MsPacman", - "NameThisGame", - "Phoenix", - "Pitfall", - "Pong", - "Pooyan", - "PrivateEye", - "Qbert", - "Riverraid", - "RoadRunner", - "Robotank", - "Seaquest", - "Skiing", - "Solaris", - "SpaceInvaders", - "StarGunner", - "Tennis", - "TimePilot", - "Tutankham", - "UpNDown", - "Venture", - "VideoPinball", - "WizardOfWor", - "YarsRevenge", - "Zaxxon", - ] - legacy_games = map(lambda game: f"{prefix}{game}", legacy_games) - - obs_types = ["", "-ram"] - suffixes = ["Deterministic", "NoFrameskip"] - versions = ["-v0", "-v4"] - - all_ids = set( - map("".join, product(legacy_games, obs_types, suffixes, versions)) - ) - assert all_ids.issubset(envids) - - -def test_register_gym_envs(tetris_rom_path): - with patch("ale_py.roms.Tetris", create=True, new_callable=lambda: tetris_rom_path): - # Register internal IDs - # register_v5_envs() - - # Check if we registered the proper environments - envids = set(map(lambda e: e.id, gymnasium.registry.values())) - games = ["ALE/Tetris"] - - obs_types = ["", "-ram"] - suffixes = [] - versions = ["-v5"] - - all_ids = set(map("".join, product(games, obs_types, suffixes, versions))) - assert all_ids.issubset(envids) - - def test_gym_make(tetris_env): assert isinstance(tetris_env, gymnasium.Env) diff --git a/tests/python/test_legacy_registration.py b/tests/python/test_legacy_registration.py deleted file mode 100644 index f795fce84..000000000 --- a/tests/python/test_legacy_registration.py +++ /dev/null @@ -1,137 +0,0 @@ -from itertools import product - -import ale_py -import gymnasium - -gymnasium.register_envs(ale_py) - - -def test_legacy_env_specs(): - versions = ["-v0", "-v4"] - suffixes = ["", "NoFrameskip", "Deterministic"] - obs_types = ["", "-ram"] - games = [ - "adventure", - "air_raid", - "alien", - "amidar", - "assault", - "asterix", - "asteroids", - "atlantis", - "bank_heist", - "battle_zone", - "beam_rider", - "berzerk", - "bowling", - "boxing", - "breakout", - "carnival", - "centipede", - "chopper_command", - "crazy_climber", - "defender", - "demon_attack", - "double_dunk", - "elevator_action", - "enduro", - "fishing_derby", - "freeway", - "frostbite", - "gopher", - "gravitar", - "hero", - "ice_hockey", - "jamesbond", - "journey_escape", - "kangaroo", - "krull", - "kung_fu_master", - "montezuma_revenge", - "ms_pacman", - "name_this_game", - "phoenix", - "pitfall", - "pong", - "pooyan", - "private_eye", - "qbert", - "riverraid", - "road_runner", - "robotank", - "seaquest", - "skiing", - "solaris", - "space_invaders", - "star_gunner", - "tennis", - "time_pilot", - "tutankham", - "up_n_down", - "venture", - "video_pinball", - "wizard_of_wor", - "yars_revenge", - "zaxxon", - ] - - # Convert snake case to camel case - games = list(map(lambda x: x.title().replace("_", ""), games)) - specs = list(map("".join, product(games, obs_types, suffixes, versions))) - - """ - defaults: - repeat_action_probability = 0.0 - full_action_space = False - frameskip = (2, 5) - game = "Pong" - obs_type = "ram" - mode = None - difficulty = None - - v0: repeat_action_probability = 0.25 - v4: inherits defaults - - -NoFrameskip: frameskip = 1 - -Deterministic: frameskip = 4 or 3 for space_invaders - """ - for spec in specs: - assert spec in gymnasium.registry - kwargs = gymnasium.registry[spec].kwargs - - # Assert necessary parameters are set - assert "frameskip" in kwargs - assert "game" in kwargs - assert "obs_type" in kwargs - assert "repeat_action_probability" in kwargs - assert "full_action_space" in kwargs - - # Common defaults - assert kwargs["full_action_space"] is False - assert "mode" not in kwargs - assert "difficulty" not in kwargs - - if "-ram" in spec: - assert kwargs["obs_type"] == "ram" - else: - assert kwargs["obs_type"] == "rgb" - - assert kwargs["max_num_frames_per_episode"] == 108_000 - - if "NoFrameskip" in spec: - assert kwargs["frameskip"] == 1 - elif "Deterministic" in spec: - assert isinstance(kwargs["frameskip"], int) - frameskip = 3 if "SpaceInvaders" in spec else 4 - assert kwargs["frameskip"] == frameskip - else: - assert isinstance(kwargs["frameskip"], tuple) and kwargs["frameskip"] == ( - 2, - 5, - ) - - assert spec.endswith("v0") or spec.endswith("v4") - if spec.endswith("v0"): - assert kwargs["repeat_action_probability"] == 0.25 - elif spec.endswith("v4"): - assert kwargs["repeat_action_probability"] == 0.0 From b951f45c571838224a3236dd4bf38bd7ddfa2e77 Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Mon, 23 Sep 2024 12:04:39 +0100 Subject: [PATCH 3/6] Update documentation --- docs/_scripts/environment-docs.json | 2 +- docs/_scripts/gen_environments_md.py | 38 +++++++++------ docs/environments.md | 65 +++++++++++--------------- docs/environments/adventure.md | 33 +++++-------- docs/environments/air_raid.md | 33 +++++-------- docs/environments/alien.md | 27 ++++------- docs/environments/amidar.md | 31 ++++-------- docs/environments/assault.md | 31 ++++-------- docs/environments/asterix.md | 31 ++++-------- docs/environments/asteroids.md | 31 ++++-------- docs/environments/atlantis.md | 34 +++++--------- docs/environments/atlantis2.md | 19 ++++---- docs/environments/backgammon.md | 19 ++++---- docs/environments/bank_heist.md | 31 ++++-------- docs/environments/basic_math.md | 19 ++++---- docs/environments/battle_zone.md | 31 ++++-------- docs/environments/beam_rider.md | 31 ++++-------- docs/environments/berzerk.md | 31 ++++-------- docs/environments/blackjack.md | 19 ++++---- docs/environments/bowling.md | 31 ++++-------- docs/environments/boxing.md | 31 ++++-------- docs/environments/breakout.md | 31 ++++-------- docs/environments/carnival.md | 31 ++++-------- docs/environments/casino.md | 19 ++++---- docs/environments/centipede.md | 31 ++++-------- docs/environments/chopper_command.md | 31 ++++-------- docs/environments/crazy_climber.md | 31 ++++-------- docs/environments/crossbow.md | 19 ++++---- docs/environments/darkchambers.md | 19 ++++---- docs/environments/defender.md | 31 ++++-------- docs/environments/demon_attack.md | 31 ++++-------- docs/environments/donkey_kong.md | 19 ++++---- docs/environments/double_dunk.md | 31 ++++-------- docs/environments/earthworld.md | 19 ++++---- docs/environments/elevator_action.md | 31 ++++-------- docs/environments/enduro.md | 31 ++++-------- docs/environments/entombed.md | 19 ++++---- docs/environments/et.md | 19 ++++---- docs/environments/fishing_derby.md | 32 +++++-------- docs/environments/flag_capture.md | 19 ++++---- docs/environments/freeway.md | 32 +++++-------- docs/environments/frogger.md | 19 ++++---- docs/environments/frostbite.md | 32 +++++-------- docs/environments/galaxian.md | 19 ++++---- docs/environments/gopher.md | 32 +++++-------- docs/environments/gravitar.md | 32 +++++-------- docs/environments/hangman.md | 19 ++++---- docs/environments/haunted_house.md | 19 ++++---- docs/environments/hero.md | 31 ++++-------- docs/environments/human_cannonball.md | 19 ++++---- docs/environments/ice_hockey.md | 31 ++++-------- docs/environments/jamesbond.md | 31 ++++-------- docs/environments/journey_escape.md | 31 ++++-------- docs/environments/kaboom.md | 19 ++++---- docs/environments/kangaroo.md | 31 ++++-------- docs/environments/keystone_kapers.md | 19 ++++---- docs/environments/king_kong.md | 19 ++++---- docs/environments/klax.md | 19 ++++---- docs/environments/koolaid.md | 19 ++++---- docs/environments/krull.md | 31 ++++-------- docs/environments/kung_fu_master.md | 31 ++++-------- docs/environments/laser_gates.md | 19 ++++---- docs/environments/lost_luggage.md | 19 ++++---- docs/environments/mario_bros.md | 19 ++++---- docs/environments/miniature_golf.md | 19 ++++---- docs/environments/montezuma_revenge.md | 31 ++++-------- docs/environments/mr_do.md | 19 ++++---- docs/environments/ms_pacman.md | 31 ++++-------- docs/environments/name_this_game.md | 31 ++++-------- docs/environments/othello.md | 19 ++++---- docs/environments/pacman.md | 34 +++++--------- docs/environments/phoenix.md | 31 ++++-------- docs/environments/pitfall.md | 34 +++++--------- docs/environments/pitfall2.md | 19 ++++---- docs/environments/pong.md | 31 ++++-------- docs/environments/pooyan.md | 31 ++++-------- docs/environments/private_eye.md | 31 ++++-------- docs/environments/qbert.md | 31 ++++-------- docs/environments/riverraid.md | 31 ++++-------- docs/environments/road_runner.md | 31 ++++-------- docs/environments/robotank.md | 31 ++++-------- docs/environments/seaquest.md | 31 ++++-------- docs/environments/sir_lancelot.md | 19 ++++---- docs/environments/skiing.md | 31 ++++-------- docs/environments/solaris.md | 31 ++++-------- docs/environments/space_invaders.md | 31 ++++-------- docs/environments/space_war.md | 19 ++++---- docs/environments/star_gunner.md | 31 ++++-------- docs/environments/superman.md | 19 ++++---- docs/environments/surround.md | 19 ++++---- docs/environments/tennis.md | 31 ++++-------- docs/environments/tetris.md | 19 ++++---- docs/environments/tic_tac_toe_3d.md | 19 ++++---- docs/environments/time_pilot.md | 31 ++++-------- docs/environments/trondead.md | 19 ++++---- docs/environments/turmoil.md | 19 ++++---- docs/environments/tutankham.md | 31 ++++-------- docs/environments/up_n_down.md | 31 ++++-------- docs/environments/venture.md | 31 ++++-------- docs/environments/video_checkers.md | 19 ++++---- docs/environments/video_chess.md | 19 ++++---- docs/environments/video_cube.md | 19 ++++---- docs/environments/video_pinball.md | 31 ++++-------- docs/environments/wizard_of_wor.md | 31 ++++-------- docs/environments/word_zapper.md | 19 ++++---- docs/environments/yars_revenge.md | 31 ++++-------- docs/environments/zaxxon.md | 31 ++++-------- 107 files changed, 1100 insertions(+), 1751 deletions(-) diff --git a/docs/_scripts/environment-docs.json b/docs/_scripts/environment-docs.json index 16fece669..d94bafb55 100644 --- a/docs/_scripts/environment-docs.json +++ b/docs/_scripts/environment-docs.json @@ -11,7 +11,7 @@ }, "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.", + "env_description": "You are stuck in a maze-like spaceship with three aliens. Your 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" }, "amidar": { diff --git a/docs/_scripts/gen_environments_md.py b/docs/_scripts/gen_environments_md.py index b3ac5ed34..aedbd5ef4 100644 --- a/docs/_scripts/gen_environments_md.py +++ b/docs/_scripts/gen_environments_md.py @@ -4,7 +4,7 @@ import ale_py import gymnasium import tabulate -from ale_py.registration import _rom_id_to_name +from ale_py.registration import rom_id_to_name from tqdm import tqdm gymnasium.register_envs(ale_py) @@ -58,7 +58,7 @@ def shortened_repr(values): rows = [] for rom_id in tqdm(ALL_ATARI_GAMES): - env_name = _rom_id_to_name(rom_id) + env_name = rom_id_to_name(rom_id) env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped @@ -86,13 +86,24 @@ def shortened_repr(values): 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_name = rom_id_to_name(rom_id) env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped + + general_info_table = tabulate.tabulate( + [ + ["Action Space", str(env.action_space)], + ["Observation Space", str(env.observation_space)], + ["Creation", f"make(ALE/{env_name}-v5)"], + ], + headers=["", ""], + tablefmt="github", + ) + if rom_id in atari_data: env_data = atari_data[rom_id] @@ -103,7 +114,8 @@ def shortened_repr(values): """ else: env_url = "" - reward_description = env_data["reward_description"] + reward_description = f""" +{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." @@ -148,7 +160,7 @@ def shortened_repr(values): env_spec.id, f'`"{env_spec.kwargs["obs_type"]}"`', f'`{env_spec.kwargs["frameskip"]}`', - f'`{env_spec.kwargs["repeat_action_probability"]}`', + f'`{env_spec.kwargs["repeat_action_probability"]:.2f}`', ] for env_spec in env_specs ] @@ -184,18 +196,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}")` | +{general_info_table} For more {env_name} variants with different observation and action spaces, see the variants section. @@ -220,9 +228,7 @@ def shortened_repr(values): - `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type See variants section for the type of observation used by each environment id by default. - {reward_description} - ## Variants {env_name} has the following variants of the environment id which have the following differences in observation, @@ -230,6 +236,8 @@ def shortened_repr(values): {env_variant_table} +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `{env_name}NoFrameskip-v4`. + ## Difficulty and modes It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. @@ -246,5 +254,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.md b/docs/environments.md index 34f3986e7..5516e0fc0 100644 --- a/docs/environments.md +++ b/docs/environments.md @@ -142,13 +142,11 @@ The Atari environments observation can be ## Rewards -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/). +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/). ## Stochasticity -As the Atari games are entirely deterministic, agents could achieve -state-of-the-art performance by simply memorizing an optimal sequence of actions while completely ignoring observations from the environment. +As the Atari games are entirely deterministic, agents can achieve state-of-the-art performance by simply memorizing an optimal sequence of actions while completely ignoring observations from the environment. To avoid this, there are several methods to avoid this. @@ -156,7 +154,7 @@ To avoid this, there are several methods to avoid this. probability that the previously executed action is used instead. In the v0 and v5 environments, the probability of repeating an action is `25%` while in v4 environments, the probability is `0%`. Users can specify the repeat action probability using `repeat_action_probability` to `make`. -2. Frameskipping: On each environment step, the action can be repeated for a random number of frames. This behavior +2. Frame-skipping: On each environment step, the action can be repeated for a random number of frames. This behavior may be altered by setting the keyword argument `frameskip` to either a positive integer or a tuple of two positive integers. If `frameskip` is an integer, frame skipping is deterministic, and in each step the action is repeated `frameskip` many times. Otherwise, if `frameskip` is a tuple, the number of skipped frames is chosen uniformly at @@ -190,38 +188,31 @@ action space will be reduced to a subset. ## Version History and Naming Schemes -All Atari games are available in three versions. They differ in the default settings of the arguments above. -The differences are listed in the following table: - -| Version | `frameskip=` | `repeat_action_probability=` | `full_action_space=` | -|---------|--------------|------------------------------|----------------------| -| v0 | `(2, 5,)` | `0.25` | `False` | -| v4 | `(2, 5,)` | `0.0` | `False` | -| v5 | `4` | `0.25` | `False` | - -> Version v5 follows the best practices outlined in [[2]](#2). Thus, it is recommended to transition to v5 and -customize the environment using the arguments above, if necessary. - -For each Atari game, several different configurations are registered in Gymnasium. The naming schemes are analogous for -v0 and v4. Let us take a look at all variations of Amidar-v0 that are registered with gymnasium: - -| Name | `obs_type=` | `frameskip=` | `repeat_action_probability=` | -|----------------------------|-------------|--------------|------------------------------| -| Amidar-v0 | `"rgb"` | `(2, 5,)` | `0.25` | -| AmidarDeterministic-v0 | `"rgb"` | `4` | `0.0` | -| AmidarNoframeskip-v0 | `"rgb"` | `1` | `0.25` | -| Amidar-ram-v0 | `"ram"` | `(2, 5,)` | `0.25` | -| Amidar-ramDeterministic-v0 | `"ram"` | `4` | `0.0` | -| Amidar-ramNoframeskip-v0 | `"ram"` | `1` | `0.25` | - -Things change in v5: The suffixes "Deterministic" and "NoFrameskip" are no longer available. Instead, you must specify the -environment configuration via arguments passed to `gymnasium.make`. Moreover, the v5 environments -are in the "ALE" namespace. The suffix "-ram" is still available. Thus, we get the following table: - -| Name | `obs_type=` | `frameskip=` | `repeat_action_probability=` | -|-------------------|-------------|--------------|------------------------------| -| ALE/Amidar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Amidar-ram-v5 | `"ram"` | `4` | `0.25` | +In v0.11, the number of registered Atari environments does significantly reduced from 960 to 105 to only register `ALE/{rom_name}-v5` following the best practices outlined in [[2]](#2). + +| Name | `obs_type=` | `frameskip=` | `repeat_action_probability=` | `full_ation_space=` | +|------------------|-------------|--------------|------------------------------|---------------------| +| ALE/Adventure-v5 | `"rgb"` | `4` | `0.25` | `False` | + +Importantly, `repeat_action_probability=0.25` can negatively impact the performance of agents so when comparing training graphs, be aware of the parameters used for fair comparisons. + +To create previously implemented environment use the following parameters, `gymnasium.make(env_id, obs_type=..., frameskip=..., repeat_action_probability=..., full_action_space=...)`. + +| Name | `obs_type=` | `frameskip=` | `repeat_action_probability=` | `full_action_space=` | +|-------------------------------|-------------|--------------|------------------------------|----------------------| +| Adventure-v0 | `"rgb"` | `(2, 5,)` | `0.25` | `False` | +| AdventureDeterministic-v0 | `"rgb"` | `4` | `0.25` | `False` | +| AdventureNoframeskip-v0 | `"rgb"` | `1` | `0.25` | `False` | +| Adventure-ram-v0 | `"ram"` | `(2, 5,)` | `0.25` | `False` | +| Adventure-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | `False` | +| Adventure-ramNoframeskip-v0 | `"ram"` | `1` | `0.25` | `False` | +| Adventure-v4 | `"rgb"` | `(2, 5,)` | `0.0` | `False` | +| AdventureDeterministic-v4 | `"rgb"` | `4` | `0.0` | `False` | +| AdventureNoframeskip-v4 | `"rgb"` | `1` | `0.0` | `False` | +| Adventure-ram-v4 | `"ram"` | `(2, 5,)` | `0.0` | `False` | +| Adventure-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | `False` | +| Adventure-ramNoframeskip-v4 | `"ram"` | `1` | `0.0` | `False` | +| ALE/Adventure-ram-v5 | `"ram"` | `4` | `0.25` | `False` | ## Flavors diff --git a/docs/environments/adventure.md b/docs/environments/adventure.md index e98d489fe..4cb4b825e 100644 --- a/docs/environments/adventure.md +++ b/docs/environments/adventure.md @@ -4,18 +4,18 @@ title: Adventure # Adventure -```{figure} ../_static/videos/environments/adventure.gif +```{figure} ../../_static/videos/environments/adventure.gif :width: 120px :name: Adventure ``` 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/Adventure-v5")` | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | +| Creation | make(ALE/Adventure-v5) | For more Adventure variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by Adventure has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Adventure-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Adventure-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Adventure-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Adventure-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AdventureDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AdventureNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Adventure-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Adventure-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Adventure-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Adventure-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AdventureDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AdventureNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Adventure-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Adventure-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Adventure-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AdventureNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/air_raid.md b/docs/environments/air_raid.md index ca44d69a7..8941275d4 100644 --- a/docs/environments/air_raid.md +++ b/docs/environments/air_raid.md @@ -4,18 +4,18 @@ title: AirRaid # AirRaid -```{figure} ../_static/videos/environments/air_raid.gif +```{figure} ../../_static/videos/environments/air_raid.gif :width: 120px :name: AirRaid ``` 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/AirRaid-v5")` | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | +| Creation | make(ALE/AirRaid-v5) | For more AirRaid variants with different observation and action spaces, see the variants section. @@ -52,22 +52,11 @@ See variants section for the type of observation used by each environment id by AirRaid has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| AirRaid-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| AirRaid-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| AirRaid-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| AirRaid-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AirRaidDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AirRaidNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| AirRaid-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| AirRaid-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| AirRaid-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| AirRaid-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AirRaidDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AirRaidNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/AirRaid-v5 | `"rgb"` | `4` | `0.25` | -| ALE/AirRaid-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/AirRaid-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AirRaidNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/alien.md b/docs/environments/alien.md index 2f0590d19..70d9bb04d 100644 --- a/docs/environments/alien.md +++ b/docs/environments/alien.md @@ -4,7 +4,7 @@ title: Alien # Alien -```{figure} ../_static/videos/environments/alien.gif +```{figure} ../../_static/videos/environments/alien.gif :width: 120px :name: Alien ``` @@ -15,13 +15,13 @@ This environment is part of the Atari environments. Please read |-------------------|-----------------------------------| | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Alien-v5")` | +| Creation | make(ALE/Alien-v5) | For more Alien variants with different observation and action spaces, see the variants section. ## 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. +You are stuck in a maze-like spaceship with three aliens. Your 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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815) @@ -62,22 +62,11 @@ table of scores corresponding to the different achievements, consult [the AtariA Alien has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| Alien-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Alien-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Alien-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Alien-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AlienDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AlienNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Alien-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Alien-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Alien-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Alien-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AlienDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AlienNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Alien-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Alien-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------|-------------|--------------|------------------------------| +| ALE/Alien-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AlienNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md index 5d90d356c..6e1abd194 100644 --- a/docs/environments/amidar.md +++ b/docs/environments/amidar.md @@ -4,18 +4,18 @@ title: Amidar # Amidar -```{figure} ../_static/videos/environments/amidar.gif +```{figure} ../../_static/videos/environments/amidar.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Amidar-v5) | For more Amidar variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Amidar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Amidar-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Amidar-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Amidar-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Amidar-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AmidarDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AmidarNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Amidar-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Amidar-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Amidar-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Amidar-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AmidarDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AmidarNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Amidar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Amidar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Amidar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AmidarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/assault.md b/docs/environments/assault.md index 950c9086e..20e7076d6 100644 --- a/docs/environments/assault.md +++ b/docs/environments/assault.md @@ -4,18 +4,18 @@ title: Assault # Assault -```{figure} ../_static/videos/environments/assault.gif +```{figure} ../../_static/videos/environments/assault.gif :width: 120px :name: Assault ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(7) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(7) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Assault-v5")` | +| Creation | make(ALE/Assault-v5) | For more Assault variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by Assault has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Assault-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Assault-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Assault-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Assault-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AssaultDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AssaultNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Assault-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Assault-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Assault-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Assault-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AssaultDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AssaultNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Assault-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Assault-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Assault-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AssaultNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/asterix.md b/docs/environments/asterix.md index a54b7eb7b..2d3769c58 100644 --- a/docs/environments/asterix.md +++ b/docs/environments/asterix.md @@ -4,18 +4,18 @@ title: Asterix # Asterix -```{figure} ../_static/videos/environments/asterix.gif +```{figure} ../../_static/videos/environments/asterix.gif :width: 120px :name: Asterix ``` 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/Asterix-v5")` | +| Creation | make(ALE/Asterix-v5) | For more Asterix variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ A table of scores awarded for collecting the different objects is provided on [t Asterix has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Asterix-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Asterix-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Asterix-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Asterix-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AsterixDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AsterixNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Asterix-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Asterix-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Asterix-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Asterix-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AsterixDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AsterixNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Asterix-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Asterix-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Asterix-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsterixNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/asteroids.md b/docs/environments/asteroids.md index 60e509514..222c2929e 100644 --- a/docs/environments/asteroids.md +++ b/docs/environments/asteroids.md @@ -4,18 +4,18 @@ title: Asteroids # Asteroids -```{figure} ../_static/videos/environments/asteroids.gif +```{figure} ../../_static/videos/environments/asteroids.gif :width: 120px :name: Asteroids ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(14) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(14) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Asteroids-v5")` | +| Creation | make(ALE/Asteroids-v5) | For more Asteroids variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Asteroids has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Asteroids-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Asteroids-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Asteroids-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Asteroids-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AsteroidsDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AsteroidsNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Asteroids-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Asteroids-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Asteroids-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Asteroids-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AsteroidsDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AsteroidsNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Asteroids-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Asteroids-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Asteroids-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsteroidsNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md index a58ed9f1c..c49ded24d 100644 --- a/docs/environments/atlantis.md +++ b/docs/environments/atlantis.md @@ -4,18 +4,18 @@ title: Atlantis # Atlantis -```{figure} ../_static/videos/environments/atlantis.gif +```{figure} ../../_static/videos/environments/atlantis.gif :width: 120px :name: Atlantis ``` 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/Atlantis-v5")` | +| Creation | make(ALE/Atlantis-v5) | For more Atlantis variants with different observation and action spaces, see the variants section. @@ -59,24 +59,12 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Atlantis has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Atlantis-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Atlantis-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Atlantis-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Atlantis-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AtlantisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AtlantisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Atlantis-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Atlantis-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Atlantis-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Atlantis-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AtlantisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AtlantisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Atlantis-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Atlantis-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AtlantisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/atlantis2.md b/docs/environments/atlantis2.md index b9f463f52..cfdf198e0 100644 --- a/docs/environments/atlantis2.md +++ b/docs/environments/atlantis2.md @@ -4,18 +4,18 @@ title: Atlantis2 # Atlantis2 -```{figure} ../_static/videos/environments/atlantis2.gif +```{figure} ../../_static/videos/environments/atlantis2.gif :width: 120px :name: Atlantis2 ``` 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/Atlantis2-v5")` | +| Creation | make(ALE/Atlantis2-v5) | For more Atlantis2 variants with different observation and action spaces, see the variants section. @@ -52,10 +52,11 @@ See variants section for the type of observation used by each environment id by Atlantis2 has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `Atlantis2NoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/backgammon.md b/docs/environments/backgammon.md index b73a16445..9c9544050 100644 --- a/docs/environments/backgammon.md +++ b/docs/environments/backgammon.md @@ -4,18 +4,18 @@ title: Backgammon # Backgammon -```{figure} ../_static/videos/environments/backgammon.gif +```{figure} ../../_static/videos/environments/backgammon.gif :width: 120px :name: Backgammon ``` 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/Backgammon-v5")` | +| Creation | make(ALE/Backgammon-v5) | For more Backgammon variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Backgammon has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/Backgammon-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Backgammon-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/Backgammon-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BackgammonNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/bank_heist.md b/docs/environments/bank_heist.md index b29ada37b..4a5e41084 100644 --- a/docs/environments/bank_heist.md +++ b/docs/environments/bank_heist.md @@ -4,18 +4,18 @@ title: BankHeist # BankHeist -```{figure} ../_static/videos/environments/bank_heist.gif +```{figure} ../../_static/videos/environments/bank_heist.gif :width: 120px :name: BankHeist ``` 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/BankHeist-v5")` | +| Creation | make(ALE/BankHeist-v5) | For more BankHeist variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ BankHeist has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| BankHeist-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BankHeist-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BankHeist-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BankHeist-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BankHeistDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BankHeistNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BankHeist-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BankHeist-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BankHeist-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BankHeist-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BankHeistDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BankHeistNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BankHeist-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BankHeist-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BankHeist-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BankHeistNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md index 65271b72f..77819c6c2 100644 --- a/docs/environments/basic_math.md +++ b/docs/environments/basic_math.md @@ -4,18 +4,18 @@ title: BasicMath # BasicMath -```{figure} ../_static/videos/environments/basic_math.gif +```{figure} ../../_static/videos/environments/basic_math.gif :width: 120px :name: BasicMath ``` 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/BasicMath-v5")` | +| Creation | make(ALE/BasicMath-v5) | For more BasicMath variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by BasicMath has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/BasicMath-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BasicMath-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BasicMath-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BasicMathNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/battle_zone.md b/docs/environments/battle_zone.md index a006a3594..4bbb88caf 100644 --- a/docs/environments/battle_zone.md +++ b/docs/environments/battle_zone.md @@ -4,18 +4,18 @@ title: BattleZone # BattleZone -```{figure} ../_static/videos/environments/battle_zone.gif +```{figure} ../../_static/videos/environments/battle_zone.gif :width: 120px :name: BattleZone ``` 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/BattleZone-v5")` | +| Creation | make(ALE/BattleZone-v5) | For more BattleZone variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ BattleZone has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| BattleZone-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BattleZone-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BattleZone-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BattleZone-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BattleZoneDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BattleZoneNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BattleZone-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BattleZone-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BattleZone-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BattleZone-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BattleZoneDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BattleZoneNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BattleZone-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BattleZone-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/BattleZone-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BattleZoneNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md index eb282790b..e859297ce 100644 --- a/docs/environments/beam_rider.md +++ b/docs/environments/beam_rider.md @@ -4,18 +4,18 @@ title: BeamRider # BeamRider -```{figure} ../_static/videos/environments/beam_rider.gif +```{figure} ../../_static/videos/environments/beam_rider.gif :width: 120px :name: BeamRider ``` 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/BeamRider-v5")` | +| Creation | make(ALE/BeamRider-v5) | For more BeamRider variants with different observation and action spaces, see the variants section. @@ -59,22 +59,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ BeamRider has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| BeamRider-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BeamRider-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BeamRider-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BeamRider-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BeamRiderDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BeamRiderNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BeamRider-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BeamRider-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BeamRider-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BeamRider-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BeamRiderDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BeamRiderNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BeamRider-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BeamRider-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BeamRider-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BeamRiderNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md index 9977ef9bd..877a2a08d 100644 --- a/docs/environments/berzerk.md +++ b/docs/environments/berzerk.md @@ -4,18 +4,18 @@ title: Berzerk # Berzerk -```{figure} ../_static/videos/environments/berzerk.gif +```{figure} ../../_static/videos/environments/berzerk.gif :width: 120px :name: Berzerk ``` 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/Berzerk-v5")` | +| Creation | make(ALE/Berzerk-v5) | For more Berzerk variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Berzerk has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Berzerk-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Berzerk-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Berzerk-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Berzerk-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BerzerkDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BerzerkNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Berzerk-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Berzerk-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Berzerk-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Berzerk-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BerzerkDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BerzerkNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Berzerk-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Berzerk-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Berzerk-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BerzerkNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md index 1af52e499..5b2a6ddf9 100644 --- a/docs/environments/blackjack.md +++ b/docs/environments/blackjack.md @@ -4,18 +4,18 @@ title: Blackjack # Blackjack -```{figure} ../_static/videos/environments/blackjack.gif +```{figure} ../../_static/videos/environments/blackjack.gif :width: 120px :name: Blackjack ``` 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/Blackjack-v5")` | +| Creation | make(ALE/Blackjack-v5) | For more Blackjack variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Blackjack has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/Blackjack-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Blackjack-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Blackjack-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BlackjackNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/bowling.md b/docs/environments/bowling.md index b6c95b285..83926337e 100644 --- a/docs/environments/bowling.md +++ b/docs/environments/bowling.md @@ -4,18 +4,18 @@ title: Bowling # Bowling -```{figure} ../_static/videos/environments/bowling.gif +```{figure} ../../_static/videos/environments/bowling.gif :width: 120px :name: Bowling ``` 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/Bowling-v5")` | +| Creation | make(ALE/Bowling-v5) | For more Bowling variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Bowling has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Bowling-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Bowling-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Bowling-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Bowling-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BowlingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BowlingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Bowling-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Bowling-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Bowling-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Bowling-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BowlingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BowlingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Bowling-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Bowling-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Bowling-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BowlingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md index 4116d977c..94a0601c8 100644 --- a/docs/environments/boxing.md +++ b/docs/environments/boxing.md @@ -4,18 +4,18 @@ title: Boxing # Boxing -```{figure} ../_static/videos/environments/boxing.gif +```{figure} ../../_static/videos/environments/boxing.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Boxing-v5) | For more Boxing variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Boxing has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Boxing-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Boxing-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Boxing-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Boxing-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BoxingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BoxingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Boxing-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Boxing-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Boxing-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Boxing-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BoxingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BoxingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Boxing-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Boxing-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Boxing-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BoxingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md index 59d629e6a..c02688410 100644 --- a/docs/environments/breakout.md +++ b/docs/environments/breakout.md @@ -4,18 +4,18 @@ title: Breakout # Breakout -```{figure} ../_static/videos/environments/breakout.gif +```{figure} ../../_static/videos/environments/breakout.gif :width: 120px :name: Breakout ``` 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/Breakout-v5")` | +| Creation | make(ALE/Breakout-v5) | For more Breakout variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Breakout has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Breakout-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Breakout-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Breakout-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Breakout-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BreakoutDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BreakoutNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Breakout-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Breakout-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Breakout-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Breakout-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BreakoutDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BreakoutNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Breakout-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Breakout-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Breakout-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BreakoutNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md index 8736f75de..d1d4cce65 100644 --- a/docs/environments/carnival.md +++ b/docs/environments/carnival.md @@ -4,18 +4,18 @@ title: Carnival # Carnival -```{figure} ../_static/videos/environments/carnival.gif +```{figure} ../../_static/videos/environments/carnival.gif :width: 120px :name: Carnival ``` 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, (214, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Carnival-v5")` | +| Creation | make(ALE/Carnival-v5) | For more Carnival variants with different observation and action spaces, see the variants section. @@ -59,22 +59,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Carnival has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Carnival-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Carnival-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Carnival-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Carnival-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CarnivalDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CarnivalNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Carnival-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Carnival-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Carnival-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Carnival-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CarnivalDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CarnivalNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Carnival-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Carnival-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Carnival-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CarnivalNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/casino.md b/docs/environments/casino.md index b43f782aa..0d63c0dbd 100644 --- a/docs/environments/casino.md +++ b/docs/environments/casino.md @@ -4,18 +4,18 @@ title: Casino # Casino -```{figure} ../_static/videos/environments/casino.gif +```{figure} ../../_static/videos/environments/casino.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Casino-v5) | For more Casino variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Casino has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Casino-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Casino-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Casino-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CasinoNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/centipede.md b/docs/environments/centipede.md index c46e84aeb..8791ed012 100644 --- a/docs/environments/centipede.md +++ b/docs/environments/centipede.md @@ -4,18 +4,18 @@ title: Centipede # Centipede -```{figure} ../_static/videos/environments/centipede.gif +```{figure} ../../_static/videos/environments/centipede.gif :width: 120px :name: Centipede ``` 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/Centipede-v5")` | +| Creation | make(ALE/Centipede-v5) | For more Centipede variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ Detailed documentation can be found on [the AtariAge page](https://atariage.com/ Centipede has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Centipede-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Centipede-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Centipede-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Centipede-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CentipedeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CentipedeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Centipede-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Centipede-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Centipede-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Centipede-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CentipedeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CentipedeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Centipede-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Centipede-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Centipede-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CentipedeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/chopper_command.md b/docs/environments/chopper_command.md index 033cbeb3d..467c4f240 100644 --- a/docs/environments/chopper_command.md +++ b/docs/environments/chopper_command.md @@ -4,18 +4,18 @@ title: ChopperCommand # ChopperCommand -```{figure} ../_static/videos/environments/chopper_command.gif +```{figure} ../../_static/videos/environments/chopper_command.gif :width: 120px :name: ChopperCommand ``` 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/ChopperCommand-v5")` | +| Creation | make(ALE/ChopperCommand-v5) | For more ChopperCommand variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ Detailed documentation can be found on [the AtariAge page](https://atariage.com/ ChopperCommand has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------------|-------------|--------------|------------------------------| -| ChopperCommand-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| ChopperCommand-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| ChopperCommand-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| ChopperCommand-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ChopperCommandDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ChopperCommandNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| ChopperCommand-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| ChopperCommand-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| ChopperCommand-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| ChopperCommand-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ChopperCommandDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ChopperCommandNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/ChopperCommand-v5 | `"rgb"` | `4` | `0.25` | -| ALE/ChopperCommand-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/ChopperCommand-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ChopperCommandNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/crazy_climber.md b/docs/environments/crazy_climber.md index bac52d24c..a6dba9b4a 100644 --- a/docs/environments/crazy_climber.md +++ b/docs/environments/crazy_climber.md @@ -4,18 +4,18 @@ title: CrazyClimber # CrazyClimber -```{figure} ../_static/videos/environments/crazy_climber.gif +```{figure} ../../_static/videos/environments/crazy_climber.gif :width: 120px :name: CrazyClimber ``` 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/CrazyClimber-v5")` | +| Creation | make(ALE/CrazyClimber-v5) | For more CrazyClimber variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ A table of scores awarded for completing each row of a building is provided on [ CrazyClimber has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| CrazyClimber-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| CrazyClimber-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| CrazyClimber-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| CrazyClimber-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CrazyClimberDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CrazyClimberNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| CrazyClimber-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| CrazyClimber-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| CrazyClimber-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| CrazyClimber-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CrazyClimberDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CrazyClimberNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/CrazyClimber-v5 | `"rgb"` | `4` | `0.25` | -| ALE/CrazyClimber-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/CrazyClimber-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CrazyClimberNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/crossbow.md b/docs/environments/crossbow.md index 701124b72..93a6dd575 100644 --- a/docs/environments/crossbow.md +++ b/docs/environments/crossbow.md @@ -4,18 +4,18 @@ title: Crossbow # Crossbow -```{figure} ../_static/videos/environments/crossbow.gif +```{figure} ../../_static/videos/environments/crossbow.gif :width: 120px :name: Crossbow ``` 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/Crossbow-v5")` | +| Creation | make(ALE/Crossbow-v5) | For more Crossbow variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Crossbow has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Crossbow-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Crossbow-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Crossbow-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CrossbowNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/darkchambers.md b/docs/environments/darkchambers.md index cb1974cb5..bb5030846 100644 --- a/docs/environments/darkchambers.md +++ b/docs/environments/darkchambers.md @@ -4,18 +4,18 @@ title: Darkchambers # Darkchambers -```{figure} ../_static/videos/environments/darkchambers.gif +```{figure} ../../_static/videos/environments/darkchambers.gif :width: 120px :name: Darkchambers ``` 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/Darkchambers-v5")` | +| Creation | make(ALE/Darkchambers-v5) | For more Darkchambers variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Darkchambers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------|-------------|--------------|------------------------------| -| ALE/Darkchambers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Darkchambers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/Darkchambers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DarkchambersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/defender.md b/docs/environments/defender.md index 611faf013..c2a58ff10 100644 --- a/docs/environments/defender.md +++ b/docs/environments/defender.md @@ -4,18 +4,18 @@ title: Defender # Defender -```{figure} ../_static/videos/environments/defender.gif +```{figure} ../../_static/videos/environments/defender.gif :width: 120px :name: Defender ``` 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/Defender-v5")` | +| Creation | make(ALE/Defender-v5) | For more Defender variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Defender has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Defender-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Defender-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Defender-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Defender-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DefenderDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DefenderNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Defender-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Defender-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Defender-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Defender-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DefenderDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DefenderNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Defender-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Defender-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Defender-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DefenderNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/demon_attack.md b/docs/environments/demon_attack.md index bc213e027..57763f433 100644 --- a/docs/environments/demon_attack.md +++ b/docs/environments/demon_attack.md @@ -4,18 +4,18 @@ title: DemonAttack # DemonAttack -```{figure} ../_static/videos/environments/demon_attack.gif +```{figure} ../../_static/videos/environments/demon_attack.gif :width: 120px :name: DemonAttack ``` 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/DemonAttack-v5")` | +| Creation | make(ALE/DemonAttack-v5) | For more DemonAttack variants with different observation and action spaces, see the variants section. @@ -59,22 +59,11 @@ page](https://atariage.com/manual_html_page.php?SoftwareLabelID=135). DemonAttack has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| DemonAttack-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| DemonAttack-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| DemonAttack-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| DemonAttack-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DemonAttackDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DemonAttackNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| DemonAttack-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| DemonAttack-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| DemonAttack-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| DemonAttack-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DemonAttackDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DemonAttackNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/DemonAttack-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DemonAttack-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/DemonAttack-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DemonAttackNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/donkey_kong.md b/docs/environments/donkey_kong.md index df8393507..78d5820d4 100644 --- a/docs/environments/donkey_kong.md +++ b/docs/environments/donkey_kong.md @@ -4,18 +4,18 @@ title: DonkeyKong # DonkeyKong -```{figure} ../_static/videos/environments/donkey_kong.gif +```{figure} ../../_static/videos/environments/donkey_kong.gif :width: 120px :name: DonkeyKong ``` 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/DonkeyKong-v5")` | +| Creation | make(ALE/DonkeyKong-v5) | For more DonkeyKong variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by DonkeyKong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/DonkeyKong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DonkeyKong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/DonkeyKong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DonkeyKongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/double_dunk.md b/docs/environments/double_dunk.md index 4a224cb21..fe20524b4 100644 --- a/docs/environments/double_dunk.md +++ b/docs/environments/double_dunk.md @@ -4,18 +4,18 @@ title: DoubleDunk # DoubleDunk -```{figure} ../_static/videos/environments/double_dunk.gif +```{figure} ../../_static/videos/environments/double_dunk.gif :width: 120px :name: DoubleDunk ``` 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/DoubleDunk-v5")` | +| Creation | make(ALE/DoubleDunk-v5) | For more DoubleDunk variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ point. DoubleDunk has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| DoubleDunk-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| DoubleDunk-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| DoubleDunk-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| DoubleDunk-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DoubleDunkDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DoubleDunkNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| DoubleDunk-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| DoubleDunk-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| DoubleDunk-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| DoubleDunk-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DoubleDunkDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DoubleDunkNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/DoubleDunk-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DoubleDunk-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/DoubleDunk-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DoubleDunkNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/earthworld.md b/docs/environments/earthworld.md index c64f2caec..f0e335fb9 100644 --- a/docs/environments/earthworld.md +++ b/docs/environments/earthworld.md @@ -4,18 +4,18 @@ title: Earthworld # Earthworld -```{figure} ../_static/videos/environments/earthworld.gif +```{figure} ../../_static/videos/environments/earthworld.gif :width: 120px :name: Earthworld ``` 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/Earthworld-v5")` | +| Creation | make(ALE/Earthworld-v5) | For more Earthworld variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Earthworld has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/Earthworld-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Earthworld-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/Earthworld-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EarthworldNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/elevator_action.md b/docs/environments/elevator_action.md index bef8673b3..da34ad0cd 100644 --- a/docs/environments/elevator_action.md +++ b/docs/environments/elevator_action.md @@ -4,18 +4,18 @@ title: ElevatorAction # ElevatorAction -```{figure} ../_static/videos/environments/elevator_action.gif +```{figure} ../../_static/videos/environments/elevator_action.gif :width: 120px :name: ElevatorAction ``` 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/ElevatorAction-v5")` | +| Creation | make(ALE/ElevatorAction-v5) | For more ElevatorAction variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ game ends when losing all lives. ElevatorAction has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------------|-------------|--------------|------------------------------| -| ElevatorAction-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| ElevatorAction-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| ElevatorAction-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| ElevatorAction-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ElevatorActionDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ElevatorActionNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| ElevatorAction-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| ElevatorAction-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| ElevatorAction-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| ElevatorAction-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ElevatorActionDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ElevatorActionNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/ElevatorAction-v5 | `"rgb"` | `4` | `0.25` | -| ALE/ElevatorAction-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/ElevatorAction-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ElevatorActionNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/enduro.md b/docs/environments/enduro.md index 39316d6d1..89c215a0e 100644 --- a/docs/environments/enduro.md +++ b/docs/environments/enduro.md @@ -4,18 +4,18 @@ title: Enduro # Enduro -```{figure} ../_static/videos/environments/enduro.gif +```{figure} ../../_static/videos/environments/enduro.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Enduro-v5) | For more Enduro variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ You get 1 point for each vehicle you overtake. Enduro has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Enduro-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Enduro-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Enduro-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Enduro-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| EnduroDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| EnduroNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Enduro-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Enduro-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Enduro-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Enduro-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| EnduroDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| EnduroNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Enduro-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Enduro-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Enduro-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EnduroNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/entombed.md b/docs/environments/entombed.md index 7ecc53241..0840facec 100644 --- a/docs/environments/entombed.md +++ b/docs/environments/entombed.md @@ -4,18 +4,18 @@ title: Entombed # Entombed -```{figure} ../_static/videos/environments/entombed.gif +```{figure} ../../_static/videos/environments/entombed.gif :width: 120px :name: Entombed ``` 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/Entombed-v5")` | +| Creation | make(ALE/Entombed-v5) | For more Entombed variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Entombed has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Entombed-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Entombed-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Entombed-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EntombedNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/et.md b/docs/environments/et.md index a1e15a127..e26862cbc 100644 --- a/docs/environments/et.md +++ b/docs/environments/et.md @@ -4,18 +4,18 @@ title: Et # Et -```{figure} ../_static/videos/environments/et.gif +```{figure} ../../_static/videos/environments/et.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Et-v5) | For more Et variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Et has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------|-------------|--------------|------------------------------| -| ALE/Et-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Et-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------|-------------|--------------|------------------------------| +| ALE/Et-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EtNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/fishing_derby.md b/docs/environments/fishing_derby.md index d5080d0d9..c5f2aef37 100644 --- a/docs/environments/fishing_derby.md +++ b/docs/environments/fishing_derby.md @@ -4,18 +4,18 @@ title: FishingDerby # FishingDerby -```{figure} ../_static/videos/environments/fishing_derby.gif +```{figure} ../../_static/videos/environments/fishing_derby.gif :width: 120px :name: FishingDerby ``` 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/FishingDerby-v5")` | +| Creation | make(ALE/FishingDerby-v5) | For more FishingDerby variants with different observation and action spaces, see the variants section. @@ -56,27 +56,17 @@ See variants section for the type of observation used by each environment id by 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 FishingDerby has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| FishingDerby-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| FishingDerby-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| FishingDerby-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| FishingDerby-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FishingDerbyDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FishingDerbyNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| FishingDerby-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| FishingDerby-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| FishingDerby-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| FishingDerby-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FishingDerbyDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FishingDerbyNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/FishingDerby-v5 | `"rgb"` | `4` | `0.25` | -| ALE/FishingDerby-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/FishingDerby-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FishingDerbyNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/flag_capture.md b/docs/environments/flag_capture.md index ac84372c6..e1538cf6c 100644 --- a/docs/environments/flag_capture.md +++ b/docs/environments/flag_capture.md @@ -4,18 +4,18 @@ title: FlagCapture # FlagCapture -```{figure} ../_static/videos/environments/flag_capture.gif +```{figure} ../../_static/videos/environments/flag_capture.gif :width: 120px :name: FlagCapture ``` 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/FlagCapture-v5")` | +| Creation | make(ALE/FlagCapture-v5) | For more FlagCapture variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by FlagCapture has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/FlagCapture-v5 | `"rgb"` | `4` | `0.25` | -| ALE/FlagCapture-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/FlagCapture-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FlagCaptureNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/freeway.md b/docs/environments/freeway.md index e975d8240..7c9742b59 100644 --- a/docs/environments/freeway.md +++ b/docs/environments/freeway.md @@ -4,18 +4,18 @@ title: Freeway # Freeway -```{figure} ../_static/videos/environments/freeway.gif +```{figure} ../../_static/videos/environments/freeway.gif :width: 120px :name: Freeway ``` 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/Freeway-v5")` | +| Creation | make(ALE/Freeway-v5) | For more Freeway variants with different observation and action spaces, see the variants section. @@ -52,27 +52,17 @@ See variants section for the type of observation used by each environment id by 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). +Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1). ## Variants Freeway has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Freeway-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Freeway-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Freeway-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Freeway-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FreewayDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FreewayNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Freeway-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Freeway-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Freeway-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Freeway-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FreewayDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FreewayNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Freeway-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Freeway-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Freeway-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FreewayNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/frogger.md b/docs/environments/frogger.md index 18404c2b5..94fe19fbd 100644 --- a/docs/environments/frogger.md +++ b/docs/environments/frogger.md @@ -4,18 +4,18 @@ title: Frogger # Frogger -```{figure} ../_static/videos/environments/frogger.gif +```{figure} ../../_static/videos/environments/frogger.gif :width: 120px :name: Frogger ``` 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/Frogger-v5")` | +| Creation | make(ALE/Frogger-v5) | For more Frogger variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Frogger has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Frogger-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Frogger-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Frogger-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FroggerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/frostbite.md b/docs/environments/frostbite.md index daa30f120..6e33aa80a 100644 --- a/docs/environments/frostbite.md +++ b/docs/environments/frostbite.md @@ -4,18 +4,18 @@ title: Frostbite # Frostbite -```{figure} ../_static/videos/environments/frostbite.gif +```{figure} ../../_static/videos/environments/frostbite.gif :width: 120px :name: Frostbite ``` 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/Frostbite-v5")` | +| Creation | make(ALE/Frostbite-v5) | For more Frostbite variants with different observation and action spaces, see the variants section. @@ -56,27 +56,17 @@ See variants section for the type of observation used by each environment id by 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). +Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1). ## Variants Frostbite has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Frostbite-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Frostbite-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Frostbite-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Frostbite-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FrostbiteDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FrostbiteNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Frostbite-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Frostbite-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Frostbite-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Frostbite-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FrostbiteDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FrostbiteNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Frostbite-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Frostbite-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Frostbite-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FrostbiteNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/galaxian.md b/docs/environments/galaxian.md index e82c66540..015d3189b 100644 --- a/docs/environments/galaxian.md +++ b/docs/environments/galaxian.md @@ -4,18 +4,18 @@ title: Galaxian # Galaxian -```{figure} ../_static/videos/environments/galaxian.gif +```{figure} ../../_static/videos/environments/galaxian.gif :width: 120px :name: Galaxian ``` 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/Galaxian-v5")` | +| Creation | make(ALE/Galaxian-v5) | For more Galaxian variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Galaxian has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Galaxian-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Galaxian-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Galaxian-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GalaxianNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/gopher.md b/docs/environments/gopher.md index 0d6d4624c..d6c830128 100644 --- a/docs/environments/gopher.md +++ b/docs/environments/gopher.md @@ -4,18 +4,18 @@ title: Gopher # Gopher -```{figure} ../_static/videos/environments/gopher.gif +```{figure} ../../_static/videos/environments/gopher.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Gopher-v5) | For more Gopher variants with different observation and action spaces, see the variants section. @@ -54,27 +54,17 @@ See variants section for the type of observation used by each environment id by 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). +Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1). ## Variants Gopher has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Gopher-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Gopher-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Gopher-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Gopher-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| GopherDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| GopherNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Gopher-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Gopher-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Gopher-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Gopher-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| GopherDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| GopherNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Gopher-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Gopher-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Gopher-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GopherNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/gravitar.md b/docs/environments/gravitar.md index f30091132..5b67ac30b 100644 --- a/docs/environments/gravitar.md +++ b/docs/environments/gravitar.md @@ -4,18 +4,18 @@ title: Gravitar # Gravitar -```{figure} ../_static/videos/environments/gravitar.gif +```{figure} ../../_static/videos/environments/gravitar.gif :width: 120px :name: Gravitar ``` 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/Gravitar-v5")` | +| Creation | make(ALE/Gravitar-v5) | For more Gravitar variants with different observation and action spaces, see the variants section. @@ -56,27 +56,17 @@ See variants section for the type of observation used by each environment id by 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). +Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1). ## Variants Gravitar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Gravitar-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Gravitar-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Gravitar-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Gravitar-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| GravitarDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| GravitarNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Gravitar-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Gravitar-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Gravitar-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Gravitar-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| GravitarDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| GravitarNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Gravitar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Gravitar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Gravitar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GravitarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/hangman.md b/docs/environments/hangman.md index b0fbd349e..951458f56 100644 --- a/docs/environments/hangman.md +++ b/docs/environments/hangman.md @@ -4,18 +4,18 @@ title: Hangman # Hangman -```{figure} ../_static/videos/environments/hangman.gif +```{figure} ../../_static/videos/environments/hangman.gif :width: 120px :name: Hangman ``` 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/Hangman-v5")` | +| Creation | make(ALE/Hangman-v5) | For more Hangman variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Hangman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Hangman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Hangman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Hangman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HangmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/haunted_house.md b/docs/environments/haunted_house.md index 4f8b137d6..af37e07eb 100644 --- a/docs/environments/haunted_house.md +++ b/docs/environments/haunted_house.md @@ -4,18 +4,18 @@ title: HauntedHouse # HauntedHouse -```{figure} ../_static/videos/environments/haunted_house.gif +```{figure} ../../_static/videos/environments/haunted_house.gif :width: 120px :name: HauntedHouse ``` 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/HauntedHouse-v5")` | +| Creation | make(ALE/HauntedHouse-v5) | For more HauntedHouse variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by HauntedHouse has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------|-------------|--------------|------------------------------| -| ALE/HauntedHouse-v5 | `"rgb"` | `4` | `0.25` | -| ALE/HauntedHouse-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/HauntedHouse-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HauntedHouseNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/hero.md b/docs/environments/hero.md index 4787c2ef3..637f31d24 100644 --- a/docs/environments/hero.md +++ b/docs/environments/hero.md @@ -4,18 +4,18 @@ title: Hero # Hero -```{figure} ../_static/videos/environments/hero.gif +```{figure} ../../_static/videos/environments/hero.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Hero-v5) | For more Hero variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Hero has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| Hero-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Hero-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Hero-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Hero-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| HeroDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| HeroNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Hero-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Hero-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Hero-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Hero-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| HeroDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| HeroNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Hero-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Hero-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Hero-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HeroNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/human_cannonball.md b/docs/environments/human_cannonball.md index 79dcae822..751f08656 100644 --- a/docs/environments/human_cannonball.md +++ b/docs/environments/human_cannonball.md @@ -4,18 +4,18 @@ title: HumanCannonball # HumanCannonball -```{figure} ../_static/videos/environments/human_cannonball.gif +```{figure} ../../_static/videos/environments/human_cannonball.gif :width: 120px :name: HumanCannonball ``` 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/HumanCannonball-v5")` | +| Creation | make(ALE/HumanCannonball-v5) | For more HumanCannonball variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by HumanCannonball has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| ALE/HumanCannonball-v5 | `"rgb"` | `4` | `0.25` | -| ALE/HumanCannonball-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------------|-------------|--------------|------------------------------| +| ALE/HumanCannonball-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HumanCannonballNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/ice_hockey.md b/docs/environments/ice_hockey.md index 041ba6979..781b608c9 100644 --- a/docs/environments/ice_hockey.md +++ b/docs/environments/ice_hockey.md @@ -4,18 +4,18 @@ title: IceHockey # IceHockey -```{figure} ../_static/videos/environments/ice_hockey.gif +```{figure} ../../_static/videos/environments/ice_hockey.gif :width: 120px :name: IceHockey ``` 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/IceHockey-v5")` | +| Creation | make(ALE/IceHockey-v5) | For more IceHockey variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, consult [the AtariAge page](https://atariage. IceHockey has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| IceHockey-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| IceHockey-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| IceHockey-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| IceHockey-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| IceHockeyDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| IceHockeyNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| IceHockey-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| IceHockey-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| IceHockey-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| IceHockey-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| IceHockeyDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| IceHockeyNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/IceHockey-v5 | `"rgb"` | `4` | `0.25` | -| ALE/IceHockey-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/IceHockey-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `IceHockeyNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/jamesbond.md b/docs/environments/jamesbond.md index cf254d77c..757308a51 100644 --- a/docs/environments/jamesbond.md +++ b/docs/environments/jamesbond.md @@ -4,18 +4,18 @@ title: Jamesbond # Jamesbond -```{figure} ../_static/videos/environments/jamesbond.gif +```{figure} ../../_static/videos/environments/jamesbond.gif :width: 120px :name: Jamesbond ``` 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/Jamesbond-v5")` | +| Creation | make(ALE/Jamesbond-v5) | For more Jamesbond variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, consult [the AtariAge page](https://atariage. Jamesbond has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Jamesbond-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Jamesbond-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Jamesbond-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Jamesbond-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| JamesbondDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| JamesbondNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Jamesbond-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Jamesbond-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Jamesbond-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Jamesbond-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| JamesbondDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| JamesbondNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Jamesbond-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Jamesbond-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Jamesbond-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `JamesbondNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/journey_escape.md b/docs/environments/journey_escape.md index 3a06e57a1..e815b40b1 100644 --- a/docs/environments/journey_escape.md +++ b/docs/environments/journey_escape.md @@ -4,18 +4,18 @@ title: JourneyEscape # JourneyEscape -```{figure} ../_static/videos/environments/journey_escape.gif +```{figure} ../../_static/videos/environments/journey_escape.gif :width: 120px :name: JourneyEscape ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(16) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(16) | | Observation Space | Box(0, 255, (230, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/JourneyEscape-v5")` | +| Creation | make(ALE/JourneyEscape-v5) | For more JourneyEscape variants with different observation and action spaces, see the variants section. @@ -63,22 +63,11 @@ For a more detailed documentation, consult [the AtariAge page](https://atariage. JourneyEscape has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------------|-------------|--------------|------------------------------| -| JourneyEscape-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| JourneyEscape-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| JourneyEscape-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| JourneyEscape-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| JourneyEscapeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| JourneyEscapeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| JourneyEscape-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| JourneyEscape-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| JourneyEscape-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| JourneyEscape-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| JourneyEscapeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| JourneyEscapeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/JourneyEscape-v5 | `"rgb"` | `4` | `0.25` | -| ALE/JourneyEscape-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/JourneyEscape-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `JourneyEscapeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kaboom.md b/docs/environments/kaboom.md index 50ed9a303..b233e8ccb 100644 --- a/docs/environments/kaboom.md +++ b/docs/environments/kaboom.md @@ -4,18 +4,18 @@ title: Kaboom # Kaboom -```{figure} ../_static/videos/environments/kaboom.gif +```{figure} ../../_static/videos/environments/kaboom.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Kaboom-v5) | For more Kaboom variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Kaboom has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Kaboom-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Kaboom-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Kaboom-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KaboomNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kangaroo.md b/docs/environments/kangaroo.md index 611b0871c..8ba21afdd 100644 --- a/docs/environments/kangaroo.md +++ b/docs/environments/kangaroo.md @@ -4,18 +4,18 @@ title: Kangaroo # Kangaroo -```{figure} ../_static/videos/environments/kangaroo.gif +```{figure} ../../_static/videos/environments/kangaroo.gif :width: 120px :name: Kangaroo ``` 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/Kangaroo-v5")` | +| Creation | make(ALE/Kangaroo-v5) | For more Kangaroo variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, consult [the AtariAge page](https://atariage. Kangaroo has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Kangaroo-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Kangaroo-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Kangaroo-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Kangaroo-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KangarooDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KangarooNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Kangaroo-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Kangaroo-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Kangaroo-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Kangaroo-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KangarooDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KangarooNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Kangaroo-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Kangaroo-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Kangaroo-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KangarooNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/keystone_kapers.md b/docs/environments/keystone_kapers.md index dd98bef62..7517cb8d1 100644 --- a/docs/environments/keystone_kapers.md +++ b/docs/environments/keystone_kapers.md @@ -4,18 +4,18 @@ title: KeystoneKapers # KeystoneKapers -```{figure} ../_static/videos/environments/keystone_kapers.gif +```{figure} ../../_static/videos/environments/keystone_kapers.gif :width: 120px :name: KeystoneKapers ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(14) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(14) | | Observation Space | Box(0, 255, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/KeystoneKapers-v5")` | +| Creation | make(ALE/KeystoneKapers-v5) | For more KeystoneKapers variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by KeystoneKapers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| ALE/KeystoneKapers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KeystoneKapers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/KeystoneKapers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KeystoneKapersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/king_kong.md b/docs/environments/king_kong.md index b5f29912b..61a483b54 100644 --- a/docs/environments/king_kong.md +++ b/docs/environments/king_kong.md @@ -4,18 +4,18 @@ title: KingKong # KingKong -```{figure} ../_static/videos/environments/king_kong.gif +```{figure} ../../_static/videos/environments/king_kong.gif :width: 120px :name: KingKong ``` 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, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/KingKong-v5")` | +| Creation | make(ALE/KingKong-v5) | For more KingKong variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by KingKong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/KingKong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KingKong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/KingKong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KingKongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/klax.md b/docs/environments/klax.md index 456ab1a0e..7dd3782da 100644 --- a/docs/environments/klax.md +++ b/docs/environments/klax.md @@ -4,18 +4,18 @@ title: Klax # Klax -```{figure} ../_static/videos/environments/klax.gif +```{figure} ../../_static/videos/environments/klax.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Klax-v5) | For more Klax variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Klax has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------|-------------|--------------|------------------------------| -| ALE/Klax-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Klax-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Klax-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KlaxNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/koolaid.md b/docs/environments/koolaid.md index 66f62250b..76ed8bc09 100644 --- a/docs/environments/koolaid.md +++ b/docs/environments/koolaid.md @@ -4,18 +4,18 @@ title: Koolaid # Koolaid -```{figure} ../_static/videos/environments/koolaid.gif +```{figure} ../../_static/videos/environments/koolaid.gif :width: 120px :name: Koolaid ``` 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/Koolaid-v5")` | +| Creation | make(ALE/Koolaid-v5) | For more Koolaid variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by Koolaid has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Koolaid-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Koolaid-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Koolaid-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KoolaidNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/krull.md b/docs/environments/krull.md index 2f9b87b19..4862543f8 100644 --- a/docs/environments/krull.md +++ b/docs/environments/krull.md @@ -4,18 +4,18 @@ title: Krull # Krull -```{figure} ../_static/videos/environments/krull.gif +```{figure} ../../_static/videos/environments/krull.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Krull-v5) | For more Krull variants with different observation and action spaces, see the variants section. @@ -62,22 +62,11 @@ For a more detailed documentation, consult [the AtariAge page](https://atariage. Krull has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| Krull-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Krull-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Krull-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Krull-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KrullDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KrullNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Krull-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Krull-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Krull-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Krull-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KrullDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KrullNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Krull-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Krull-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------|-------------|--------------|------------------------------| +| ALE/Krull-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KrullNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kung_fu_master.md b/docs/environments/kung_fu_master.md index ac4cce819..c14b9f75d 100644 --- a/docs/environments/kung_fu_master.md +++ b/docs/environments/kung_fu_master.md @@ -4,18 +4,18 @@ title: KungFuMaster # KungFuMaster -```{figure} ../_static/videos/environments/kung_fu_master.gif +```{figure} ../../_static/videos/environments/kung_fu_master.gif :width: 120px :name: KungFuMaster ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(14) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(14) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/KungFuMaster-v5")` | +| Creation | make(ALE/KungFuMaster-v5) | For more KungFuMaster variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by KungFuMaster has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| KungFuMaster-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| KungFuMaster-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| KungFuMaster-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| KungFuMaster-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KungFuMasterDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KungFuMasterNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| KungFuMaster-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| KungFuMaster-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| KungFuMaster-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| KungFuMaster-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KungFuMasterDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KungFuMasterNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/KungFuMaster-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KungFuMaster-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/KungFuMaster-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KungFuMasterNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/laser_gates.md b/docs/environments/laser_gates.md index 5121d2c93..40a74902f 100644 --- a/docs/environments/laser_gates.md +++ b/docs/environments/laser_gates.md @@ -4,18 +4,18 @@ title: LaserGates # LaserGates -```{figure} ../_static/videos/environments/laser_gates.gif +```{figure} ../../_static/videos/environments/laser_gates.gif :width: 120px :name: LaserGates ``` 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/LaserGates-v5")` | +| Creation | make(ALE/LaserGates-v5) | For more LaserGates variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by LaserGates has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/LaserGates-v5 | `"rgb"` | `4` | `0.25` | -| ALE/LaserGates-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/LaserGates-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `LaserGatesNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/lost_luggage.md b/docs/environments/lost_luggage.md index 79d2f91ac..d7731416c 100644 --- a/docs/environments/lost_luggage.md +++ b/docs/environments/lost_luggage.md @@ -4,18 +4,18 @@ title: LostLuggage # LostLuggage -```{figure} ../_static/videos/environments/lost_luggage.gif +```{figure} ../../_static/videos/environments/lost_luggage.gif :width: 120px :name: LostLuggage ``` 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/LostLuggage-v5")` | +| Creation | make(ALE/LostLuggage-v5) | For more LostLuggage variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by LostLuggage has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/LostLuggage-v5 | `"rgb"` | `4` | `0.25` | -| ALE/LostLuggage-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/LostLuggage-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `LostLuggageNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/mario_bros.md b/docs/environments/mario_bros.md index b98e18acd..2798f88e1 100644 --- a/docs/environments/mario_bros.md +++ b/docs/environments/mario_bros.md @@ -4,18 +4,18 @@ title: MarioBros # MarioBros -```{figure} ../_static/videos/environments/mario_bros.gif +```{figure} ../../_static/videos/environments/mario_bros.gif :width: 120px :name: MarioBros ``` 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/MarioBros-v5")` | +| Creation | make(ALE/MarioBros-v5) | For more MarioBros variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by MarioBros has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/MarioBros-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MarioBros-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/MarioBros-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MarioBrosNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/miniature_golf.md b/docs/environments/miniature_golf.md index 599f1db65..e592afa08 100644 --- a/docs/environments/miniature_golf.md +++ b/docs/environments/miniature_golf.md @@ -4,18 +4,18 @@ title: MiniatureGolf # MiniatureGolf -```{figure} ../_static/videos/environments/miniature_golf.gif +```{figure} ../../_static/videos/environments/miniature_golf.gif :width: 120px :name: MiniatureGolf ``` 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/MiniatureGolf-v5")` | +| Creation | make(ALE/MiniatureGolf-v5) | For more MiniatureGolf variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by MiniatureGolf has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| ALE/MiniatureGolf-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MiniatureGolf-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/MiniatureGolf-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MiniatureGolfNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/montezuma_revenge.md b/docs/environments/montezuma_revenge.md index a66aec96a..75763f182 100644 --- a/docs/environments/montezuma_revenge.md +++ b/docs/environments/montezuma_revenge.md @@ -4,18 +4,18 @@ title: MontezumaRevenge # MontezumaRevenge -```{figure} ../_static/videos/environments/montezuma_revenge.gif +```{figure} ../../_static/videos/environments/montezuma_revenge.gif :width: 120px :name: MontezumaRevenge ``` 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/MontezumaRevenge-v5")` | +| Creation | make(ALE/MontezumaRevenge-v5) | For more MontezumaRevenge variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by MontezumaRevenge has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------------|-------------|--------------|------------------------------| -| MontezumaRevenge-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MontezumaRevenge-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MontezumaRevenge-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MontezumaRevenge-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MontezumaRevengeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MontezumaRevengeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MontezumaRevenge-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MontezumaRevenge-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MontezumaRevenge-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MontezumaRevenge-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MontezumaRevengeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MontezumaRevengeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MontezumaRevenge-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MontezumaRevenge-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------------|-------------|--------------|------------------------------| +| ALE/MontezumaRevenge-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MontezumaRevengeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/mr_do.md b/docs/environments/mr_do.md index 5e8b72a62..d0bb5159a 100644 --- a/docs/environments/mr_do.md +++ b/docs/environments/mr_do.md @@ -4,18 +4,18 @@ title: MrDo # MrDo -```{figure} ../_static/videos/environments/mr_do.gif +```{figure} ../../_static/videos/environments/mr_do.gif :width: 120px :name: 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")` | +| Creation | make(ALE/MrDo-v5) | For more MrDo variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by MrDo has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------|-------------|--------------|------------------------------| -| ALE/MrDo-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MrDo-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/MrDo-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MrDoNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/ms_pacman.md b/docs/environments/ms_pacman.md index 23f6f5442..c59734dc2 100644 --- a/docs/environments/ms_pacman.md +++ b/docs/environments/ms_pacman.md @@ -4,18 +4,18 @@ title: MsPacman # MsPacman -```{figure} ../_static/videos/environments/ms_pacman.gif +```{figure} ../../_static/videos/environments/ms_pacman.gif :width: 120px :name: MsPacman ``` 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/MsPacman-v5")` | +| Creation | make(ALE/MsPacman-v5) | For more MsPacman variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by MsPacman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| MsPacman-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MsPacman-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MsPacman-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MsPacman-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MsPacmanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MsPacmanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MsPacman-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MsPacman-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MsPacman-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MsPacman-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MsPacmanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MsPacmanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MsPacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MsPacman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/MsPacman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MsPacmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/name_this_game.md b/docs/environments/name_this_game.md index 7d6d0b75e..12d55735c 100644 --- a/docs/environments/name_this_game.md +++ b/docs/environments/name_this_game.md @@ -4,18 +4,18 @@ title: NameThisGame # NameThisGame -```{figure} ../_static/videos/environments/name_this_game.gif +```{figure} ../../_static/videos/environments/name_this_game.gif :width: 120px :name: NameThisGame ``` 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/NameThisGame-v5")` | +| Creation | make(ALE/NameThisGame-v5) | For more NameThisGame variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by NameThisGame has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| NameThisGame-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| NameThisGame-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| NameThisGame-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| NameThisGame-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| NameThisGameDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| NameThisGameNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| NameThisGame-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| NameThisGame-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| NameThisGame-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| NameThisGame-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| NameThisGameDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| NameThisGameNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/NameThisGame-v5 | `"rgb"` | `4` | `0.25` | -| ALE/NameThisGame-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/NameThisGame-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `NameThisGameNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/othello.md b/docs/environments/othello.md index a4c5b6b93..d2c5f0867 100644 --- a/docs/environments/othello.md +++ b/docs/environments/othello.md @@ -4,18 +4,18 @@ title: Othello # Othello -```{figure} ../_static/videos/environments/othello.gif +```{figure} ../../_static/videos/environments/othello.gif :width: 120px :name: Othello ``` 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/Othello-v5")` | +| Creation | make(ALE/Othello-v5) | For more Othello variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Othello has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Othello-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Othello-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Othello-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `OthelloNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pacman.md b/docs/environments/pacman.md index fe1e61c46..9b15c98ee 100644 --- a/docs/environments/pacman.md +++ b/docs/environments/pacman.md @@ -4,18 +4,18 @@ title: Pacman # Pacman -```{figure} ../_static/videos/environments/pacman.gif +```{figure} ../../_static/videos/environments/pacman.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Pacman-v5) | For more Pacman variants with different observation and action spaces, see the variants section. @@ -52,24 +52,12 @@ See variants section for the type of observation used by each environment id by Pacman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| MsPacman-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MsPacman-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MsPacman-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MsPacman-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MsPacmanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MsPacmanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MsPacman-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MsPacman-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MsPacman-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MsPacman-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MsPacmanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MsPacmanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MsPacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MsPacman-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Pacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pacman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/MsPacman-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Pacman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PacmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/phoenix.md b/docs/environments/phoenix.md index 6fb74c16c..a3ed5e70e 100644 --- a/docs/environments/phoenix.md +++ b/docs/environments/phoenix.md @@ -4,18 +4,18 @@ title: Phoenix # Phoenix -```{figure} ../_static/videos/environments/phoenix.gif +```{figure} ../../_static/videos/environments/phoenix.gif :width: 120px :name: Phoenix ``` 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/Phoenix-v5")` | +| Creation | make(ALE/Phoenix-v5) | For more Phoenix variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by Phoenix has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Phoenix-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Phoenix-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Phoenix-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Phoenix-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PhoenixDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PhoenixNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Phoenix-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Phoenix-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Phoenix-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Phoenix-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PhoenixDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PhoenixNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Phoenix-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Phoenix-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Phoenix-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PhoenixNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pitfall.md b/docs/environments/pitfall.md index 62c4bb26d..19c017208 100644 --- a/docs/environments/pitfall.md +++ b/docs/environments/pitfall.md @@ -4,18 +4,18 @@ title: Pitfall # Pitfall -```{figure} ../_static/videos/environments/pitfall.gif +```{figure} ../../_static/videos/environments/pitfall.gif :width: 120px :name: Pitfall ``` 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/Pitfall-v5")` | +| Creation | make(ALE/Pitfall-v5) | For more Pitfall variants with different observation and action spaces, see the variants section. @@ -61,24 +61,12 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Pitfall has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Pitfall-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pitfall-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pitfall-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pitfall-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PitfallDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PitfallNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pitfall-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pitfall-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pitfall-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pitfall-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PitfallDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PitfallNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pitfall-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Pitfall2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Pitfall-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Pitfall2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PitfallNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pitfall2.md b/docs/environments/pitfall2.md index fca7ecee2..d2d7036b3 100644 --- a/docs/environments/pitfall2.md +++ b/docs/environments/pitfall2.md @@ -4,18 +4,18 @@ title: Pitfall2 # Pitfall2 -```{figure} ../_static/videos/environments/pitfall2.gif +```{figure} ../../_static/videos/environments/pitfall2.gif :width: 120px :name: Pitfall2 ``` 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/Pitfall2-v5")` | +| Creation | make(ALE/Pitfall2-v5) | For more Pitfall2 variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Pitfall2 has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Pitfall2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Pitfall2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `Pitfall2NoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pong.md b/docs/environments/pong.md index 147e0451d..66b89d4cf 100644 --- a/docs/environments/pong.md +++ b/docs/environments/pong.md @@ -4,18 +4,18 @@ title: Pong # Pong -```{figure} ../_static/videos/environments/pong.gif +```{figure} ../../_static/videos/environments/pong.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Pong-v5) | For more Pong variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Pong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| Pong-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pong-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pong-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pong-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PongDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PongNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pong-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pong-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pong-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pong-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PongDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PongNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Pong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pooyan.md b/docs/environments/pooyan.md index a1bcb7d04..688e7fe95 100644 --- a/docs/environments/pooyan.md +++ b/docs/environments/pooyan.md @@ -4,18 +4,18 @@ title: Pooyan # Pooyan -```{figure} ../_static/videos/environments/pooyan.gif +```{figure} ../../_static/videos/environments/pooyan.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Pooyan-v5) | For more Pooyan variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Pooyan has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Pooyan-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pooyan-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pooyan-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pooyan-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PooyanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PooyanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pooyan-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pooyan-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pooyan-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pooyan-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PooyanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PooyanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pooyan-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pooyan-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Pooyan-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PooyanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/private_eye.md b/docs/environments/private_eye.md index e3a45259e..7f4ddccc7 100644 --- a/docs/environments/private_eye.md +++ b/docs/environments/private_eye.md @@ -4,18 +4,18 @@ title: PrivateEye # PrivateEye -```{figure} ../_static/videos/environments/private_eye.gif +```{figure} ../../_static/videos/environments/private_eye.gif :width: 120px :name: PrivateEye ``` 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/PrivateEye-v5")` | +| Creation | make(ALE/PrivateEye-v5) | For more PrivateEye variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ PrivateEye has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| PrivateEye-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| PrivateEye-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| PrivateEye-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| PrivateEye-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PrivateEyeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PrivateEyeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| PrivateEye-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| PrivateEye-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| PrivateEye-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| PrivateEye-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PrivateEyeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PrivateEyeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/PrivateEye-v5 | `"rgb"` | `4` | `0.25` | -| ALE/PrivateEye-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/PrivateEye-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PrivateEyeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/qbert.md b/docs/environments/qbert.md index d0e684666..7c31a10f2 100644 --- a/docs/environments/qbert.md +++ b/docs/environments/qbert.md @@ -4,18 +4,18 @@ title: Qbert # Qbert -```{figure} ../_static/videos/environments/qbert.gif +```{figure} ../../_static/videos/environments/qbert.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Qbert-v5) | For more Qbert variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Qbert has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| Qbert-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Qbert-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Qbert-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Qbert-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| QbertDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| QbertNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Qbert-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Qbert-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Qbert-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Qbert-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| QbertDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| QbertNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Qbert-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Qbert-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------|-------------|--------------|------------------------------| +| ALE/Qbert-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `QbertNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/riverraid.md b/docs/environments/riverraid.md index a02d919d1..becf1fe91 100644 --- a/docs/environments/riverraid.md +++ b/docs/environments/riverraid.md @@ -4,18 +4,18 @@ title: Riverraid # Riverraid -```{figure} ../_static/videos/environments/riverraid.gif +```{figure} ../../_static/videos/environments/riverraid.gif :width: 120px :name: Riverraid ``` 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/Riverraid-v5")` | +| Creation | make(ALE/Riverraid-v5) | For more Riverraid variants with different observation and action spaces, see the variants section. @@ -70,22 +70,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Riverraid has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Riverraid-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Riverraid-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Riverraid-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Riverraid-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RiverraidDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RiverraidNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Riverraid-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Riverraid-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Riverraid-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Riverraid-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RiverraidDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RiverraidNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Riverraid-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Riverraid-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Riverraid-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RiverraidNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/road_runner.md b/docs/environments/road_runner.md index 8343d80e5..ff2039747 100644 --- a/docs/environments/road_runner.md +++ b/docs/environments/road_runner.md @@ -4,18 +4,18 @@ title: RoadRunner # RoadRunner -```{figure} ../_static/videos/environments/road_runner.gif +```{figure} ../../_static/videos/environments/road_runner.gif :width: 120px :name: RoadRunner ``` 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/RoadRunner-v5")` | +| Creation | make(ALE/RoadRunner-v5) | For more RoadRunner variants with different observation and action spaces, see the variants section. @@ -69,22 +69,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ RoadRunner has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| RoadRunner-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| RoadRunner-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| RoadRunner-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| RoadRunner-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RoadRunnerDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RoadRunnerNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| RoadRunner-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| RoadRunner-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| RoadRunner-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| RoadRunner-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RoadRunnerDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RoadRunnerNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/RoadRunner-v5 | `"rgb"` | `4` | `0.25` | -| ALE/RoadRunner-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/RoadRunner-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RoadRunnerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/robotank.md b/docs/environments/robotank.md index 994334093..8b908e0b3 100644 --- a/docs/environments/robotank.md +++ b/docs/environments/robotank.md @@ -4,18 +4,18 @@ title: Robotank # Robotank -```{figure} ../_static/videos/environments/robotank.gif +```{figure} ../../_static/videos/environments/robotank.gif :width: 120px :name: Robotank ``` 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/Robotank-v5")` | +| Creation | make(ALE/Robotank-v5) | For more Robotank variants with different observation and action spaces, see the variants section. @@ -66,22 +66,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Robotank has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Robotank-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Robotank-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Robotank-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Robotank-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RobotankDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RobotankNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Robotank-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Robotank-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Robotank-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Robotank-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RobotankDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RobotankNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Robotank-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Robotank-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Robotank-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RobotankNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/seaquest.md b/docs/environments/seaquest.md index d00629643..8312b91da 100644 --- a/docs/environments/seaquest.md +++ b/docs/environments/seaquest.md @@ -4,18 +4,18 @@ title: Seaquest # Seaquest -```{figure} ../_static/videos/environments/seaquest.gif +```{figure} ../../_static/videos/environments/seaquest.gif :width: 120px :name: Seaquest ``` 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/Seaquest-v5")` | +| Creation | make(ALE/Seaquest-v5) | For more Seaquest variants with different observation and action spaces, see the variants section. @@ -73,22 +73,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Seaquest has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Seaquest-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Seaquest-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Seaquest-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Seaquest-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SeaquestDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SeaquestNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Seaquest-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Seaquest-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Seaquest-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Seaquest-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SeaquestDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SeaquestNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Seaquest-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Seaquest-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Seaquest-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SeaquestNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/sir_lancelot.md b/docs/environments/sir_lancelot.md index 4fc6f15f4..56bab2104 100644 --- a/docs/environments/sir_lancelot.md +++ b/docs/environments/sir_lancelot.md @@ -4,18 +4,18 @@ title: SirLancelot # SirLancelot -```{figure} ../_static/videos/environments/sir_lancelot.gif +```{figure} ../../_static/videos/environments/sir_lancelot.gif :width: 120px :name: SirLancelot ``` 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, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/SirLancelot-v5")` | +| Creation | make(ALE/SirLancelot-v5) | For more SirLancelot variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by SirLancelot has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/SirLancelot-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SirLancelot-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/SirLancelot-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SirLancelotNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/skiing.md b/docs/environments/skiing.md index 44038b936..5ca806fb8 100644 --- a/docs/environments/skiing.md +++ b/docs/environments/skiing.md @@ -4,18 +4,18 @@ title: Skiing # Skiing -```{figure} ../_static/videos/environments/skiing.gif +```{figure} ../../_static/videos/environments/skiing.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Skiing-v5) | For more Skiing variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page [SLALOM RACING section Skiing has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Skiing-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Skiing-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Skiing-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Skiing-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SkiingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SkiingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Skiing-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Skiing-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Skiing-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Skiing-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SkiingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SkiingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Skiing-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Skiing-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Skiing-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SkiingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/solaris.md b/docs/environments/solaris.md index eaf262ad1..0d8feeb88 100644 --- a/docs/environments/solaris.md +++ b/docs/environments/solaris.md @@ -4,18 +4,18 @@ title: Solaris # Solaris -```{figure} ../_static/videos/environments/solaris.gif +```{figure} ../../_static/videos/environments/solaris.gif :width: 120px :name: Solaris ``` 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/Solaris-v5")` | +| Creation | make(ALE/Solaris-v5) | For more Solaris variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Solaris has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Solaris-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Solaris-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Solaris-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Solaris-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SolarisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SolarisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Solaris-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Solaris-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Solaris-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Solaris-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SolarisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SolarisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Solaris-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Solaris-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Solaris-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SolarisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/space_invaders.md b/docs/environments/space_invaders.md index bb7e0838d..ba62bc9f9 100644 --- a/docs/environments/space_invaders.md +++ b/docs/environments/space_invaders.md @@ -4,18 +4,18 @@ title: SpaceInvaders # SpaceInvaders -```{figure} ../_static/videos/environments/space_invaders.gif +```{figure} ../../_static/videos/environments/space_invaders.gif :width: 120px :name: SpaceInvaders ``` 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/SpaceInvaders-v5")` | +| Creation | make(ALE/SpaceInvaders-v5) | For more SpaceInvaders variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ SpaceInvaders has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------------|-------------|--------------|------------------------------| -| SpaceInvaders-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| SpaceInvaders-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| SpaceInvaders-ramDeterministic-v0 | `"ram"` | `3` | `0.25` | -| SpaceInvaders-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SpaceInvadersDeterministic-v0 | `"rgb"` | `3` | `0.25` | -| SpaceInvadersNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| SpaceInvaders-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| SpaceInvaders-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| SpaceInvaders-ramDeterministic-v4 | `"ram"` | `3` | `0.0` | -| SpaceInvaders-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SpaceInvadersDeterministic-v4 | `"rgb"` | `3` | `0.0` | -| SpaceInvadersNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/SpaceInvaders-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SpaceInvaders-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/SpaceInvaders-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SpaceInvadersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/space_war.md b/docs/environments/space_war.md index 8c602ec99..0b1d8882a 100644 --- a/docs/environments/space_war.md +++ b/docs/environments/space_war.md @@ -4,18 +4,18 @@ title: SpaceWar # SpaceWar -```{figure} ../_static/videos/environments/space_war.gif +```{figure} ../../_static/videos/environments/space_war.gif :width: 120px :name: SpaceWar ``` 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/SpaceWar-v5")` | +| Creation | make(ALE/SpaceWar-v5) | For more SpaceWar variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by SpaceWar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/SpaceWar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SpaceWar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/SpaceWar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SpaceWarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/star_gunner.md b/docs/environments/star_gunner.md index ff49310b4..66aed4f6d 100644 --- a/docs/environments/star_gunner.md +++ b/docs/environments/star_gunner.md @@ -4,18 +4,18 @@ title: StarGunner # StarGunner -```{figure} ../_static/videos/environments/star_gunner.gif +```{figure} ../../_static/videos/environments/star_gunner.gif :width: 120px :name: StarGunner ``` 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/StarGunner-v5")` | +| Creation | make(ALE/StarGunner-v5) | For more StarGunner variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the Atari Mania page](http://www.atarima StarGunner has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| StarGunner-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| StarGunner-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| StarGunner-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| StarGunner-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| StarGunnerDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| StarGunnerNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| StarGunner-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| StarGunner-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| StarGunner-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| StarGunner-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| StarGunnerDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| StarGunnerNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/StarGunner-v5 | `"rgb"` | `4` | `0.25` | -| ALE/StarGunner-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/StarGunner-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `StarGunnerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/superman.md b/docs/environments/superman.md index 9741db858..e7fdf6393 100644 --- a/docs/environments/superman.md +++ b/docs/environments/superman.md @@ -4,18 +4,18 @@ title: Superman # Superman -```{figure} ../_static/videos/environments/superman.gif +```{figure} ../../_static/videos/environments/superman.gif :width: 120px :name: Superman ``` 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/Superman-v5")` | +| Creation | make(ALE/Superman-v5) | For more Superman variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Superman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Superman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Superman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Superman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SupermanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/surround.md b/docs/environments/surround.md index fe570ffbf..60b18414b 100644 --- a/docs/environments/surround.md +++ b/docs/environments/surround.md @@ -4,18 +4,18 @@ title: Surround # Surround -```{figure} ../_static/videos/environments/surround.gif +```{figure} ../../_static/videos/environments/surround.gif :width: 120px :name: Surround ``` 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/Surround-v5")` | +| Creation | make(ALE/Surround-v5) | For more Surround variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Surround has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Surround-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Surround-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Surround-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SurroundNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tennis.md b/docs/environments/tennis.md index 3e2aa8ed0..cd08748d4 100644 --- a/docs/environments/tennis.md +++ b/docs/environments/tennis.md @@ -4,18 +4,18 @@ title: Tennis # Tennis -```{figure} ../_static/videos/environments/tennis.gif +```{figure} ../../_static/videos/environments/tennis.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Tennis-v5) | For more Tennis variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Tennis has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Tennis-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Tennis-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Tennis-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Tennis-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TennisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TennisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Tennis-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Tennis-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Tennis-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Tennis-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TennisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TennisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Tennis-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tennis-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Tennis-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TennisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tetris.md b/docs/environments/tetris.md index be71e8acb..f00d6a7c9 100644 --- a/docs/environments/tetris.md +++ b/docs/environments/tetris.md @@ -4,18 +4,18 @@ title: Tetris # Tetris -```{figure} ../_static/videos/environments/tetris.gif +```{figure} ../../_static/videos/environments/tetris.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Tetris-v5) | For more Tetris variants with different observation and action spaces, see the variants section. @@ -52,10 +52,11 @@ See variants section for the type of observation used by each environment id by Tetris has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Tetris-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tetris-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Tetris-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TetrisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tic_tac_toe_3d.md b/docs/environments/tic_tac_toe_3d.md index ed79f1b8a..21f5569a2 100644 --- a/docs/environments/tic_tac_toe_3d.md +++ b/docs/environments/tic_tac_toe_3d.md @@ -4,18 +4,18 @@ title: TicTacToe3D # TicTacToe3D -```{figure} ../_static/videos/environments/tic_tac_toe_3d.gif +```{figure} ../../_static/videos/environments/tic_tac_toe_3d.gif :width: 120px :name: TicTacToe3D ``` 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/TicTacToe3D-v5")` | +| Creation | make(ALE/TicTacToe3D-v5) | For more TicTacToe3D variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by TicTacToe3D has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/TicTacToe3D-v5 | `"rgb"` | `4` | `0.25` | -| ALE/TicTacToe3D-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/TicTacToe3D-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TicTacToe3DNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/time_pilot.md b/docs/environments/time_pilot.md index 43c93ccf9..e9023f779 100644 --- a/docs/environments/time_pilot.md +++ b/docs/environments/time_pilot.md @@ -4,18 +4,18 @@ title: TimePilot # TimePilot -```{figure} ../_static/videos/environments/time_pilot.gif +```{figure} ../../_static/videos/environments/time_pilot.gif :width: 120px :name: TimePilot ``` 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/TimePilot-v5")` | +| Creation | make(ALE/TimePilot-v5) | For more TimePilot variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ For a more detailed documentation, see [the Atari Mania page](http://www.atarima TimePilot has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| TimePilot-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| TimePilot-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| TimePilot-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| TimePilot-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TimePilotDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TimePilotNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| TimePilot-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| TimePilot-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| TimePilot-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| TimePilot-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TimePilotDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TimePilotNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/TimePilot-v5 | `"rgb"` | `4` | `0.25` | -| ALE/TimePilot-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/TimePilot-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TimePilotNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/trondead.md b/docs/environments/trondead.md index 8d50f296a..5bde8d1a8 100644 --- a/docs/environments/trondead.md +++ b/docs/environments/trondead.md @@ -4,18 +4,18 @@ title: Trondead # Trondead -```{figure} ../_static/videos/environments/trondead.gif +```{figure} ../../_static/videos/environments/trondead.gif :width: 120px :name: Trondead ``` 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/Trondead-v5")` | +| Creation | make(ALE/Trondead-v5) | For more Trondead variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by Trondead has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Trondead-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Trondead-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Trondead-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TrondeadNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/turmoil.md b/docs/environments/turmoil.md index 303b979f1..5b09f4319 100644 --- a/docs/environments/turmoil.md +++ b/docs/environments/turmoil.md @@ -4,18 +4,18 @@ title: Turmoil # Turmoil -```{figure} ../_static/videos/environments/turmoil.gif +```{figure} ../../_static/videos/environments/turmoil.gif :width: 120px :name: Turmoil ``` This environment is part of the Atari environments. Please read that page first for general information. -| | | -|---|---| -| Action Space | Discrete(12) | +| | | +|-------------------|-----------------------------------| +| Action Space | Discrete(12) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Turmoil-v5")` | +| Creation | make(ALE/Turmoil-v5) | For more Turmoil variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Turmoil has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Turmoil-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Turmoil-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Turmoil-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TurmoilNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tutankham.md b/docs/environments/tutankham.md index d411b8934..cdc55b7ba 100644 --- a/docs/environments/tutankham.md +++ b/docs/environments/tutankham.md @@ -4,18 +4,18 @@ title: Tutankham # Tutankham -```{figure} ../_static/videos/environments/tutankham.gif +```{figure} ../../_static/videos/environments/tutankham.gif :width: 120px :name: Tutankham ``` 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/Tutankham-v5")` | +| Creation | make(ALE/Tutankham-v5) | For more Tutankham variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by Tutankham has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Tutankham-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Tutankham-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Tutankham-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Tutankham-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TutankhamDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TutankhamNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Tutankham-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Tutankham-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Tutankham-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Tutankham-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TutankhamDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TutankhamNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Tutankham-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tutankham-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Tutankham-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TutankhamNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/up_n_down.md b/docs/environments/up_n_down.md index 394251f7f..cf267171f 100644 --- a/docs/environments/up_n_down.md +++ b/docs/environments/up_n_down.md @@ -4,18 +4,18 @@ title: UpNDown # UpNDown -```{figure} ../_static/videos/environments/up_n_down.gif +```{figure} ../../_static/videos/environments/up_n_down.gif :width: 120px :name: UpNDown ``` 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/UpNDown-v5")` | +| Creation | make(ALE/UpNDown-v5) | For more UpNDown variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by UpNDown has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| UpNDown-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| UpNDown-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| UpNDown-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| UpNDown-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| UpNDownDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| UpNDownNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| UpNDown-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| UpNDown-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| UpNDown-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| UpNDown-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| UpNDownDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| UpNDownNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/UpNDown-v5 | `"rgb"` | `4` | `0.25` | -| ALE/UpNDown-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/UpNDown-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `UpNDownNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/venture.md b/docs/environments/venture.md index 9af5b2b2f..94a7bdcfd 100644 --- a/docs/environments/venture.md +++ b/docs/environments/venture.md @@ -4,18 +4,18 @@ title: Venture # Venture -```{figure} ../_static/videos/environments/venture.gif +```{figure} ../../_static/videos/environments/venture.gif :width: 120px :name: Venture ``` 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/Venture-v5")` | +| Creation | make(ALE/Venture-v5) | For more Venture variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by Venture has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Venture-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Venture-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Venture-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Venture-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| VentureDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| VentureNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Venture-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Venture-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Venture-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Venture-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| VentureDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| VentureNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Venture-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Venture-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Venture-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VentureNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_checkers.md b/docs/environments/video_checkers.md index 4c11da45c..bada73aa9 100644 --- a/docs/environments/video_checkers.md +++ b/docs/environments/video_checkers.md @@ -4,18 +4,18 @@ title: VideoCheckers # VideoCheckers -```{figure} ../_static/videos/environments/video_checkers.gif +```{figure} ../../_static/videos/environments/video_checkers.gif :width: 120px :name: VideoCheckers ``` 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/VideoCheckers-v5")` | +| Creation | make(ALE/VideoCheckers-v5) | For more VideoCheckers variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by VideoCheckers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| ALE/VideoCheckers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoCheckers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/VideoCheckers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoCheckersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_chess.md b/docs/environments/video_chess.md index 5640815a5..72385746d 100644 --- a/docs/environments/video_chess.md +++ b/docs/environments/video_chess.md @@ -4,18 +4,18 @@ title: VideoChess # VideoChess -```{figure} ../_static/videos/environments/video_chess.gif +```{figure} ../../_static/videos/environments/video_chess.gif :width: 120px :name: VideoChess ``` 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/VideoChess-v5")` | +| Creation | make(ALE/VideoChess-v5) | For more VideoChess variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by VideoChess has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/VideoChess-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoChess-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/VideoChess-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoChessNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_cube.md b/docs/environments/video_cube.md index fd1f556fa..2dcbd465b 100644 --- a/docs/environments/video_cube.md +++ b/docs/environments/video_cube.md @@ -4,18 +4,18 @@ title: VideoCube # VideoCube -```{figure} ../_static/videos/environments/video_cube.gif +```{figure} ../../_static/videos/environments/video_cube.gif :width: 120px :name: VideoCube ``` 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/VideoCube-v5")` | +| Creation | make(ALE/VideoCube-v5) | For more VideoCube variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by VideoCube has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/VideoCube-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoCube-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/VideoCube-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoCubeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_pinball.md b/docs/environments/video_pinball.md index 63b21ebca..eed6492a7 100644 --- a/docs/environments/video_pinball.md +++ b/docs/environments/video_pinball.md @@ -4,18 +4,18 @@ title: VideoPinball # VideoPinball -```{figure} ../_static/videos/environments/video_pinball.gif +```{figure} ../../_static/videos/environments/video_pinball.gif :width: 120px :name: VideoPinball ``` 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/VideoPinball-v5")` | +| Creation | make(ALE/VideoPinball-v5) | For more VideoPinball variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by VideoPinball has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| VideoPinball-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| VideoPinball-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| VideoPinball-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| VideoPinball-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| VideoPinballDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| VideoPinballNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| VideoPinball-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| VideoPinball-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| VideoPinball-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| VideoPinball-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| VideoPinballDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| VideoPinballNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/VideoPinball-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoPinball-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/VideoPinball-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoPinballNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/wizard_of_wor.md b/docs/environments/wizard_of_wor.md index ca1f2a0fa..5dbf2e464 100644 --- a/docs/environments/wizard_of_wor.md +++ b/docs/environments/wizard_of_wor.md @@ -4,18 +4,18 @@ title: WizardOfWor # WizardOfWor -```{figure} ../_static/videos/environments/wizard_of_wor.gif +```{figure} ../../_static/videos/environments/wizard_of_wor.gif :width: 120px :name: WizardOfWor ``` 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/WizardOfWor-v5")` | +| Creation | make(ALE/WizardOfWor-v5) | For more WizardOfWor variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by WizardOfWor has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| WizardOfWor-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| WizardOfWor-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| WizardOfWor-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| WizardOfWor-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| WizardOfWorDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| WizardOfWorNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| WizardOfWor-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| WizardOfWor-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| WizardOfWor-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| WizardOfWor-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| WizardOfWorDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| WizardOfWorNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/WizardOfWor-v5 | `"rgb"` | `4` | `0.25` | -| ALE/WizardOfWor-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/WizardOfWor-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `WizardOfWorNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/word_zapper.md b/docs/environments/word_zapper.md index ce9e3dd6a..68c6610db 100644 --- a/docs/environments/word_zapper.md +++ b/docs/environments/word_zapper.md @@ -4,18 +4,18 @@ title: WordZapper # WordZapper -```{figure} ../_static/videos/environments/word_zapper.gif +```{figure} ../../_static/videos/environments/word_zapper.gif :width: 120px :name: WordZapper ``` 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/WordZapper-v5")` | +| Creation | make(ALE/WordZapper-v5) | For more WordZapper variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ See variants section for the type of observation used by each environment id by WordZapper has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/WordZapper-v5 | `"rgb"` | `4` | `0.25` | -| ALE/WordZapper-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/WordZapper-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `WordZapperNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/yars_revenge.md b/docs/environments/yars_revenge.md index 6a62e3894..a5287d3ab 100644 --- a/docs/environments/yars_revenge.md +++ b/docs/environments/yars_revenge.md @@ -4,18 +4,18 @@ title: YarsRevenge # YarsRevenge -```{figure} ../_static/videos/environments/yars_revenge.gif +```{figure} ../../_static/videos/environments/yars_revenge.gif :width: 120px :name: YarsRevenge ``` 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/YarsRevenge-v5")` | +| Creation | make(ALE/YarsRevenge-v5) | For more YarsRevenge variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by YarsRevenge has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| YarsRevenge-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| YarsRevenge-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| YarsRevenge-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| YarsRevenge-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| YarsRevengeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| YarsRevengeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| YarsRevenge-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| YarsRevenge-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| YarsRevenge-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| YarsRevenge-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| YarsRevengeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| YarsRevengeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/YarsRevenge-v5 | `"rgb"` | `4` | `0.25` | -| ALE/YarsRevenge-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/YarsRevenge-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `YarsRevengeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/zaxxon.md b/docs/environments/zaxxon.md index cea960e86..580d54bb7 100644 --- a/docs/environments/zaxxon.md +++ b/docs/environments/zaxxon.md @@ -4,18 +4,18 @@ title: Zaxxon # Zaxxon -```{figure} ../_static/videos/environments/zaxxon.gif +```{figure} ../../_static/videos/environments/zaxxon.gif :width: 120px :name: 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")` | +| Creation | make(ALE/Zaxxon-v5) | For more Zaxxon variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ See variants section for the type of observation used by each environment id by Zaxxon has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Zaxxon-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Zaxxon-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Zaxxon-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Zaxxon-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ZaxxonDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ZaxxonNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Zaxxon-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Zaxxon-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Zaxxon-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Zaxxon-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ZaxxonDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ZaxxonNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Zaxxon-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Zaxxon-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Zaxxon-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ZaxxonNoFrameskip-v4`. ## Difficulty and modes From 5792e6578d50753353b3af98e9d1939299ba4a2a Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Tue, 1 Oct 2024 14:01:49 +0100 Subject: [PATCH 4/6] Update all the environment docs --- docs/_scripts/environment-docs.json | 104 ++++++++++++------------ docs/_scripts/gen_environment_page.py | 78 ++++++++++++++++++ docs/_scripts/gen_environments_md.py | 105 +++++++------------------ docs/environments/adventure.md | 11 ++- docs/environments/air_raid.md | 11 ++- docs/environments/alien.md | 18 ++--- docs/environments/amidar.md | 25 +++--- docs/environments/assault.md | 21 +++-- docs/environments/asterix.md | 24 +++--- docs/environments/asteroids.md | 28 +++---- docs/environments/atlantis.md | 28 +++---- docs/environments/atlantis2.md | 27 ++++--- docs/environments/backgammon.md | 21 +++-- docs/environments/bank_heist.md | 28 +++---- docs/environments/basic_math.md | 24 +++--- docs/environments/battle_zone.md | 27 +++---- docs/environments/beam_rider.md | 27 +++---- docs/environments/berzerk.md | 27 +++---- docs/environments/blackjack.md | 21 +++-- docs/environments/bowling.md | 29 +++---- docs/environments/boxing.md | 25 +++--- docs/environments/breakout.md | 27 +++---- docs/environments/carnival.md | 28 +++---- docs/environments/casino.md | 19 +++-- docs/environments/centipede.md | 28 +++---- docs/environments/chopper_command.md | 28 +++---- docs/environments/crazy_climber.md | 24 +++--- docs/environments/crossbow.md | 21 +++-- docs/environments/darkchambers.md | 21 +++-- docs/environments/defender.md | 27 +++---- docs/environments/demon_attack.md | 28 +++---- docs/environments/donkey_kong.md | 21 +++-- docs/environments/double_dunk.md | 28 +++---- docs/environments/earthworld.md | 21 +++-- docs/environments/elevator_action.md | 28 +++---- docs/environments/enduro.md | 22 +++--- docs/environments/entombed.md | 21 +++-- docs/environments/et.md | 19 +++-- docs/environments/fishing_derby.md | 27 +++---- docs/environments/flag_capture.md | 21 +++-- docs/environments/freeway.md | 27 +++---- docs/environments/frogger.md | 21 +++-- docs/environments/frostbite.md | 27 +++---- docs/environments/galaxian.md | 21 +++-- docs/environments/gopher.md | 25 +++--- docs/environments/gravitar.md | 27 +++---- docs/environments/hangman.md | 21 +++-- docs/environments/haunted_house.md | 21 +++-- docs/environments/hero.md | 26 +++--- docs/environments/human_cannonball.md | 21 +++-- docs/environments/ice_hockey.md | 28 +++---- docs/environments/jamesbond.md | 28 +++---- docs/environments/journey_escape.md | 28 +++---- docs/environments/kaboom.md | 19 +++-- docs/environments/kangaroo.md | 28 +++---- docs/environments/keystone_kapers.md | 21 +++-- docs/environments/king_kong.md | 21 +++-- docs/environments/klax.md | 19 +++-- docs/environments/koolaid.md | 21 +++-- docs/environments/krull.md | 26 +++--- docs/environments/kung_fu_master.md | 21 +++-- docs/environments/laser_gates.md | 23 +++--- docs/environments/lost_luggage.md | 21 +++-- docs/environments/mario_bros.md | 21 +++-- docs/environments/miniature_golf.md | 21 +++-- docs/environments/montezuma_revenge.md | 21 +++-- docs/environments/mr_do.md | 19 +++-- docs/environments/ms_pacman.md | 21 +++-- docs/environments/name_this_game.md | 21 +++-- docs/environments/othello.md | 21 +++-- docs/environments/pacman.md | 19 +++-- docs/environments/phoenix.md | 21 +++-- docs/environments/pitfall.md | 27 +++---- docs/environments/pitfall2.md | 21 +++-- docs/environments/pong.md | 25 +++--- docs/environments/pooyan.md | 25 +++--- docs/environments/private_eye.md | 27 +++---- docs/environments/qbert.md | 25 +++--- docs/environments/riverraid.md | 26 +++--- docs/environments/road_runner.md | 24 +++--- docs/environments/robotank.md | 32 +++----- docs/environments/seaquest.md | 39 +++------ docs/environments/sir_lancelot.md | 21 +++-- docs/environments/skiing.md | 26 +++--- docs/environments/solaris.md | 27 +++---- docs/environments/space_invaders.md | 27 +++---- docs/environments/space_war.md | 21 +++-- docs/environments/star_gunner.md | 27 +++---- docs/environments/superman.md | 21 +++-- docs/environments/surround.md | 21 +++-- docs/environments/tennis.md | 25 +++--- docs/environments/tetris.md | 19 +++-- docs/environments/tic_tac_toe_3d.md | 21 +++-- docs/environments/time_pilot.md | 27 +++---- docs/environments/trondead.md | 21 +++-- docs/environments/turmoil.md | 21 +++-- docs/environments/tutankham.md | 21 +++-- docs/environments/up_n_down.md | 21 +++-- docs/environments/venture.md | 21 +++-- docs/environments/video_checkers.md | 21 +++-- docs/environments/video_chess.md | 21 +++-- docs/environments/video_cube.md | 21 +++-- docs/environments/video_pinball.md | 21 +++-- docs/environments/wizard_of_wor.md | 21 +++-- docs/environments/word_zapper.md | 21 +++-- docs/environments/yars_revenge.md | 21 +++-- docs/environments/zaxxon.md | 19 +++-- 107 files changed, 1310 insertions(+), 1409 deletions(-) create mode 100644 docs/_scripts/gen_environment_page.py 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..0d76ec79d --- /dev/null +++ b/docs/_scripts/gen_environment_page.py @@ -0,0 +1,78 @@ +import itertools +import json + +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")) \ No newline at end of file diff --git a/docs/_scripts/gen_environments_md.py b/docs/_scripts/gen_environments_md.py index b3ac5ed34..e150e14ec 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"] - env_description = env_data["env_description"] - if env_data["atariage_url"]: - env_url = f""" + 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,12 @@ 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 +143,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 +168,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 +199,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..f07b73400 100644 --- a/docs/environments/adventure.md +++ b/docs/environments/adventure.md @@ -4,7 +4,7 @@ title: Adventure # Adventure -```{figure} ../_static/videos/environments/adventure.gif +```{figure} ../../_static/videos/environments/adventure.gif :width: 120px :name: Adventure ``` @@ -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..040d319c3 100644 --- a/docs/environments/air_raid.md +++ b/docs/environments/air_raid.md @@ -4,7 +4,7 @@ title: AirRaid # AirRaid -```{figure} ../_static/videos/environments/air_raid.gif +```{figure} ../../_static/videos/environments/air_raid.gif :width: 120px :name: AirRaid ``` @@ -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..ba500f475 100644 --- a/docs/environments/alien.md +++ b/docs/environments/alien.md @@ -4,7 +4,7 @@ title: Alien # Alien -```{figure} ../_static/videos/environments/alien.gif +```{figure} ../../_static/videos/environments/alien.gif :width: 120px :name: Alien ``` @@ -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 - -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). +### 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). ## Variants diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md index 5d90d356c..a1249896b 100644 --- a/docs/environments/amidar.md +++ b/docs/environments/amidar.md @@ -4,18 +4,18 @@ title: Amidar # Amidar -```{figure} ../_static/videos/environments/amidar.gif +```{figure} ../../_static/videos/environments/amidar.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/assault.md b/docs/environments/assault.md index 950c9086e..546d87f92 100644 --- a/docs/environments/assault.md +++ b/docs/environments/assault.md @@ -4,18 +4,18 @@ title: Assault # Assault -```{figure} ../_static/videos/environments/assault.gif +```{figure} ../../_static/videos/environments/assault.gif :width: 120px :name: 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..34021f815 100644 --- a/docs/environments/asterix.md +++ b/docs/environments/asterix.md @@ -4,18 +4,18 @@ title: Asterix # Asterix -```{figure} ../_static/videos/environments/asterix.gif +```{figure} ../../_static/videos/environments/asterix.gif :width: 120px :name: 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,16 +41,16 @@ 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). ## Variants diff --git a/docs/environments/asteroids.md b/docs/environments/asteroids.md index 60e509514..512b5f1f2 100644 --- a/docs/environments/asteroids.md +++ b/docs/environments/asteroids.md @@ -4,18 +4,18 @@ title: Asteroids # Asteroids -```{figure} ../_static/videos/environments/asteroids.gif +```{figure} ../../_static/videos/environments/asteroids.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md index a58ed9f1c..069a9b9dc 100644 --- a/docs/environments/atlantis.md +++ b/docs/environments/atlantis.md @@ -4,18 +4,18 @@ title: Atlantis # Atlantis -```{figure} ../_static/videos/environments/atlantis.gif +```{figure} ../../_static/videos/environments/atlantis.gif :width: 120px :name: 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 - -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). +### 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/atlantis2.md b/docs/environments/atlantis2.md index b9f463f52..09aee4b7d 100644 --- a/docs/environments/atlantis2.md +++ b/docs/environments/atlantis2.md @@ -4,24 +4,26 @@ title: Atlantis2 # Atlantis2 -```{figure} ../_static/videos/environments/atlantis2.gif +```{figure} ../../_static/videos/environments/atlantis2.gif :width: 120px :name: 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..a24e63f65 100644 --- a/docs/environments/backgammon.md +++ b/docs/environments/backgammon.md @@ -4,18 +4,18 @@ title: Backgammon # Backgammon -```{figure} ../_static/videos/environments/backgammon.gif +```{figure} ../../_static/videos/environments/backgammon.gif :width: 120px :name: 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..b00238e92 100644 --- a/docs/environments/bank_heist.md +++ b/docs/environments/bank_heist.md @@ -4,18 +4,18 @@ title: BankHeist # BankHeist -```{figure} ../_static/videos/environments/bank_heist.gif +```{figure} ../../_static/videos/environments/bank_heist.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md index 65271b72f..2c89de25d 100644 --- a/docs/environments/basic_math.md +++ b/docs/environments/basic_math.md @@ -4,25 +4,24 @@ title: BasicMath # BasicMath -```{figure} ../_static/videos/environments/basic_math.gif +```{figure} ../../_static/videos/environments/basic_math.gif :width: 120px :name: 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..e6fa042b1 100644 --- a/docs/environments/battle_zone.md +++ b/docs/environments/battle_zone.md @@ -4,18 +4,18 @@ title: BattleZone # BattleZone -```{figure} ../_static/videos/environments/battle_zone.gif +```{figure} ../../_static/videos/environments/battle_zone.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md index eb282790b..4a03d223b 100644 --- a/docs/environments/beam_rider.md +++ b/docs/environments/beam_rider.md @@ -4,18 +4,18 @@ title: BeamRider # BeamRider -```{figure} ../_static/videos/environments/beam_rider.gif +```{figure} ../../_static/videos/environments/beam_rider.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md index 9977ef9bd..7638719ac 100644 --- a/docs/environments/berzerk.md +++ b/docs/environments/berzerk.md @@ -4,18 +4,18 @@ title: Berzerk # Berzerk -```{figure} ../_static/videos/environments/berzerk.gif +```{figure} ../../_static/videos/environments/berzerk.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md index 1af52e499..9a6a062af 100644 --- a/docs/environments/blackjack.md +++ b/docs/environments/blackjack.md @@ -4,18 +4,18 @@ title: Blackjack # Blackjack -```{figure} ../_static/videos/environments/blackjack.gif +```{figure} ../../_static/videos/environments/blackjack.gif :width: 120px :name: 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..5102839fa 100644 --- a/docs/environments/bowling.md +++ b/docs/environments/bowling.md @@ -4,18 +4,18 @@ title: Bowling # Bowling -```{figure} ../_static/videos/environments/bowling.gif +```{figure} ../../_static/videos/environments/bowling.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md index 4116d977c..e938939f5 100644 --- a/docs/environments/boxing.md +++ b/docs/environments/boxing.md @@ -4,18 +4,18 @@ title: Boxing # Boxing -```{figure} ../_static/videos/environments/boxing.gif +```{figure} ../../_static/videos/environments/boxing.gif :width: 120px :name: 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 - -You score points by landing punches. -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882). +### 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). ## Variants diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md index 59d629e6a..a1e6f88e2 100644 --- a/docs/environments/breakout.md +++ b/docs/environments/breakout.md @@ -4,18 +4,18 @@ title: Breakout # Breakout -```{figure} ../_static/videos/environments/breakout.gif +```{figure} ../../_static/videos/environments/breakout.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md index 8736f75de..51edee509 100644 --- a/docs/environments/carnival.md +++ b/docs/environments/carnival.md @@ -4,18 +4,18 @@ title: Carnival # Carnival -```{figure} ../_static/videos/environments/carnival.gif +```{figure} ../../_static/videos/environments/carnival.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/casino.md b/docs/environments/casino.md index b43f782aa..0341d836a 100644 --- a/docs/environments/casino.md +++ b/docs/environments/casino.md @@ -4,18 +4,18 @@ title: Casino # Casino -```{figure} ../_static/videos/environments/casino.gif +```{figure} ../../_static/videos/environments/casino.gif :width: 120px :name: 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..2f504ac26 100644 --- a/docs/environments/centipede.md +++ b/docs/environments/centipede.md @@ -4,18 +4,18 @@ title: Centipede # Centipede -```{figure} ../_static/videos/environments/centipede.gif +```{figure} ../../_static/videos/environments/centipede.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/chopper_command.md b/docs/environments/chopper_command.md index 033cbeb3d..95f9138c4 100644 --- a/docs/environments/chopper_command.md +++ b/docs/environments/chopper_command.md @@ -4,18 +4,18 @@ title: ChopperCommand # ChopperCommand -```{figure} ../_static/videos/environments/chopper_command.gif +```{figure} ../../_static/videos/environments/chopper_command.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/crazy_climber.md b/docs/environments/crazy_climber.md index bac52d24c..40097bfb3 100644 --- a/docs/environments/crazy_climber.md +++ b/docs/environments/crazy_climber.md @@ -4,18 +4,18 @@ title: CrazyClimber # CrazyClimber -```{figure} ../_static/videos/environments/crazy_climber.gif +```{figure} ../../_static/videos/environments/crazy_climber.gif :width: 120px :name: 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,16 +41,16 @@ 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). ## Variants diff --git a/docs/environments/crossbow.md b/docs/environments/crossbow.md index 701124b72..67aa81b64 100644 --- a/docs/environments/crossbow.md +++ b/docs/environments/crossbow.md @@ -4,18 +4,18 @@ title: Crossbow # Crossbow -```{figure} ../_static/videos/environments/crossbow.gif +```{figure} ../../_static/videos/environments/crossbow.gif :width: 120px :name: 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..3c222c662 100644 --- a/docs/environments/darkchambers.md +++ b/docs/environments/darkchambers.md @@ -4,18 +4,18 @@ title: Darkchambers # Darkchambers -```{figure} ../_static/videos/environments/darkchambers.gif +```{figure} ../../_static/videos/environments/darkchambers.gif :width: 120px :name: 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..43007b41f 100644 --- a/docs/environments/defender.md +++ b/docs/environments/defender.md @@ -4,18 +4,18 @@ title: Defender # Defender -```{figure} ../_static/videos/environments/defender.gif +```{figure} ../../_static/videos/environments/defender.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/demon_attack.md b/docs/environments/demon_attack.md index bc213e027..b9c1d7ac8 100644 --- a/docs/environments/demon_attack.md +++ b/docs/environments/demon_attack.md @@ -4,18 +4,18 @@ title: DemonAttack # DemonAttack -```{figure} ../_static/videos/environments/demon_attack.gif +```{figure} ../../_static/videos/environments/demon_attack.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/donkey_kong.md b/docs/environments/donkey_kong.md index df8393507..3b534d2a2 100644 --- a/docs/environments/donkey_kong.md +++ b/docs/environments/donkey_kong.md @@ -4,18 +4,18 @@ title: DonkeyKong # DonkeyKong -```{figure} ../_static/videos/environments/donkey_kong.gif +```{figure} ../../_static/videos/environments/donkey_kong.gif :width: 120px :name: 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..d4e8bd468 100644 --- a/docs/environments/double_dunk.md +++ b/docs/environments/double_dunk.md @@ -4,18 +4,18 @@ title: DoubleDunk # DoubleDunk -```{figure} ../_static/videos/environments/double_dunk.gif +```{figure} ../../_static/videos/environments/double_dunk.gif :width: 120px :name: 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 - -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. +### 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. ## Variants diff --git a/docs/environments/earthworld.md b/docs/environments/earthworld.md index c64f2caec..0b36bdbd1 100644 --- a/docs/environments/earthworld.md +++ b/docs/environments/earthworld.md @@ -4,18 +4,18 @@ title: Earthworld # Earthworld -```{figure} ../_static/videos/environments/earthworld.gif +```{figure} ../../_static/videos/environments/earthworld.gif :width: 120px :name: 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..bcdda78e3 100644 --- a/docs/environments/elevator_action.md +++ b/docs/environments/elevator_action.md @@ -4,18 +4,18 @@ title: ElevatorAction # ElevatorAction -```{figure} ../_static/videos/environments/elevator_action.gif +```{figure} ../../_static/videos/environments/elevator_action.gif :width: 120px :name: 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 - -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. +### 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. ## Variants diff --git a/docs/environments/enduro.md b/docs/environments/enduro.md index 39316d6d1..c571ecabd 100644 --- a/docs/environments/enduro.md +++ b/docs/environments/enduro.md @@ -4,18 +4,18 @@ title: Enduro # Enduro -```{figure} ../_static/videos/environments/enduro.gif +```{figure} ../../_static/videos/environments/enduro.gif :width: 120px :name: 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,16 +41,16 @@ 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. ## Variants diff --git a/docs/environments/entombed.md b/docs/environments/entombed.md index 7ecc53241..a67297efc 100644 --- a/docs/environments/entombed.md +++ b/docs/environments/entombed.md @@ -4,18 +4,18 @@ title: Entombed # Entombed -```{figure} ../_static/videos/environments/entombed.gif +```{figure} ../../_static/videos/environments/entombed.gif :width: 120px :name: 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..b9ce0f25d 100644 --- a/docs/environments/et.md +++ b/docs/environments/et.md @@ -4,18 +4,18 @@ title: Et # Et -```{figure} ../_static/videos/environments/et.gif +```{figure} ../../_static/videos/environments/et.gif :width: 120px :name: 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..e7062d55e 100644 --- a/docs/environments/fishing_derby.md +++ b/docs/environments/fishing_derby.md @@ -4,18 +4,18 @@ title: FishingDerby # FishingDerby -```{figure} ../_static/videos/environments/fishing_derby.gif +```{figure} ../../_static/videos/environments/fishing_derby.gif :width: 120px :name: 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 - -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). +### 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). 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..6a67d23b6 100644 --- a/docs/environments/flag_capture.md +++ b/docs/environments/flag_capture.md @@ -4,18 +4,18 @@ title: FlagCapture # FlagCapture -```{figure} ../_static/videos/environments/flag_capture.gif +```{figure} ../../_static/videos/environments/flag_capture.gif :width: 120px :name: 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..3728523bb 100644 --- a/docs/environments/freeway.md +++ b/docs/environments/freeway.md @@ -4,18 +4,18 @@ title: Freeway # Freeway -```{figure} ../_static/videos/environments/freeway.gif +```{figure} ../../_static/videos/environments/freeway.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/frogger.md b/docs/environments/frogger.md index 18404c2b5..48d9f62cd 100644 --- a/docs/environments/frogger.md +++ b/docs/environments/frogger.md @@ -4,18 +4,18 @@ title: Frogger # Frogger -```{figure} ../_static/videos/environments/frogger.gif +```{figure} ../../_static/videos/environments/frogger.gif :width: 120px :name: 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..75003807e 100644 --- a/docs/environments/frostbite.md +++ b/docs/environments/frostbite.md @@ -4,18 +4,18 @@ title: Frostbite # Frostbite -```{figure} ../_static/videos/environments/frostbite.gif +```{figure} ../../_static/videos/environments/frostbite.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/galaxian.md b/docs/environments/galaxian.md index e82c66540..95ddefdb4 100644 --- a/docs/environments/galaxian.md +++ b/docs/environments/galaxian.md @@ -4,18 +4,18 @@ title: Galaxian # Galaxian -```{figure} ../_static/videos/environments/galaxian.gif +```{figure} ../../_static/videos/environments/galaxian.gif :width: 120px :name: 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..8aba63762 100644 --- a/docs/environments/gopher.md +++ b/docs/environments/gopher.md @@ -4,18 +4,18 @@ title: Gopher # Gopher -```{figure} ../_static/videos/environments/gopher.gif +```{figure} ../../_static/videos/environments/gopher.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/gravitar.md b/docs/environments/gravitar.md index f30091132..1ab5f84aa 100644 --- a/docs/environments/gravitar.md +++ b/docs/environments/gravitar.md @@ -4,18 +4,18 @@ title: Gravitar # Gravitar -```{figure} ../_static/videos/environments/gravitar.gif +```{figure} ../../_static/videos/environments/gravitar.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/hangman.md b/docs/environments/hangman.md index b0fbd349e..251b5c1ca 100644 --- a/docs/environments/hangman.md +++ b/docs/environments/hangman.md @@ -4,18 +4,18 @@ title: Hangman # Hangman -```{figure} ../_static/videos/environments/hangman.gif +```{figure} ../../_static/videos/environments/hangman.gif :width: 120px :name: 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..2193f9760 100644 --- a/docs/environments/haunted_house.md +++ b/docs/environments/haunted_house.md @@ -4,18 +4,18 @@ title: HauntedHouse # HauntedHouse -```{figure} ../_static/videos/environments/haunted_house.gif +```{figure} ../../_static/videos/environments/haunted_house.gif :width: 120px :name: 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..df266258c 100644 --- a/docs/environments/hero.md +++ b/docs/environments/hero.md @@ -4,18 +4,18 @@ title: Hero # Hero -```{figure} ../_static/videos/environments/hero.gif +```{figure} ../../_static/videos/environments/hero.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/human_cannonball.md b/docs/environments/human_cannonball.md index 79dcae822..60be4e585 100644 --- a/docs/environments/human_cannonball.md +++ b/docs/environments/human_cannonball.md @@ -4,18 +4,18 @@ title: HumanCannonball # HumanCannonball -```{figure} ../_static/videos/environments/human_cannonball.gif +```{figure} ../../_static/videos/environments/human_cannonball.gif :width: 120px :name: 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..7091068d2 100644 --- a/docs/environments/ice_hockey.md +++ b/docs/environments/ice_hockey.md @@ -4,18 +4,18 @@ title: IceHockey # IceHockey -```{figure} ../_static/videos/environments/ice_hockey.gif +```{figure} ../../_static/videos/environments/ice_hockey.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/jamesbond.md b/docs/environments/jamesbond.md index cf254d77c..daef7755c 100644 --- a/docs/environments/jamesbond.md +++ b/docs/environments/jamesbond.md @@ -4,18 +4,18 @@ title: Jamesbond # Jamesbond -```{figure} ../_static/videos/environments/jamesbond.gif +```{figure} ../../_static/videos/environments/jamesbond.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/journey_escape.md b/docs/environments/journey_escape.md index 3a06e57a1..bbcf5708c 100644 --- a/docs/environments/journey_escape.md +++ b/docs/environments/journey_escape.md @@ -4,18 +4,18 @@ title: JourneyEscape # JourneyEscape -```{figure} ../_static/videos/environments/journey_escape.gif +```{figure} ../../_static/videos/environments/journey_escape.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/kaboom.md b/docs/environments/kaboom.md index 50ed9a303..0e93309d4 100644 --- a/docs/environments/kaboom.md +++ b/docs/environments/kaboom.md @@ -4,18 +4,18 @@ title: Kaboom # Kaboom -```{figure} ../_static/videos/environments/kaboom.gif +```{figure} ../../_static/videos/environments/kaboom.gif :width: 120px :name: 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..1c52c4833 100644 --- a/docs/environments/kangaroo.md +++ b/docs/environments/kangaroo.md @@ -4,18 +4,18 @@ title: Kangaroo # Kangaroo -```{figure} ../_static/videos/environments/kangaroo.gif +```{figure} ../../_static/videos/environments/kangaroo.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/keystone_kapers.md b/docs/environments/keystone_kapers.md index dd98bef62..dccddbb6c 100644 --- a/docs/environments/keystone_kapers.md +++ b/docs/environments/keystone_kapers.md @@ -4,18 +4,18 @@ title: KeystoneKapers # KeystoneKapers -```{figure} ../_static/videos/environments/keystone_kapers.gif +```{figure} ../../_static/videos/environments/keystone_kapers.gif :width: 120px :name: 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..ac2f5fdd6 100644 --- a/docs/environments/king_kong.md +++ b/docs/environments/king_kong.md @@ -4,18 +4,18 @@ title: KingKong # KingKong -```{figure} ../_static/videos/environments/king_kong.gif +```{figure} ../../_static/videos/environments/king_kong.gif :width: 120px :name: 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..b63a8acdb 100644 --- a/docs/environments/klax.md +++ b/docs/environments/klax.md @@ -4,18 +4,18 @@ title: Klax # Klax -```{figure} ../_static/videos/environments/klax.gif +```{figure} ../../_static/videos/environments/klax.gif :width: 120px :name: 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..a32d67787 100644 --- a/docs/environments/koolaid.md +++ b/docs/environments/koolaid.md @@ -4,18 +4,18 @@ title: Koolaid # Koolaid -```{figure} ../_static/videos/environments/koolaid.gif +```{figure} ../../_static/videos/environments/koolaid.gif :width: 120px :name: 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..b34ca4fbb 100644 --- a/docs/environments/krull.md +++ b/docs/environments/krull.md @@ -4,18 +4,18 @@ title: Krull # Krull -```{figure} ../_static/videos/environments/krull.gif +```{figure} ../../_static/videos/environments/krull.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/kung_fu_master.md b/docs/environments/kung_fu_master.md index ac4cce819..4fcb2af34 100644 --- a/docs/environments/kung_fu_master.md +++ b/docs/environments/kung_fu_master.md @@ -4,18 +4,18 @@ title: KungFuMaster # KungFuMaster -```{figure} ../_static/videos/environments/kung_fu_master.gif +```{figure} ../../_static/videos/environments/kung_fu_master.gif :width: 120px :name: 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..7b1aa608b 100644 --- a/docs/environments/laser_gates.md +++ b/docs/environments/laser_gates.md @@ -4,24 +4,24 @@ title: LaserGates # LaserGates -```{figure} ../_static/videos/environments/laser_gates.gif +```{figure} ../../_static/videos/environments/laser_gates.gif :width: 120px :name: 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..645ba313f 100644 --- a/docs/environments/lost_luggage.md +++ b/docs/environments/lost_luggage.md @@ -4,18 +4,18 @@ title: LostLuggage # LostLuggage -```{figure} ../_static/videos/environments/lost_luggage.gif +```{figure} ../../_static/videos/environments/lost_luggage.gif :width: 120px :name: 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..093ffdb0d 100644 --- a/docs/environments/mario_bros.md +++ b/docs/environments/mario_bros.md @@ -4,18 +4,18 @@ title: MarioBros # MarioBros -```{figure} ../_static/videos/environments/mario_bros.gif +```{figure} ../../_static/videos/environments/mario_bros.gif :width: 120px :name: 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..a7ac30f1d 100644 --- a/docs/environments/miniature_golf.md +++ b/docs/environments/miniature_golf.md @@ -4,18 +4,18 @@ title: MiniatureGolf # MiniatureGolf -```{figure} ../_static/videos/environments/miniature_golf.gif +```{figure} ../../_static/videos/environments/miniature_golf.gif :width: 120px :name: 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..b17f166cc 100644 --- a/docs/environments/montezuma_revenge.md +++ b/docs/environments/montezuma_revenge.md @@ -4,18 +4,18 @@ title: MontezumaRevenge # MontezumaRevenge -```{figure} ../_static/videos/environments/montezuma_revenge.gif +```{figure} ../../_static/videos/environments/montezuma_revenge.gif :width: 120px :name: 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..b7805936e 100644 --- a/docs/environments/mr_do.md +++ b/docs/environments/mr_do.md @@ -4,18 +4,18 @@ title: MrDo # MrDo -```{figure} ../_static/videos/environments/mr_do.gif +```{figure} ../../_static/videos/environments/mr_do.gif :width: 120px :name: 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..80dbea49d 100644 --- a/docs/environments/ms_pacman.md +++ b/docs/environments/ms_pacman.md @@ -4,18 +4,18 @@ title: MsPacman # MsPacman -```{figure} ../_static/videos/environments/ms_pacman.gif +```{figure} ../../_static/videos/environments/ms_pacman.gif :width: 120px :name: 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..4fb0c433b 100644 --- a/docs/environments/name_this_game.md +++ b/docs/environments/name_this_game.md @@ -4,18 +4,18 @@ title: NameThisGame # NameThisGame -```{figure} ../_static/videos/environments/name_this_game.gif +```{figure} ../../_static/videos/environments/name_this_game.gif :width: 120px :name: 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..32616b11e 100644 --- a/docs/environments/othello.md +++ b/docs/environments/othello.md @@ -4,18 +4,18 @@ title: Othello # Othello -```{figure} ../_static/videos/environments/othello.gif +```{figure} ../../_static/videos/environments/othello.gif :width: 120px :name: 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..61069536c 100644 --- a/docs/environments/pacman.md +++ b/docs/environments/pacman.md @@ -4,18 +4,18 @@ title: Pacman # Pacman -```{figure} ../_static/videos/environments/pacman.gif +```{figure} ../../_static/videos/environments/pacman.gif :width: 120px :name: 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..cfea6179b 100644 --- a/docs/environments/phoenix.md +++ b/docs/environments/phoenix.md @@ -4,18 +4,18 @@ title: Phoenix # Phoenix -```{figure} ../_static/videos/environments/phoenix.gif +```{figure} ../../_static/videos/environments/phoenix.gif :width: 120px :name: 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..58f63efb8 100644 --- a/docs/environments/pitfall.md +++ b/docs/environments/pitfall.md @@ -4,18 +4,18 @@ title: Pitfall # Pitfall -```{figure} ../_static/videos/environments/pitfall.gif +```{figure} ../../_static/videos/environments/pitfall.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/pitfall2.md b/docs/environments/pitfall2.md index fca7ecee2..d11c21ac2 100644 --- a/docs/environments/pitfall2.md +++ b/docs/environments/pitfall2.md @@ -4,18 +4,18 @@ title: Pitfall2 # Pitfall2 -```{figure} ../_static/videos/environments/pitfall2.gif +```{figure} ../../_static/videos/environments/pitfall2.gif :width: 120px :name: 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..848c879b4 100644 --- a/docs/environments/pong.md +++ b/docs/environments/pong.md @@ -4,18 +4,18 @@ title: Pong # Pong -```{figure} ../_static/videos/environments/pong.gif +```{figure} ../../_static/videos/environments/pong.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/pooyan.md b/docs/environments/pooyan.md index a1bcb7d04..c473f9438 100644 --- a/docs/environments/pooyan.md +++ b/docs/environments/pooyan.md @@ -4,18 +4,18 @@ title: Pooyan # Pooyan -```{figure} ../_static/videos/environments/pooyan.gif +```{figure} ../../_static/videos/environments/pooyan.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/private_eye.md b/docs/environments/private_eye.md index e3a45259e..78a2e4c1b 100644 --- a/docs/environments/private_eye.md +++ b/docs/environments/private_eye.md @@ -4,18 +4,18 @@ title: PrivateEye # PrivateEye -```{figure} ../_static/videos/environments/private_eye.gif +```{figure} ../../_static/videos/environments/private_eye.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/qbert.md b/docs/environments/qbert.md index d0e684666..dfb5da0b6 100644 --- a/docs/environments/qbert.md +++ b/docs/environments/qbert.md @@ -4,18 +4,18 @@ title: Qbert # Qbert -```{figure} ../_static/videos/environments/qbert.gif +```{figure} ../../_static/videos/environments/qbert.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/riverraid.md b/docs/environments/riverraid.md index a02d919d1..eef34f8c8 100644 --- a/docs/environments/riverraid.md +++ b/docs/environments/riverraid.md @@ -4,18 +4,18 @@ title: Riverraid # Riverraid -```{figure} ../_static/videos/environments/riverraid.gif +```{figure} ../../_static/videos/environments/riverraid.gif :width: 120px :name: 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,17 +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 - -Score points are your only reward. You get score points each time you destroy an enemy object: +### Reward + +Score points are your only reward. You get score points each time you destroy an enemy object: | Enemy Object | Score Points | |--------------|--------------| diff --git a/docs/environments/road_runner.md b/docs/environments/road_runner.md index 8343d80e5..6b76b8f3a 100644 --- a/docs/environments/road_runner.md +++ b/docs/environments/road_runner.md @@ -4,18 +4,18 @@ title: RoadRunner # RoadRunner -```{figure} ../_static/videos/environments/road_runner.gif +```{figure} ../../_static/videos/environments/road_runner.gif :width: 120px :name: 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,16 +43,16 @@ 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: | actions | points | diff --git a/docs/environments/robotank.md b/docs/environments/robotank.md index 994334093..c9cce5e55 100644 --- a/docs/environments/robotank.md +++ b/docs/environments/robotank.md @@ -4,18 +4,18 @@ title: Robotank # Robotank -```{figure} ../_static/videos/environments/robotank.gif +```{figure} ../../_static/videos/environments/robotank.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/seaquest.md b/docs/environments/seaquest.md index d00629643..dfed073ed 100644 --- a/docs/environments/seaquest.md +++ b/docs/environments/seaquest.md @@ -4,18 +4,18 @@ title: Seaquest # Seaquest -```{figure} ../_static/videos/environments/seaquest.gif +```{figure} ../../_static/videos/environments/seaquest.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/sir_lancelot.md b/docs/environments/sir_lancelot.md index 4fc6f15f4..27d2d0125 100644 --- a/docs/environments/sir_lancelot.md +++ b/docs/environments/sir_lancelot.md @@ -4,18 +4,18 @@ title: SirLancelot # SirLancelot -```{figure} ../_static/videos/environments/sir_lancelot.gif +```{figure} ../../_static/videos/environments/sir_lancelot.gif :width: 120px :name: 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..207961bc4 100644 --- a/docs/environments/skiing.md +++ b/docs/environments/skiing.md @@ -4,18 +4,18 @@ title: Skiing # Skiing -```{figure} ../_static/videos/environments/skiing.gif +```{figure} ../../_static/videos/environments/skiing.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/solaris.md b/docs/environments/solaris.md index eaf262ad1..98bef0359 100644 --- a/docs/environments/solaris.md +++ b/docs/environments/solaris.md @@ -4,18 +4,18 @@ title: Solaris # Solaris -```{figure} ../_static/videos/environments/solaris.gif +```{figure} ../../_static/videos/environments/solaris.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/space_invaders.md b/docs/environments/space_invaders.md index bb7e0838d..1d62d736b 100644 --- a/docs/environments/space_invaders.md +++ b/docs/environments/space_invaders.md @@ -4,18 +4,18 @@ title: SpaceInvaders # SpaceInvaders -```{figure} ../_static/videos/environments/space_invaders.gif +```{figure} ../../_static/videos/environments/space_invaders.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/space_war.md b/docs/environments/space_war.md index 8c602ec99..361e04434 100644 --- a/docs/environments/space_war.md +++ b/docs/environments/space_war.md @@ -4,18 +4,18 @@ title: SpaceWar # SpaceWar -```{figure} ../_static/videos/environments/space_war.gif +```{figure} ../../_static/videos/environments/space_war.gif :width: 120px :name: 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..1783e0fdf 100644 --- a/docs/environments/star_gunner.md +++ b/docs/environments/star_gunner.md @@ -4,18 +4,18 @@ title: StarGunner # StarGunner -```{figure} ../_static/videos/environments/star_gunner.gif +```{figure} ../../_static/videos/environments/star_gunner.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/superman.md b/docs/environments/superman.md index 9741db858..cf8ba7b7b 100644 --- a/docs/environments/superman.md +++ b/docs/environments/superman.md @@ -4,18 +4,18 @@ title: Superman # Superman -```{figure} ../_static/videos/environments/superman.gif +```{figure} ../../_static/videos/environments/superman.gif :width: 120px :name: 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..4590162d9 100644 --- a/docs/environments/surround.md +++ b/docs/environments/surround.md @@ -4,18 +4,18 @@ title: Surround # Surround -```{figure} ../_static/videos/environments/surround.gif +```{figure} ../../_static/videos/environments/surround.gif :width: 120px :name: 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..c407e9aa2 100644 --- a/docs/environments/tennis.md +++ b/docs/environments/tennis.md @@ -4,18 +4,18 @@ title: Tennis # Tennis -```{figure} ../_static/videos/environments/tennis.gif +```{figure} ../../_static/videos/environments/tennis.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/tetris.md b/docs/environments/tetris.md index be71e8acb..4b546f7ab 100644 --- a/docs/environments/tetris.md +++ b/docs/environments/tetris.md @@ -4,18 +4,18 @@ title: Tetris # Tetris -```{figure} ../_static/videos/environments/tetris.gif +```{figure} ../../_static/videos/environments/tetris.gif :width: 120px :name: 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..5a8956fcd 100644 --- a/docs/environments/tic_tac_toe_3d.md +++ b/docs/environments/tic_tac_toe_3d.md @@ -4,18 +4,18 @@ title: TicTacToe3D # TicTacToe3D -```{figure} ../_static/videos/environments/tic_tac_toe_3d.gif +```{figure} ../../_static/videos/environments/tic_tac_toe_3d.gif :width: 120px :name: 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..e152f7db6 100644 --- a/docs/environments/time_pilot.md +++ b/docs/environments/time_pilot.md @@ -4,18 +4,18 @@ title: TimePilot # TimePilot -```{figure} ../_static/videos/environments/time_pilot.gif +```{figure} ../../_static/videos/environments/time_pilot.gif :width: 120px :name: 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 - -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). +### 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). ## Variants diff --git a/docs/environments/trondead.md b/docs/environments/trondead.md index 8d50f296a..524bd8f82 100644 --- a/docs/environments/trondead.md +++ b/docs/environments/trondead.md @@ -4,18 +4,18 @@ title: Trondead # Trondead -```{figure} ../_static/videos/environments/trondead.gif +```{figure} ../../_static/videos/environments/trondead.gif :width: 120px :name: 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..c09b497eb 100644 --- a/docs/environments/turmoil.md +++ b/docs/environments/turmoil.md @@ -4,18 +4,18 @@ title: Turmoil # Turmoil -```{figure} ../_static/videos/environments/turmoil.gif +```{figure} ../../_static/videos/environments/turmoil.gif :width: 120px :name: 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..0b2a26803 100644 --- a/docs/environments/tutankham.md +++ b/docs/environments/tutankham.md @@ -4,18 +4,18 @@ title: Tutankham # Tutankham -```{figure} ../_static/videos/environments/tutankham.gif +```{figure} ../../_static/videos/environments/tutankham.gif :width: 120px :name: 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..91ef25b44 100644 --- a/docs/environments/up_n_down.md +++ b/docs/environments/up_n_down.md @@ -4,18 +4,18 @@ title: UpNDown # UpNDown -```{figure} ../_static/videos/environments/up_n_down.gif +```{figure} ../../_static/videos/environments/up_n_down.gif :width: 120px :name: 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..743bd1ff6 100644 --- a/docs/environments/venture.md +++ b/docs/environments/venture.md @@ -4,18 +4,18 @@ title: Venture # Venture -```{figure} ../_static/videos/environments/venture.gif +```{figure} ../../_static/videos/environments/venture.gif :width: 120px :name: 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..46b5b1a93 100644 --- a/docs/environments/video_checkers.md +++ b/docs/environments/video_checkers.md @@ -4,18 +4,18 @@ title: VideoCheckers # VideoCheckers -```{figure} ../_static/videos/environments/video_checkers.gif +```{figure} ../../_static/videos/environments/video_checkers.gif :width: 120px :name: 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..f4457eab9 100644 --- a/docs/environments/video_chess.md +++ b/docs/environments/video_chess.md @@ -4,18 +4,18 @@ title: VideoChess # VideoChess -```{figure} ../_static/videos/environments/video_chess.gif +```{figure} ../../_static/videos/environments/video_chess.gif :width: 120px :name: 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..bc4a967b8 100644 --- a/docs/environments/video_cube.md +++ b/docs/environments/video_cube.md @@ -4,18 +4,18 @@ title: VideoCube # VideoCube -```{figure} ../_static/videos/environments/video_cube.gif +```{figure} ../../_static/videos/environments/video_cube.gif :width: 120px :name: 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..c47dc14fe 100644 --- a/docs/environments/video_pinball.md +++ b/docs/environments/video_pinball.md @@ -4,18 +4,18 @@ title: VideoPinball # VideoPinball -```{figure} ../_static/videos/environments/video_pinball.gif +```{figure} ../../_static/videos/environments/video_pinball.gif :width: 120px :name: 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..4d82194dd 100644 --- a/docs/environments/wizard_of_wor.md +++ b/docs/environments/wizard_of_wor.md @@ -4,18 +4,18 @@ title: WizardOfWor # WizardOfWor -```{figure} ../_static/videos/environments/wizard_of_wor.gif +```{figure} ../../_static/videos/environments/wizard_of_wor.gif :width: 120px :name: 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..7eecfb3b6 100644 --- a/docs/environments/word_zapper.md +++ b/docs/environments/word_zapper.md @@ -4,18 +4,18 @@ title: WordZapper # WordZapper -```{figure} ../_static/videos/environments/word_zapper.gif +```{figure} ../../_static/videos/environments/word_zapper.gif :width: 120px :name: 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..c43b54e42 100644 --- a/docs/environments/yars_revenge.md +++ b/docs/environments/yars_revenge.md @@ -4,18 +4,18 @@ title: YarsRevenge # YarsRevenge -```{figure} ../_static/videos/environments/yars_revenge.gif +```{figure} ../../_static/videos/environments/yars_revenge.gif :width: 120px :name: 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..9bc16edc2 100644 --- a/docs/environments/zaxxon.md +++ b/docs/environments/zaxxon.md @@ -4,18 +4,18 @@ title: Zaxxon # Zaxxon -```{figure} ../_static/videos/environments/zaxxon.gif +```{figure} ../../_static/videos/environments/zaxxon.gif :width: 120px :name: 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, From c3207af4260526e2bea9d73b284ae9132dd2e20d Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Tue, 1 Oct 2024 14:07:17 +0100 Subject: [PATCH 5/6] Fix the gif link --- docs/_scripts/gen_environment_page.py | 3 +-- docs/_scripts/gen_environments_md.py | 18 +++++++++++------- docs/environments/adventure.md | 2 +- docs/environments/air_raid.md | 2 +- docs/environments/alien.md | 4 ++-- docs/environments/amidar.md | 4 ++-- docs/environments/assault.md | 2 +- docs/environments/asterix.md | 4 ++-- docs/environments/asteroids.md | 4 ++-- docs/environments/atlantis.md | 4 ++-- docs/environments/atlantis2.md | 4 ++-- docs/environments/backgammon.md | 2 +- docs/environments/bank_heist.md | 4 ++-- docs/environments/basic_math.md | 2 +- docs/environments/battle_zone.md | 4 ++-- docs/environments/beam_rider.md | 4 ++-- docs/environments/berzerk.md | 4 ++-- docs/environments/blackjack.md | 2 +- docs/environments/bowling.md | 4 ++-- docs/environments/boxing.md | 4 ++-- docs/environments/breakout.md | 4 ++-- docs/environments/carnival.md | 4 ++-- docs/environments/casino.md | 2 +- docs/environments/centipede.md | 4 ++-- docs/environments/chopper_command.md | 4 ++-- docs/environments/crazy_climber.md | 4 ++-- docs/environments/crossbow.md | 2 +- docs/environments/darkchambers.md | 2 +- docs/environments/defender.md | 4 ++-- docs/environments/demon_attack.md | 4 ++-- docs/environments/donkey_kong.md | 2 +- docs/environments/double_dunk.md | 4 ++-- docs/environments/earthworld.md | 2 +- docs/environments/elevator_action.md | 4 ++-- docs/environments/enduro.md | 4 ++-- docs/environments/entombed.md | 2 +- docs/environments/et.md | 2 +- docs/environments/fishing_derby.md | 4 ++-- docs/environments/flag_capture.md | 2 +- docs/environments/freeway.md | 4 ++-- docs/environments/frogger.md | 2 +- docs/environments/frostbite.md | 4 ++-- docs/environments/galaxian.md | 2 +- docs/environments/gopher.md | 4 ++-- docs/environments/gravitar.md | 4 ++-- docs/environments/hangman.md | 2 +- docs/environments/haunted_house.md | 2 +- docs/environments/hero.md | 4 ++-- docs/environments/human_cannonball.md | 2 +- docs/environments/ice_hockey.md | 4 ++-- docs/environments/jamesbond.md | 4 ++-- docs/environments/journey_escape.md | 4 ++-- docs/environments/kaboom.md | 2 +- docs/environments/kangaroo.md | 4 ++-- docs/environments/keystone_kapers.md | 2 +- docs/environments/king_kong.md | 2 +- docs/environments/klax.md | 2 +- docs/environments/koolaid.md | 2 +- docs/environments/krull.md | 4 ++-- docs/environments/kung_fu_master.md | 2 +- docs/environments/laser_gates.md | 2 +- docs/environments/lost_luggage.md | 2 +- docs/environments/mario_bros.md | 2 +- docs/environments/miniature_golf.md | 2 +- docs/environments/montezuma_revenge.md | 2 +- docs/environments/mr_do.md | 2 +- docs/environments/ms_pacman.md | 2 +- docs/environments/name_this_game.md | 2 +- docs/environments/othello.md | 2 +- docs/environments/pacman.md | 2 +- docs/environments/phoenix.md | 2 +- docs/environments/pitfall.md | 4 ++-- docs/environments/pitfall2.md | 2 +- docs/environments/pong.md | 4 ++-- docs/environments/pooyan.md | 4 ++-- docs/environments/private_eye.md | 4 ++-- docs/environments/qbert.md | 4 ++-- docs/environments/riverraid.md | 6 +++--- docs/environments/road_runner.md | 4 ++-- docs/environments/robotank.md | 4 ++-- docs/environments/seaquest.md | 4 ++-- docs/environments/sir_lancelot.md | 2 +- docs/environments/skiing.md | 4 ++-- docs/environments/solaris.md | 4 ++-- docs/environments/space_invaders.md | 4 ++-- docs/environments/space_war.md | 2 +- docs/environments/star_gunner.md | 4 ++-- docs/environments/superman.md | 2 +- docs/environments/surround.md | 2 +- docs/environments/tennis.md | 4 ++-- docs/environments/tetris.md | 2 +- docs/environments/tic_tac_toe_3d.md | 2 +- docs/environments/time_pilot.md | 4 ++-- docs/environments/trondead.md | 2 +- docs/environments/turmoil.md | 2 +- docs/environments/tutankham.md | 2 +- docs/environments/up_n_down.md | 2 +- docs/environments/venture.md | 2 +- docs/environments/video_checkers.md | 2 +- docs/environments/video_chess.md | 2 +- docs/environments/video_cube.md | 2 +- docs/environments/video_pinball.md | 2 +- docs/environments/wizard_of_wor.md | 2 +- docs/environments/word_zapper.md | 2 +- docs/environments/yars_revenge.md | 2 +- docs/environments/zaxxon.md | 2 +- 106 files changed, 165 insertions(+), 162 deletions(-) diff --git a/docs/_scripts/gen_environment_page.py b/docs/_scripts/gen_environment_page.py index 0d76ec79d..2cc84c901 100644 --- a/docs/_scripts/gen_environment_page.py +++ b/docs/_scripts/gen_environment_page.py @@ -1,5 +1,4 @@ import itertools -import json import ale_py import gymnasium @@ -75,4 +74,4 @@ def shortened_repr(values): ) env.close() -print(tabulate.tabulate(rows, headers=headers, tablefmt="github")) \ No newline at end of file +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 e150e14ec..a1dd02d87 100644 --- a/docs/_scripts/gen_environments_md.py +++ b/docs/_scripts/gen_environments_md.py @@ -57,7 +57,7 @@ def shortened_repr(values): if env_data["reward_description"]: reward_description = f""" ### Reward - + {env_data["reward_description"]} """ else: @@ -129,11 +129,15 @@ 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") + 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() @@ -143,7 +147,7 @@ def shortened_repr(values): # {env_name} -```{{figure}} ../../_static/videos/environments/{rom_id}.gif +```{{figure}} ../_static/videos/environments/{rom_id}.gif :width: 120px :name: {env_name} ``` diff --git a/docs/environments/adventure.md b/docs/environments/adventure.md index f07b73400..ec4bde66e 100644 --- a/docs/environments/adventure.md +++ b/docs/environments/adventure.md @@ -4,7 +4,7 @@ title: Adventure # Adventure -```{figure} ../../_static/videos/environments/adventure.gif +```{figure} ../_static/videos/environments/adventure.gif :width: 120px :name: Adventure ``` diff --git a/docs/environments/air_raid.md b/docs/environments/air_raid.md index 040d319c3..c99f4051e 100644 --- a/docs/environments/air_raid.md +++ b/docs/environments/air_raid.md @@ -4,7 +4,7 @@ title: AirRaid # AirRaid -```{figure} ../../_static/videos/environments/air_raid.gif +```{figure} ../_static/videos/environments/air_raid.gif :width: 120px :name: AirRaid ``` diff --git a/docs/environments/alien.md b/docs/environments/alien.md index ba500f475..786995c02 100644 --- a/docs/environments/alien.md +++ b/docs/environments/alien.md @@ -4,7 +4,7 @@ title: Alien # Alien -```{figure} ../../_static/videos/environments/alien.gif +```{figure} ../_static/videos/environments/alien.gif :width: 120px :name: Alien ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md index a1249896b..aa61a3e4d 100644 --- a/docs/environments/amidar.md +++ b/docs/environments/amidar.md @@ -4,7 +4,7 @@ title: Amidar # Amidar -```{figure} ../../_static/videos/environments/amidar.gif +```{figure} ../_static/videos/environments/amidar.gif :width: 120px :name: Amidar ``` @@ -51,7 +51,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/assault.md b/docs/environments/assault.md index 546d87f92..02f101a62 100644 --- a/docs/environments/assault.md +++ b/docs/environments/assault.md @@ -4,7 +4,7 @@ title: Assault # Assault -```{figure} ../../_static/videos/environments/assault.gif +```{figure} ../_static/videos/environments/assault.gif :width: 120px :name: Assault ``` diff --git a/docs/environments/asterix.md b/docs/environments/asterix.md index 34021f815..6b853aee5 100644 --- a/docs/environments/asterix.md +++ b/docs/environments/asterix.md @@ -4,7 +4,7 @@ title: Asterix # Asterix -```{figure} ../../_static/videos/environments/asterix.gif +```{figure} ../_static/videos/environments/asterix.gif :width: 120px :name: Asterix ``` @@ -50,7 +50,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/asteroids.md b/docs/environments/asteroids.md index 512b5f1f2..8af07b4de 100644 --- a/docs/environments/asteroids.md +++ b/docs/environments/asteroids.md @@ -4,7 +4,7 @@ title: Asteroids # Asteroids -```{figure} ../../_static/videos/environments/asteroids.gif +```{figure} ../_static/videos/environments/asteroids.gif :width: 120px :name: Asteroids ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md index 069a9b9dc..45ca3c58f 100644 --- a/docs/environments/atlantis.md +++ b/docs/environments/atlantis.md @@ -4,7 +4,7 @@ title: Atlantis # Atlantis -```{figure} ../../_static/videos/environments/atlantis.gif +```{figure} ../_static/videos/environments/atlantis.gif :width: 120px :name: Atlantis ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: 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/atlantis2.md b/docs/environments/atlantis2.md index 09aee4b7d..92e5c3e5e 100644 --- a/docs/environments/atlantis2.md +++ b/docs/environments/atlantis2.md @@ -4,7 +4,7 @@ title: Atlantis2 # Atlantis2 -```{figure} ../../_static/videos/environments/atlantis2.gif +```{figure} ../_static/videos/environments/atlantis2.gif :width: 120px :name: Atlantis2 ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: 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 a24e63f65..e7eb8acf2 100644 --- a/docs/environments/backgammon.md +++ b/docs/environments/backgammon.md @@ -4,7 +4,7 @@ title: Backgammon # Backgammon -```{figure} ../../_static/videos/environments/backgammon.gif +```{figure} ../_static/videos/environments/backgammon.gif :width: 120px :name: Backgammon ``` diff --git a/docs/environments/bank_heist.md b/docs/environments/bank_heist.md index b00238e92..9863fc405 100644 --- a/docs/environments/bank_heist.md +++ b/docs/environments/bank_heist.md @@ -4,7 +4,7 @@ title: BankHeist # BankHeist -```{figure} ../../_static/videos/environments/bank_heist.gif +```{figure} ../_static/videos/environments/bank_heist.gif :width: 120px :name: BankHeist ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md index 2c89de25d..5d598d32d 100644 --- a/docs/environments/basic_math.md +++ b/docs/environments/basic_math.md @@ -4,7 +4,7 @@ title: BasicMath # BasicMath -```{figure} ../../_static/videos/environments/basic_math.gif +```{figure} ../_static/videos/environments/basic_math.gif :width: 120px :name: BasicMath ``` diff --git a/docs/environments/battle_zone.md b/docs/environments/battle_zone.md index e6fa042b1..995f7cc08 100644 --- a/docs/environments/battle_zone.md +++ b/docs/environments/battle_zone.md @@ -4,7 +4,7 @@ title: BattleZone # BattleZone -```{figure} ../../_static/videos/environments/battle_zone.gif +```{figure} ../_static/videos/environments/battle_zone.gif :width: 120px :name: BattleZone ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md index 4a03d223b..14c1b71a8 100644 --- a/docs/environments/beam_rider.md +++ b/docs/environments/beam_rider.md @@ -4,7 +4,7 @@ title: BeamRider # BeamRider -```{figure} ../../_static/videos/environments/beam_rider.gif +```{figure} ../_static/videos/environments/beam_rider.gif :width: 120px :name: BeamRider ``` @@ -50,7 +50,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md index 7638719ac..57e64531c 100644 --- a/docs/environments/berzerk.md +++ b/docs/environments/berzerk.md @@ -4,7 +4,7 @@ title: Berzerk # Berzerk -```{figure} ../../_static/videos/environments/berzerk.gif +```{figure} ../_static/videos/environments/berzerk.gif :width: 120px :name: Berzerk ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md index 9a6a062af..aa27c5dd3 100644 --- a/docs/environments/blackjack.md +++ b/docs/environments/blackjack.md @@ -4,7 +4,7 @@ title: Blackjack # Blackjack -```{figure} ../../_static/videos/environments/blackjack.gif +```{figure} ../_static/videos/environments/blackjack.gif :width: 120px :name: Blackjack ``` diff --git a/docs/environments/bowling.md b/docs/environments/bowling.md index 5102839fa..85b16fed8 100644 --- a/docs/environments/bowling.md +++ b/docs/environments/bowling.md @@ -4,7 +4,7 @@ title: Bowling # Bowling -```{figure} ../../_static/videos/environments/bowling.gif +```{figure} ../_static/videos/environments/bowling.gif :width: 120px :name: Bowling ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md index e938939f5..aa173c698 100644 --- a/docs/environments/boxing.md +++ b/docs/environments/boxing.md @@ -4,7 +4,7 @@ title: Boxing # Boxing -```{figure} ../../_static/videos/environments/boxing.gif +```{figure} ../_static/videos/environments/boxing.gif :width: 120px :name: Boxing ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md index a1e6f88e2..aca36c90d 100644 --- a/docs/environments/breakout.md +++ b/docs/environments/breakout.md @@ -4,7 +4,7 @@ title: Breakout # Breakout -```{figure} ../../_static/videos/environments/breakout.gif +```{figure} ../_static/videos/environments/breakout.gif :width: 120px :name: Breakout ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md index 51edee509..602d6786c 100644 --- a/docs/environments/carnival.md +++ b/docs/environments/carnival.md @@ -4,7 +4,7 @@ title: Carnival # Carnival -```{figure} ../../_static/videos/environments/carnival.gif +```{figure} ../_static/videos/environments/carnival.gif :width: 120px :name: Carnival ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/casino.md b/docs/environments/casino.md index 0341d836a..955ecd15c 100644 --- a/docs/environments/casino.md +++ b/docs/environments/casino.md @@ -4,7 +4,7 @@ title: Casino # Casino -```{figure} ../../_static/videos/environments/casino.gif +```{figure} ../_static/videos/environments/casino.gif :width: 120px :name: Casino ``` diff --git a/docs/environments/centipede.md b/docs/environments/centipede.md index 2f504ac26..a300345ac 100644 --- a/docs/environments/centipede.md +++ b/docs/environments/centipede.md @@ -4,7 +4,7 @@ title: Centipede # Centipede -```{figure} ../../_static/videos/environments/centipede.gif +```{figure} ../_static/videos/environments/centipede.gif :width: 120px :name: Centipede ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/chopper_command.md b/docs/environments/chopper_command.md index 95f9138c4..2e3f7d50e 100644 --- a/docs/environments/chopper_command.md +++ b/docs/environments/chopper_command.md @@ -4,7 +4,7 @@ title: ChopperCommand # ChopperCommand -```{figure} ../../_static/videos/environments/chopper_command.gif +```{figure} ../_static/videos/environments/chopper_command.gif :width: 120px :name: ChopperCommand ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/crazy_climber.md b/docs/environments/crazy_climber.md index 40097bfb3..110261818 100644 --- a/docs/environments/crazy_climber.md +++ b/docs/environments/crazy_climber.md @@ -4,7 +4,7 @@ title: CrazyClimber # CrazyClimber -```{figure} ../../_static/videos/environments/crazy_climber.gif +```{figure} ../_static/videos/environments/crazy_climber.gif :width: 120px :name: CrazyClimber ``` @@ -50,7 +50,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/crossbow.md b/docs/environments/crossbow.md index 67aa81b64..1f0d9f982 100644 --- a/docs/environments/crossbow.md +++ b/docs/environments/crossbow.md @@ -4,7 +4,7 @@ title: Crossbow # Crossbow -```{figure} ../../_static/videos/environments/crossbow.gif +```{figure} ../_static/videos/environments/crossbow.gif :width: 120px :name: Crossbow ``` diff --git a/docs/environments/darkchambers.md b/docs/environments/darkchambers.md index 3c222c662..deaefdc0a 100644 --- a/docs/environments/darkchambers.md +++ b/docs/environments/darkchambers.md @@ -4,7 +4,7 @@ title: Darkchambers # Darkchambers -```{figure} ../../_static/videos/environments/darkchambers.gif +```{figure} ../_static/videos/environments/darkchambers.gif :width: 120px :name: Darkchambers ``` diff --git a/docs/environments/defender.md b/docs/environments/defender.md index 43007b41f..9e026037b 100644 --- a/docs/environments/defender.md +++ b/docs/environments/defender.md @@ -4,7 +4,7 @@ title: Defender # Defender -```{figure} ../../_static/videos/environments/defender.gif +```{figure} ../_static/videos/environments/defender.gif :width: 120px :name: Defender ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/demon_attack.md b/docs/environments/demon_attack.md index b9c1d7ac8..187f40506 100644 --- a/docs/environments/demon_attack.md +++ b/docs/environments/demon_attack.md @@ -4,7 +4,7 @@ title: DemonAttack # DemonAttack -```{figure} ../../_static/videos/environments/demon_attack.gif +```{figure} ../_static/videos/environments/demon_attack.gif :width: 120px :name: DemonAttack ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/donkey_kong.md b/docs/environments/donkey_kong.md index 3b534d2a2..08d6ac5e8 100644 --- a/docs/environments/donkey_kong.md +++ b/docs/environments/donkey_kong.md @@ -4,7 +4,7 @@ title: DonkeyKong # DonkeyKong -```{figure} ../../_static/videos/environments/donkey_kong.gif +```{figure} ../_static/videos/environments/donkey_kong.gif :width: 120px :name: DonkeyKong ``` diff --git a/docs/environments/double_dunk.md b/docs/environments/double_dunk.md index d4e8bd468..0743b7c33 100644 --- a/docs/environments/double_dunk.md +++ b/docs/environments/double_dunk.md @@ -4,7 +4,7 @@ title: DoubleDunk # DoubleDunk -```{figure} ../../_static/videos/environments/double_dunk.gif +```{figure} ../_static/videos/environments/double_dunk.gif :width: 120px :name: DoubleDunk ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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. ## Variants diff --git a/docs/environments/earthworld.md b/docs/environments/earthworld.md index 0b36bdbd1..9eb716e49 100644 --- a/docs/environments/earthworld.md +++ b/docs/environments/earthworld.md @@ -4,7 +4,7 @@ title: Earthworld # Earthworld -```{figure} ../../_static/videos/environments/earthworld.gif +```{figure} ../_static/videos/environments/earthworld.gif :width: 120px :name: Earthworld ``` diff --git a/docs/environments/elevator_action.md b/docs/environments/elevator_action.md index bcdda78e3..782ad8d15 100644 --- a/docs/environments/elevator_action.md +++ b/docs/environments/elevator_action.md @@ -4,7 +4,7 @@ title: ElevatorAction # ElevatorAction -```{figure} ../../_static/videos/environments/elevator_action.gif +```{figure} ../_static/videos/environments/elevator_action.gif :width: 120px :name: ElevatorAction ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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. ## Variants diff --git a/docs/environments/enduro.md b/docs/environments/enduro.md index c571ecabd..aa47427a1 100644 --- a/docs/environments/enduro.md +++ b/docs/environments/enduro.md @@ -4,7 +4,7 @@ title: Enduro # Enduro -```{figure} ../../_static/videos/environments/enduro.gif +```{figure} ../_static/videos/environments/enduro.gif :width: 120px :name: Enduro ``` @@ -50,7 +50,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### Reward - + You get 1 point for each vehicle you overtake. ## Variants diff --git a/docs/environments/entombed.md b/docs/environments/entombed.md index a67297efc..8c93634c8 100644 --- a/docs/environments/entombed.md +++ b/docs/environments/entombed.md @@ -4,7 +4,7 @@ title: Entombed # Entombed -```{figure} ../../_static/videos/environments/entombed.gif +```{figure} ../_static/videos/environments/entombed.gif :width: 120px :name: Entombed ``` diff --git a/docs/environments/et.md b/docs/environments/et.md index b9ce0f25d..28d0d5119 100644 --- a/docs/environments/et.md +++ b/docs/environments/et.md @@ -4,7 +4,7 @@ title: Et # Et -```{figure} ../../_static/videos/environments/et.gif +```{figure} ../_static/videos/environments/et.gif :width: 120px :name: Et ``` diff --git a/docs/environments/fishing_derby.md b/docs/environments/fishing_derby.md index e7062d55e..79f2321a5 100644 --- a/docs/environments/fishing_derby.md +++ b/docs/environments/fishing_derby.md @@ -4,7 +4,7 @@ title: FishingDerby # FishingDerby -```{figure} ../../_static/videos/environments/fishing_derby.gif +```{figure} ../_static/videos/environments/fishing_derby.gif :width: 120px :name: FishingDerby ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). 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 6a67d23b6..5ef4ec920 100644 --- a/docs/environments/flag_capture.md +++ b/docs/environments/flag_capture.md @@ -4,7 +4,7 @@ title: FlagCapture # FlagCapture -```{figure} ../../_static/videos/environments/flag_capture.gif +```{figure} ../_static/videos/environments/flag_capture.gif :width: 120px :name: FlagCapture ``` diff --git a/docs/environments/freeway.md b/docs/environments/freeway.md index 3728523bb..972bd05e7 100644 --- a/docs/environments/freeway.md +++ b/docs/environments/freeway.md @@ -4,7 +4,7 @@ title: Freeway # Freeway -```{figure} ../../_static/videos/environments/freeway.gif +```{figure} ../_static/videos/environments/freeway.gif :width: 120px :name: Freeway ``` @@ -48,7 +48,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/frogger.md b/docs/environments/frogger.md index 48d9f62cd..cfdab505b 100644 --- a/docs/environments/frogger.md +++ b/docs/environments/frogger.md @@ -4,7 +4,7 @@ title: Frogger # Frogger -```{figure} ../../_static/videos/environments/frogger.gif +```{figure} ../_static/videos/environments/frogger.gif :width: 120px :name: Frogger ``` diff --git a/docs/environments/frostbite.md b/docs/environments/frostbite.md index 75003807e..d214637cf 100644 --- a/docs/environments/frostbite.md +++ b/docs/environments/frostbite.md @@ -4,7 +4,7 @@ title: Frostbite # Frostbite -```{figure} ../../_static/videos/environments/frostbite.gif +```{figure} ../_static/videos/environments/frostbite.gif :width: 120px :name: Frostbite ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/galaxian.md b/docs/environments/galaxian.md index 95ddefdb4..43a71e1c1 100644 --- a/docs/environments/galaxian.md +++ b/docs/environments/galaxian.md @@ -4,7 +4,7 @@ title: Galaxian # Galaxian -```{figure} ../../_static/videos/environments/galaxian.gif +```{figure} ../_static/videos/environments/galaxian.gif :width: 120px :name: Galaxian ``` diff --git a/docs/environments/gopher.md b/docs/environments/gopher.md index 8aba63762..17c308613 100644 --- a/docs/environments/gopher.md +++ b/docs/environments/gopher.md @@ -4,7 +4,7 @@ title: Gopher # Gopher -```{figure} ../../_static/videos/environments/gopher.gif +```{figure} ../_static/videos/environments/gopher.gif :width: 120px :name: Gopher ``` @@ -50,7 +50,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/gravitar.md b/docs/environments/gravitar.md index 1ab5f84aa..e8dc39570 100644 --- a/docs/environments/gravitar.md +++ b/docs/environments/gravitar.md @@ -4,7 +4,7 @@ title: Gravitar # Gravitar -```{figure} ../../_static/videos/environments/gravitar.gif +```{figure} ../_static/videos/environments/gravitar.gif :width: 120px :name: Gravitar ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/hangman.md b/docs/environments/hangman.md index 251b5c1ca..388c35d6c 100644 --- a/docs/environments/hangman.md +++ b/docs/environments/hangman.md @@ -4,7 +4,7 @@ title: Hangman # Hangman -```{figure} ../../_static/videos/environments/hangman.gif +```{figure} ../_static/videos/environments/hangman.gif :width: 120px :name: Hangman ``` diff --git a/docs/environments/haunted_house.md b/docs/environments/haunted_house.md index 2193f9760..a0ac85a44 100644 --- a/docs/environments/haunted_house.md +++ b/docs/environments/haunted_house.md @@ -4,7 +4,7 @@ title: HauntedHouse # HauntedHouse -```{figure} ../../_static/videos/environments/haunted_house.gif +```{figure} ../_static/videos/environments/haunted_house.gif :width: 120px :name: HauntedHouse ``` diff --git a/docs/environments/hero.md b/docs/environments/hero.md index df266258c..ef31dd76f 100644 --- a/docs/environments/hero.md +++ b/docs/environments/hero.md @@ -4,7 +4,7 @@ title: Hero # Hero -```{figure} ../../_static/videos/environments/hero.gif +```{figure} ../_static/videos/environments/hero.gif :width: 120px :name: Hero ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/human_cannonball.md b/docs/environments/human_cannonball.md index 60be4e585..f57ed85dc 100644 --- a/docs/environments/human_cannonball.md +++ b/docs/environments/human_cannonball.md @@ -4,7 +4,7 @@ title: HumanCannonball # HumanCannonball -```{figure} ../../_static/videos/environments/human_cannonball.gif +```{figure} ../_static/videos/environments/human_cannonball.gif :width: 120px :name: HumanCannonball ``` diff --git a/docs/environments/ice_hockey.md b/docs/environments/ice_hockey.md index 7091068d2..c9958f429 100644 --- a/docs/environments/ice_hockey.md +++ b/docs/environments/ice_hockey.md @@ -4,7 +4,7 @@ title: IceHockey # IceHockey -```{figure} ../../_static/videos/environments/ice_hockey.gif +```{figure} ../_static/videos/environments/ice_hockey.gif :width: 120px :name: IceHockey ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/jamesbond.md b/docs/environments/jamesbond.md index daef7755c..95bb74ec4 100644 --- a/docs/environments/jamesbond.md +++ b/docs/environments/jamesbond.md @@ -4,7 +4,7 @@ title: Jamesbond # Jamesbond -```{figure} ../../_static/videos/environments/jamesbond.gif +```{figure} ../_static/videos/environments/jamesbond.gif :width: 120px :name: Jamesbond ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/journey_escape.md b/docs/environments/journey_escape.md index bbcf5708c..2dda072d5 100644 --- a/docs/environments/journey_escape.md +++ b/docs/environments/journey_escape.md @@ -4,7 +4,7 @@ title: JourneyEscape # JourneyEscape -```{figure} ../../_static/videos/environments/journey_escape.gif +```{figure} ../_static/videos/environments/journey_escape.gif :width: 120px :name: JourneyEscape ``` @@ -53,7 +53,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/kaboom.md b/docs/environments/kaboom.md index 0e93309d4..7e45d7150 100644 --- a/docs/environments/kaboom.md +++ b/docs/environments/kaboom.md @@ -4,7 +4,7 @@ title: Kaboom # Kaboom -```{figure} ../../_static/videos/environments/kaboom.gif +```{figure} ../_static/videos/environments/kaboom.gif :width: 120px :name: Kaboom ``` diff --git a/docs/environments/kangaroo.md b/docs/environments/kangaroo.md index 1c52c4833..ea8b18bd5 100644 --- a/docs/environments/kangaroo.md +++ b/docs/environments/kangaroo.md @@ -4,7 +4,7 @@ title: Kangaroo # Kangaroo -```{figure} ../../_static/videos/environments/kangaroo.gif +```{figure} ../_static/videos/environments/kangaroo.gif :width: 120px :name: Kangaroo ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/keystone_kapers.md b/docs/environments/keystone_kapers.md index dccddbb6c..b792beb79 100644 --- a/docs/environments/keystone_kapers.md +++ b/docs/environments/keystone_kapers.md @@ -4,7 +4,7 @@ title: KeystoneKapers # KeystoneKapers -```{figure} ../../_static/videos/environments/keystone_kapers.gif +```{figure} ../_static/videos/environments/keystone_kapers.gif :width: 120px :name: KeystoneKapers ``` diff --git a/docs/environments/king_kong.md b/docs/environments/king_kong.md index ac2f5fdd6..3f5198a55 100644 --- a/docs/environments/king_kong.md +++ b/docs/environments/king_kong.md @@ -4,7 +4,7 @@ title: KingKong # KingKong -```{figure} ../../_static/videos/environments/king_kong.gif +```{figure} ../_static/videos/environments/king_kong.gif :width: 120px :name: KingKong ``` diff --git a/docs/environments/klax.md b/docs/environments/klax.md index b63a8acdb..369edf753 100644 --- a/docs/environments/klax.md +++ b/docs/environments/klax.md @@ -4,7 +4,7 @@ title: Klax # Klax -```{figure} ../../_static/videos/environments/klax.gif +```{figure} ../_static/videos/environments/klax.gif :width: 120px :name: Klax ``` diff --git a/docs/environments/koolaid.md b/docs/environments/koolaid.md index a32d67787..cef5b6ecd 100644 --- a/docs/environments/koolaid.md +++ b/docs/environments/koolaid.md @@ -4,7 +4,7 @@ title: Koolaid # Koolaid -```{figure} ../../_static/videos/environments/koolaid.gif +```{figure} ../_static/videos/environments/koolaid.gif :width: 120px :name: Koolaid ``` diff --git a/docs/environments/krull.md b/docs/environments/krull.md index b34ca4fbb..e3aee4bb8 100644 --- a/docs/environments/krull.md +++ b/docs/environments/krull.md @@ -4,7 +4,7 @@ title: Krull # Krull -```{figure} ../../_static/videos/environments/krull.gif +```{figure} ../_static/videos/environments/krull.gif :width: 120px :name: Krull ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/kung_fu_master.md b/docs/environments/kung_fu_master.md index 4fcb2af34..c00b495e3 100644 --- a/docs/environments/kung_fu_master.md +++ b/docs/environments/kung_fu_master.md @@ -4,7 +4,7 @@ title: KungFuMaster # KungFuMaster -```{figure} ../../_static/videos/environments/kung_fu_master.gif +```{figure} ../_static/videos/environments/kung_fu_master.gif :width: 120px :name: KungFuMaster ``` diff --git a/docs/environments/laser_gates.md b/docs/environments/laser_gates.md index 7b1aa608b..5c3e7d370 100644 --- a/docs/environments/laser_gates.md +++ b/docs/environments/laser_gates.md @@ -4,7 +4,7 @@ title: LaserGates # LaserGates -```{figure} ../../_static/videos/environments/laser_gates.gif +```{figure} ../_static/videos/environments/laser_gates.gif :width: 120px :name: LaserGates ``` diff --git a/docs/environments/lost_luggage.md b/docs/environments/lost_luggage.md index 645ba313f..e15ea8ac4 100644 --- a/docs/environments/lost_luggage.md +++ b/docs/environments/lost_luggage.md @@ -4,7 +4,7 @@ title: LostLuggage # LostLuggage -```{figure} ../../_static/videos/environments/lost_luggage.gif +```{figure} ../_static/videos/environments/lost_luggage.gif :width: 120px :name: LostLuggage ``` diff --git a/docs/environments/mario_bros.md b/docs/environments/mario_bros.md index 093ffdb0d..5da734ab1 100644 --- a/docs/environments/mario_bros.md +++ b/docs/environments/mario_bros.md @@ -4,7 +4,7 @@ title: MarioBros # MarioBros -```{figure} ../../_static/videos/environments/mario_bros.gif +```{figure} ../_static/videos/environments/mario_bros.gif :width: 120px :name: MarioBros ``` diff --git a/docs/environments/miniature_golf.md b/docs/environments/miniature_golf.md index a7ac30f1d..622422b7a 100644 --- a/docs/environments/miniature_golf.md +++ b/docs/environments/miniature_golf.md @@ -4,7 +4,7 @@ title: MiniatureGolf # MiniatureGolf -```{figure} ../../_static/videos/environments/miniature_golf.gif +```{figure} ../_static/videos/environments/miniature_golf.gif :width: 120px :name: MiniatureGolf ``` diff --git a/docs/environments/montezuma_revenge.md b/docs/environments/montezuma_revenge.md index b17f166cc..2fb88911a 100644 --- a/docs/environments/montezuma_revenge.md +++ b/docs/environments/montezuma_revenge.md @@ -4,7 +4,7 @@ title: MontezumaRevenge # MontezumaRevenge -```{figure} ../../_static/videos/environments/montezuma_revenge.gif +```{figure} ../_static/videos/environments/montezuma_revenge.gif :width: 120px :name: MontezumaRevenge ``` diff --git a/docs/environments/mr_do.md b/docs/environments/mr_do.md index b7805936e..0988b0403 100644 --- a/docs/environments/mr_do.md +++ b/docs/environments/mr_do.md @@ -4,7 +4,7 @@ title: MrDo # MrDo -```{figure} ../../_static/videos/environments/mr_do.gif +```{figure} ../_static/videos/environments/mr_do.gif :width: 120px :name: MrDo ``` diff --git a/docs/environments/ms_pacman.md b/docs/environments/ms_pacman.md index 80dbea49d..1819df5ac 100644 --- a/docs/environments/ms_pacman.md +++ b/docs/environments/ms_pacman.md @@ -4,7 +4,7 @@ title: MsPacman # MsPacman -```{figure} ../../_static/videos/environments/ms_pacman.gif +```{figure} ../_static/videos/environments/ms_pacman.gif :width: 120px :name: MsPacman ``` diff --git a/docs/environments/name_this_game.md b/docs/environments/name_this_game.md index 4fb0c433b..ac84f21d7 100644 --- a/docs/environments/name_this_game.md +++ b/docs/environments/name_this_game.md @@ -4,7 +4,7 @@ title: NameThisGame # NameThisGame -```{figure} ../../_static/videos/environments/name_this_game.gif +```{figure} ../_static/videos/environments/name_this_game.gif :width: 120px :name: NameThisGame ``` diff --git a/docs/environments/othello.md b/docs/environments/othello.md index 32616b11e..fc153a185 100644 --- a/docs/environments/othello.md +++ b/docs/environments/othello.md @@ -4,7 +4,7 @@ title: Othello # Othello -```{figure} ../../_static/videos/environments/othello.gif +```{figure} ../_static/videos/environments/othello.gif :width: 120px :name: Othello ``` diff --git a/docs/environments/pacman.md b/docs/environments/pacman.md index 61069536c..c203d492a 100644 --- a/docs/environments/pacman.md +++ b/docs/environments/pacman.md @@ -4,7 +4,7 @@ title: Pacman # Pacman -```{figure} ../../_static/videos/environments/pacman.gif +```{figure} ../_static/videos/environments/pacman.gif :width: 120px :name: Pacman ``` diff --git a/docs/environments/phoenix.md b/docs/environments/phoenix.md index cfea6179b..d2d80a170 100644 --- a/docs/environments/phoenix.md +++ b/docs/environments/phoenix.md @@ -4,7 +4,7 @@ title: Phoenix # Phoenix -```{figure} ../../_static/videos/environments/phoenix.gif +```{figure} ../_static/videos/environments/phoenix.gif :width: 120px :name: Phoenix ``` diff --git a/docs/environments/pitfall.md b/docs/environments/pitfall.md index 58f63efb8..985b2453b 100644 --- a/docs/environments/pitfall.md +++ b/docs/environments/pitfall.md @@ -4,7 +4,7 @@ title: Pitfall # Pitfall -```{figure} ../../_static/videos/environments/pitfall.gif +```{figure} ../_static/videos/environments/pitfall.gif :width: 120px :name: Pitfall ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/pitfall2.md b/docs/environments/pitfall2.md index d11c21ac2..3308d9446 100644 --- a/docs/environments/pitfall2.md +++ b/docs/environments/pitfall2.md @@ -4,7 +4,7 @@ title: Pitfall2 # Pitfall2 -```{figure} ../../_static/videos/environments/pitfall2.gif +```{figure} ../_static/videos/environments/pitfall2.gif :width: 120px :name: Pitfall2 ``` diff --git a/docs/environments/pong.md b/docs/environments/pong.md index 848c879b4..401b0bcba 100644 --- a/docs/environments/pong.md +++ b/docs/environments/pong.md @@ -4,7 +4,7 @@ title: Pong # Pong -```{figure} ../../_static/videos/environments/pong.gif +```{figure} ../_static/videos/environments/pong.gif :width: 120px :name: Pong ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/pooyan.md b/docs/environments/pooyan.md index c473f9438..4019db12a 100644 --- a/docs/environments/pooyan.md +++ b/docs/environments/pooyan.md @@ -4,7 +4,7 @@ title: Pooyan # Pooyan -```{figure} ../../_static/videos/environments/pooyan.gif +```{figure} ../_static/videos/environments/pooyan.gif :width: 120px :name: Pooyan ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/private_eye.md b/docs/environments/private_eye.md index 78a2e4c1b..8e8d95b02 100644 --- a/docs/environments/private_eye.md +++ b/docs/environments/private_eye.md @@ -4,7 +4,7 @@ title: PrivateEye # PrivateEye -```{figure} ../../_static/videos/environments/private_eye.gif +```{figure} ../_static/videos/environments/private_eye.gif :width: 120px :name: PrivateEye ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/qbert.md b/docs/environments/qbert.md index dfb5da0b6..d4ed6872a 100644 --- a/docs/environments/qbert.md +++ b/docs/environments/qbert.md @@ -4,7 +4,7 @@ title: Qbert # Qbert -```{figure} ../../_static/videos/environments/qbert.gif +```{figure} ../_static/videos/environments/qbert.gif :width: 120px :name: Qbert ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/riverraid.md b/docs/environments/riverraid.md index eef34f8c8..7c17f03da 100644 --- a/docs/environments/riverraid.md +++ b/docs/environments/riverraid.md @@ -4,7 +4,7 @@ title: Riverraid # Riverraid -```{figure} ../../_static/videos/environments/riverraid.gif +```{figure} ../_static/videos/environments/riverraid.gif :width: 120px :name: Riverraid ``` @@ -52,8 +52,8 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### Reward - -Score points are your only reward. You get score points each time you destroy an enemy object: + +Score points are your only reward. You get score points each time you destroy an enemy object: | Enemy Object | Score Points | |--------------|--------------| diff --git a/docs/environments/road_runner.md b/docs/environments/road_runner.md index 6b76b8f3a..c48454729 100644 --- a/docs/environments/road_runner.md +++ b/docs/environments/road_runner.md @@ -4,7 +4,7 @@ title: RoadRunner # RoadRunner -```{figure} ../../_static/videos/environments/road_runner.gif +```{figure} ../_static/videos/environments/road_runner.gif :width: 120px :name: RoadRunner ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### Reward - + Score points are your only reward. You get score points each time you: | actions | points | diff --git a/docs/environments/robotank.md b/docs/environments/robotank.md index c9cce5e55..bfff2adfa 100644 --- a/docs/environments/robotank.md +++ b/docs/environments/robotank.md @@ -4,7 +4,7 @@ title: Robotank # Robotank -```{figure} ../../_static/videos/environments/robotank.gif +```{figure} ../_static/videos/environments/robotank.gif :width: 120px :name: Robotank ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/seaquest.md b/docs/environments/seaquest.md index dfed073ed..ea6afbfde 100644 --- a/docs/environments/seaquest.md +++ b/docs/environments/seaquest.md @@ -4,7 +4,7 @@ title: Seaquest # Seaquest -```{figure} ../../_static/videos/environments/seaquest.gif +```{figure} ../_static/videos/environments/seaquest.gif :width: 120px :name: Seaquest ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/sir_lancelot.md b/docs/environments/sir_lancelot.md index 27d2d0125..d0963ece3 100644 --- a/docs/environments/sir_lancelot.md +++ b/docs/environments/sir_lancelot.md @@ -4,7 +4,7 @@ title: SirLancelot # SirLancelot -```{figure} ../../_static/videos/environments/sir_lancelot.gif +```{figure} ../_static/videos/environments/sir_lancelot.gif :width: 120px :name: SirLancelot ``` diff --git a/docs/environments/skiing.md b/docs/environments/skiing.md index 207961bc4..e3c3455cb 100644 --- a/docs/environments/skiing.md +++ b/docs/environments/skiing.md @@ -4,7 +4,7 @@ title: Skiing # Skiing -```{figure} ../../_static/videos/environments/skiing.gif +```{figure} ../_static/videos/environments/skiing.gif :width: 120px :name: Skiing ``` @@ -48,7 +48,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/solaris.md b/docs/environments/solaris.md index 98bef0359..f622e8652 100644 --- a/docs/environments/solaris.md +++ b/docs/environments/solaris.md @@ -4,7 +4,7 @@ title: Solaris # Solaris -```{figure} ../../_static/videos/environments/solaris.gif +```{figure} ../_static/videos/environments/solaris.gif :width: 120px :name: Solaris ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/space_invaders.md b/docs/environments/space_invaders.md index 1d62d736b..61dae8260 100644 --- a/docs/environments/space_invaders.md +++ b/docs/environments/space_invaders.md @@ -4,7 +4,7 @@ title: SpaceInvaders # SpaceInvaders -```{figure} ../../_static/videos/environments/space_invaders.gif +```{figure} ../_static/videos/environments/space_invaders.gif :width: 120px :name: SpaceInvaders ``` @@ -49,7 +49,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/space_war.md b/docs/environments/space_war.md index 361e04434..1406f4a08 100644 --- a/docs/environments/space_war.md +++ b/docs/environments/space_war.md @@ -4,7 +4,7 @@ title: SpaceWar # SpaceWar -```{figure} ../../_static/videos/environments/space_war.gif +```{figure} ../_static/videos/environments/space_war.gif :width: 120px :name: SpaceWar ``` diff --git a/docs/environments/star_gunner.md b/docs/environments/star_gunner.md index 1783e0fdf..807efcb93 100644 --- a/docs/environments/star_gunner.md +++ b/docs/environments/star_gunner.md @@ -4,7 +4,7 @@ title: StarGunner # StarGunner -```{figure} ../../_static/videos/environments/star_gunner.gif +```{figure} ../_static/videos/environments/star_gunner.gif :width: 120px :name: StarGunner ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/superman.md b/docs/environments/superman.md index cf8ba7b7b..ecd467448 100644 --- a/docs/environments/superman.md +++ b/docs/environments/superman.md @@ -4,7 +4,7 @@ title: Superman # Superman -```{figure} ../../_static/videos/environments/superman.gif +```{figure} ../_static/videos/environments/superman.gif :width: 120px :name: Superman ``` diff --git a/docs/environments/surround.md b/docs/environments/surround.md index 4590162d9..c7ca6c5af 100644 --- a/docs/environments/surround.md +++ b/docs/environments/surround.md @@ -4,7 +4,7 @@ title: Surround # Surround -```{figure} ../../_static/videos/environments/surround.gif +```{figure} ../_static/videos/environments/surround.gif :width: 120px :name: Surround ``` diff --git a/docs/environments/tennis.md b/docs/environments/tennis.md index c407e9aa2..02f9e5244 100644 --- a/docs/environments/tennis.md +++ b/docs/environments/tennis.md @@ -4,7 +4,7 @@ title: Tennis # Tennis -```{figure} ../../_static/videos/environments/tennis.gif +```{figure} ../_static/videos/environments/tennis.gif :width: 120px :name: Tennis ``` @@ -52,7 +52,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/tetris.md b/docs/environments/tetris.md index 4b546f7ab..97a2d5213 100644 --- a/docs/environments/tetris.md +++ b/docs/environments/tetris.md @@ -4,7 +4,7 @@ title: Tetris # Tetris -```{figure} ../../_static/videos/environments/tetris.gif +```{figure} ../_static/videos/environments/tetris.gif :width: 120px :name: Tetris ``` diff --git a/docs/environments/tic_tac_toe_3d.md b/docs/environments/tic_tac_toe_3d.md index 5a8956fcd..f97743e47 100644 --- a/docs/environments/tic_tac_toe_3d.md +++ b/docs/environments/tic_tac_toe_3d.md @@ -4,7 +4,7 @@ title: TicTacToe3D # TicTacToe3D -```{figure} ../../_static/videos/environments/tic_tac_toe_3d.gif +```{figure} ../_static/videos/environments/tic_tac_toe_3d.gif :width: 120px :name: TicTacToe3D ``` diff --git a/docs/environments/time_pilot.md b/docs/environments/time_pilot.md index e152f7db6..c94ee30af 100644 --- a/docs/environments/time_pilot.md +++ b/docs/environments/time_pilot.md @@ -4,7 +4,7 @@ title: TimePilot # TimePilot -```{figure} ../../_static/videos/environments/time_pilot.gif +```{figure} ../_static/videos/environments/time_pilot.gif :width: 120px :name: TimePilot ``` @@ -51,7 +51,7 @@ Atari environments have three possible observation types: See variants section for the type of observation used by each environment id by default. ### 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). ## Variants diff --git a/docs/environments/trondead.md b/docs/environments/trondead.md index 524bd8f82..a08e457d4 100644 --- a/docs/environments/trondead.md +++ b/docs/environments/trondead.md @@ -4,7 +4,7 @@ title: Trondead # Trondead -```{figure} ../../_static/videos/environments/trondead.gif +```{figure} ../_static/videos/environments/trondead.gif :width: 120px :name: Trondead ``` diff --git a/docs/environments/turmoil.md b/docs/environments/turmoil.md index c09b497eb..25bd5ce1f 100644 --- a/docs/environments/turmoil.md +++ b/docs/environments/turmoil.md @@ -4,7 +4,7 @@ title: Turmoil # Turmoil -```{figure} ../../_static/videos/environments/turmoil.gif +```{figure} ../_static/videos/environments/turmoil.gif :width: 120px :name: Turmoil ``` diff --git a/docs/environments/tutankham.md b/docs/environments/tutankham.md index 0b2a26803..642244bdc 100644 --- a/docs/environments/tutankham.md +++ b/docs/environments/tutankham.md @@ -4,7 +4,7 @@ title: Tutankham # Tutankham -```{figure} ../../_static/videos/environments/tutankham.gif +```{figure} ../_static/videos/environments/tutankham.gif :width: 120px :name: Tutankham ``` diff --git a/docs/environments/up_n_down.md b/docs/environments/up_n_down.md index 91ef25b44..8ba823c28 100644 --- a/docs/environments/up_n_down.md +++ b/docs/environments/up_n_down.md @@ -4,7 +4,7 @@ title: UpNDown # UpNDown -```{figure} ../../_static/videos/environments/up_n_down.gif +```{figure} ../_static/videos/environments/up_n_down.gif :width: 120px :name: UpNDown ``` diff --git a/docs/environments/venture.md b/docs/environments/venture.md index 743bd1ff6..f93ee95e8 100644 --- a/docs/environments/venture.md +++ b/docs/environments/venture.md @@ -4,7 +4,7 @@ title: Venture # Venture -```{figure} ../../_static/videos/environments/venture.gif +```{figure} ../_static/videos/environments/venture.gif :width: 120px :name: Venture ``` diff --git a/docs/environments/video_checkers.md b/docs/environments/video_checkers.md index 46b5b1a93..626988710 100644 --- a/docs/environments/video_checkers.md +++ b/docs/environments/video_checkers.md @@ -4,7 +4,7 @@ title: VideoCheckers # VideoCheckers -```{figure} ../../_static/videos/environments/video_checkers.gif +```{figure} ../_static/videos/environments/video_checkers.gif :width: 120px :name: VideoCheckers ``` diff --git a/docs/environments/video_chess.md b/docs/environments/video_chess.md index f4457eab9..3ae8aaaef 100644 --- a/docs/environments/video_chess.md +++ b/docs/environments/video_chess.md @@ -4,7 +4,7 @@ title: VideoChess # VideoChess -```{figure} ../../_static/videos/environments/video_chess.gif +```{figure} ../_static/videos/environments/video_chess.gif :width: 120px :name: VideoChess ``` diff --git a/docs/environments/video_cube.md b/docs/environments/video_cube.md index bc4a967b8..aa5150fa1 100644 --- a/docs/environments/video_cube.md +++ b/docs/environments/video_cube.md @@ -4,7 +4,7 @@ title: VideoCube # VideoCube -```{figure} ../../_static/videos/environments/video_cube.gif +```{figure} ../_static/videos/environments/video_cube.gif :width: 120px :name: VideoCube ``` diff --git a/docs/environments/video_pinball.md b/docs/environments/video_pinball.md index c47dc14fe..eb208a33b 100644 --- a/docs/environments/video_pinball.md +++ b/docs/environments/video_pinball.md @@ -4,7 +4,7 @@ title: VideoPinball # VideoPinball -```{figure} ../../_static/videos/environments/video_pinball.gif +```{figure} ../_static/videos/environments/video_pinball.gif :width: 120px :name: VideoPinball ``` diff --git a/docs/environments/wizard_of_wor.md b/docs/environments/wizard_of_wor.md index 4d82194dd..91cdb7680 100644 --- a/docs/environments/wizard_of_wor.md +++ b/docs/environments/wizard_of_wor.md @@ -4,7 +4,7 @@ title: WizardOfWor # WizardOfWor -```{figure} ../../_static/videos/environments/wizard_of_wor.gif +```{figure} ../_static/videos/environments/wizard_of_wor.gif :width: 120px :name: WizardOfWor ``` diff --git a/docs/environments/word_zapper.md b/docs/environments/word_zapper.md index 7eecfb3b6..c177bbd33 100644 --- a/docs/environments/word_zapper.md +++ b/docs/environments/word_zapper.md @@ -4,7 +4,7 @@ title: WordZapper # WordZapper -```{figure} ../../_static/videos/environments/word_zapper.gif +```{figure} ../_static/videos/environments/word_zapper.gif :width: 120px :name: WordZapper ``` diff --git a/docs/environments/yars_revenge.md b/docs/environments/yars_revenge.md index c43b54e42..713ad7f3a 100644 --- a/docs/environments/yars_revenge.md +++ b/docs/environments/yars_revenge.md @@ -4,7 +4,7 @@ title: YarsRevenge # YarsRevenge -```{figure} ../../_static/videos/environments/yars_revenge.gif +```{figure} ../_static/videos/environments/yars_revenge.gif :width: 120px :name: YarsRevenge ``` diff --git a/docs/environments/zaxxon.md b/docs/environments/zaxxon.md index 9bc16edc2..0c1a2c613 100644 --- a/docs/environments/zaxxon.md +++ b/docs/environments/zaxxon.md @@ -4,7 +4,7 @@ title: Zaxxon # Zaxxon -```{figure} ../../_static/videos/environments/zaxxon.gif +```{figure} ../_static/videos/environments/zaxxon.gif :width: 120px :name: Zaxxon ``` From f036f695a5e54b59c14605429571fcefa1c95b2a Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Tue, 1 Oct 2024 14:20:57 +0100 Subject: [PATCH 6/6] Update the documentation --- docs/_scripts/environment-docs.json | 20 +++++++-------- docs/_scripts/gen_environments_md.py | 5 ++-- docs/environments/adventure.md | 12 ++++----- docs/environments/air_raid.md | 4 +-- docs/environments/alien.md | 6 ++--- docs/environments/amidar.md | 25 ++++++------------ docs/environments/assault.md | 31 ++++++++--------------- docs/environments/asterix.md | 33 ++++++++---------------- docs/environments/asteroids.md | 33 ++++++++---------------- docs/environments/atlantis.md | 34 ++++++++----------------- docs/environments/atlantis2.md | 19 +++++++------- docs/environments/backgammon.md | 19 +++++++------- docs/environments/bank_heist.md | 31 ++++++++--------------- docs/environments/basic_math.md | 19 +++++++------- docs/environments/battle_zone.md | 31 ++++++++--------------- docs/environments/beam_rider.md | 31 ++++++++--------------- docs/environments/berzerk.md | 31 ++++++++--------------- docs/environments/blackjack.md | 19 +++++++------- docs/environments/bowling.md | 31 ++++++++--------------- docs/environments/boxing.md | 23 +++++------------ docs/environments/breakout.md | 33 ++++++++---------------- docs/environments/carnival.md | 31 ++++++++--------------- docs/environments/casino.md | 11 ++++---- docs/environments/centipede.md | 31 ++++++++--------------- docs/environments/chopper_command.md | 31 ++++++++--------------- docs/environments/crazy_climber.md | 31 ++++++++--------------- docs/environments/crossbow.md | 19 +++++++------- docs/environments/darkchambers.md | 19 +++++++------- docs/environments/defender.md | 31 ++++++++--------------- docs/environments/demon_attack.md | 31 ++++++++--------------- docs/environments/donkey_kong.md | 19 +++++++------- docs/environments/double_dunk.md | 31 ++++++++--------------- docs/environments/earthworld.md | 19 +++++++------- docs/environments/elevator_action.md | 31 ++++++++--------------- docs/environments/enduro.md | 23 +++++------------ docs/environments/entombed.md | 19 +++++++------- docs/environments/et.md | 11 ++++---- docs/environments/fishing_derby.md | 31 ++++++++--------------- docs/environments/flag_capture.md | 19 +++++++------- docs/environments/freeway.md | 31 ++++++++--------------- docs/environments/frogger.md | 19 +++++++------- docs/environments/frostbite.md | 31 ++++++++--------------- docs/environments/galaxian.md | 19 +++++++------- docs/environments/gopher.md | 23 +++++------------ docs/environments/gravitar.md | 31 ++++++++--------------- docs/environments/hangman.md | 19 +++++++------- docs/environments/haunted_house.md | 19 +++++++------- docs/environments/hero.md | 25 ++++++------------ docs/environments/human_cannonball.md | 19 +++++++------- docs/environments/ice_hockey.md | 31 ++++++++--------------- docs/environments/jamesbond.md | 31 ++++++++--------------- docs/environments/journey_escape.md | 31 ++++++++--------------- docs/environments/kaboom.md | 11 ++++---- docs/environments/kangaroo.md | 31 ++++++++--------------- docs/environments/keystone_kapers.md | 19 +++++++------- docs/environments/king_kong.md | 19 +++++++------- docs/environments/klax.md | 11 ++++---- docs/environments/koolaid.md | 19 +++++++------- docs/environments/krull.md | 23 +++++------------ docs/environments/kung_fu_master.md | 31 ++++++++--------------- docs/environments/laser_gates.md | 19 +++++++------- docs/environments/lost_luggage.md | 19 +++++++------- docs/environments/mario_bros.md | 19 +++++++------- docs/environments/miniature_golf.md | 19 +++++++------- docs/environments/montezuma_revenge.md | 31 ++++++++--------------- docs/environments/mr_do.md | 11 ++++---- docs/environments/ms_pacman.md | 31 ++++++++--------------- docs/environments/name_this_game.md | 31 ++++++++--------------- docs/environments/othello.md | 19 +++++++------- docs/environments/pacman.md | 26 ++++++------------- docs/environments/phoenix.md | 31 ++++++++--------------- docs/environments/pitfall.md | 34 ++++++++----------------- docs/environments/pitfall2.md | 19 +++++++------- docs/environments/pong.md | 23 +++++------------ docs/environments/pooyan.md | 23 +++++------------ docs/environments/private_eye.md | 31 ++++++++--------------- docs/environments/qbert.md | 23 +++++------------ docs/environments/riverraid.md | 35 +++++++++----------------- docs/environments/road_runner.md | 31 ++++++++--------------- docs/environments/robotank.md | 31 ++++++++--------------- docs/environments/seaquest.md | 31 ++++++++--------------- docs/environments/sir_lancelot.md | 19 +++++++------- docs/environments/skiing.md | 23 +++++------------ docs/environments/solaris.md | 31 ++++++++--------------- docs/environments/space_invaders.md | 31 ++++++++--------------- docs/environments/space_war.md | 19 +++++++------- docs/environments/star_gunner.md | 31 ++++++++--------------- docs/environments/superman.md | 19 +++++++------- docs/environments/surround.md | 19 +++++++------- docs/environments/tennis.md | 23 +++++------------ docs/environments/tetris.md | 11 ++++---- docs/environments/tic_tac_toe_3d.md | 19 +++++++------- docs/environments/time_pilot.md | 31 ++++++++--------------- docs/environments/trondead.md | 19 +++++++------- docs/environments/turmoil.md | 19 +++++++------- docs/environments/tutankham.md | 31 ++++++++--------------- docs/environments/up_n_down.md | 31 ++++++++--------------- docs/environments/venture.md | 31 ++++++++--------------- docs/environments/video_checkers.md | 21 ++++++++-------- docs/environments/video_chess.md | 21 ++++++++-------- docs/environments/video_cube.md | 21 ++++++++-------- docs/environments/video_pinball.md | 31 ++++++++--------------- docs/environments/wizard_of_wor.md | 31 ++++++++--------------- docs/environments/word_zapper.md | 19 +++++++------- docs/environments/yars_revenge.md | 31 ++++++++--------------- docs/environments/zaxxon.md | 23 +++++------------ 106 files changed, 970 insertions(+), 1593 deletions(-) diff --git a/docs/_scripts/environment-docs.json b/docs/_scripts/environment-docs.json index 11ce24986..5b6565da7 100644 --- a/docs/_scripts/environment-docs.json +++ b/docs/_scripts/environment-docs.json @@ -11,12 +11,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.", + "env_description": "You are stuck in a maze-like spaceship 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": "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.", + "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 with your enemies turn into chickens and you can catch them.", "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": { @@ -26,12 +26,12 @@ }, "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.", + "env_description": "You are Asterix and can move horizontally (continuously) and vertically (discretely). Objects move horizontally across the screen including 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": "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.", + "env_description": "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": "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": { @@ -91,7 +91,7 @@ }, "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.", + "env_description": "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": "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": { @@ -226,7 +226,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.", + "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": "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": { @@ -376,7 +376,7 @@ }, "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.", + "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": "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": { @@ -481,17 +481,17 @@ }, "video_checkers": { "atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=579", - "env_description": "Classic checkers: move your color pieces towards the opposite end of the board, jumping over opponents pieces to remove them from the board and gaining a king when you reach the other side.", + "env_description": "Move your color pieces towards the opposite end of the board, jumping over opponents pieces to remove them from the board and gaining a king when you reach the other side.", "reward_description": "" }, "video_chess": { "atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=581", - "env_description": "This is the usual game of chess: capture the opponents king.", + "env_description": "This is the usual game of chess, capture the opponents king.", "reward_description": "" }, "video_cube": { "atariage_url": "https://atariage.com/manual_html_page.php?SoftwareLabelID=974", - "env_description": "Solve a Rubik's cube in a nonstandard way: guide Hubie around the cube and swap tiles on the cubes face with one another until each face consists of only one color.", + "env_description": "Solve a Rubik's cube in a nonstandard way, guide Hubie around the cube and swap tiles on the cubes face with one another until each face consists of only one color.", "reward_description": "" }, "video_pinball": { diff --git a/docs/_scripts/gen_environments_md.py b/docs/_scripts/gen_environments_md.py index 637a2880a..94a84b511 100644 --- a/docs/_scripts/gen_environments_md.py +++ b/docs/_scripts/gen_environments_md.py @@ -44,11 +44,10 @@ def shortened_repr(values): env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped - general_info_table = tabulate.tabulate( - [ + general_info_table = tabulate.tabulate([ + ["Make", f'gymnasium.make("ALE/{env_name}-v5")'], ["Action Space", str(env.action_space)], ["Observation Space", str(env.observation_space)], - ["Creation", f"make(ALE/{env_name}-v5)"], ], headers=["", ""], tablefmt="github", diff --git a/docs/environments/adventure.md b/docs/environments/adventure.md index d49a741c0..75e9a2fa5 100644 --- a/docs/environments/adventure.md +++ b/docs/environments/adventure.md @@ -4,18 +4,18 @@ title: Adventure # Adventure -```{figure} ../../_static/videos/environments/adventure.gif +```{figure} ../_static/videos/environments/adventure.gif :width: 120px :name: Adventure ``` 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) | -| Creation | make(ALE/Adventure-v5) | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Adventure-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more Adventure variants with different observation and action spaces, see the variants section. diff --git a/docs/environments/air_raid.md b/docs/environments/air_raid.md index 65bc1efe1..9fe70d19c 100644 --- a/docs/environments/air_raid.md +++ b/docs/environments/air_raid.md @@ -4,7 +4,7 @@ title: AirRaid # AirRaid -```{figure} ../../_static/videos/environments/air_raid.gif +```{figure} ../_static/videos/environments/air_raid.gif :width: 120px :name: AirRaid ``` @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/AirRaid-v5") | | Action Space | Discrete(6) | | Observation Space | Box(0, 255, (250, 160, 3), uint8) | -| Creation | make(ALE/AirRaid-v5) | For more AirRaid variants with different observation and action spaces, see the variants section. diff --git a/docs/environments/alien.md b/docs/environments/alien.md index 9f690e93e..99f9e6a89 100644 --- a/docs/environments/alien.md +++ b/docs/environments/alien.md @@ -4,7 +4,7 @@ title: Alien # Alien -```{figure} ../../_static/videos/environments/alien.gif +```{figure} ../_static/videos/environments/alien.gif :width: 120px :name: Alien ``` @@ -13,15 +13,15 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Alien-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Creation | make(ALE/Alien-v5) | For more Alien variants with different observation and action spaces, see the variants section. ## Description -You are stuck in a maze-like spaceship with three aliens. Your 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. +You are stuck in a maze-like spaceship 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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815) diff --git a/docs/environments/amidar.md b/docs/environments/amidar.md index aa61a3e4d..f07d6f290 100644 --- a/docs/environments/amidar.md +++ b/docs/environments/amidar.md @@ -13,15 +13,15 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Amidar-v5") | | Action Space | Discrete(10) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Amidar-v5")` | For more Amidar variants with different observation and action spaces, see the variants section. ## 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. +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 with your enemies turn into chickens and you can catch them. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817) @@ -59,22 +59,11 @@ You score points by traversing new parts of the grid. Coloring an entire box in Amidar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Amidar-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Amidar-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Amidar-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Amidar-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AmidarDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AmidarNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Amidar-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Amidar-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Amidar-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Amidar-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AmidarDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AmidarNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Amidar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Amidar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Amidar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AmidarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/assault.md b/docs/environments/assault.md index 02f101a62..3ec8125cd 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Assault-v5") | +| Action Space | Discrete(7) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Assault variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by Assault has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Assault-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Assault-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Assault-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Assault-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AssaultDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AssaultNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Assault-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Assault-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Assault-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Assault-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AssaultDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AssaultNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Assault-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Assault-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Assault-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AssaultNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/asterix.md b/docs/environments/asterix.md index 6b853aee5..15cf6673b 100644 --- a/docs/environments/asterix.md +++ b/docs/environments/asterix.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Asterix-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Asterix variants with different observation and action spaces, see the variants section. ## 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. +You are Asterix and can move horizontally (continuously) and vertically (discretely). Objects move horizontally across the screen including 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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325) @@ -58,22 +58,11 @@ A table of scores awarded for collecting the different objects is provided on [t Asterix has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Asterix-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Asterix-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Asterix-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Asterix-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AsterixDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AsterixNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Asterix-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Asterix-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Asterix-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Asterix-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AsterixDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AsterixNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Asterix-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Asterix-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Asterix-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsterixNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/asteroids.md b/docs/environments/asteroids.md index 8af07b4de..9e698b7ba 100644 --- a/docs/environments/asteroids.md +++ b/docs/environments/asteroids.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Asteroids-v5") | +| Action Space | Discrete(14) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Asteroids variants with different observation and action spaces, see the variants section. ## 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. +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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=828) @@ -60,22 +60,11 @@ You score points for destroying asteroids, satellites and UFOs. The smaller the Asteroids has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Asteroids-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Asteroids-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Asteroids-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Asteroids-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AsteroidsDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AsteroidsNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Asteroids-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Asteroids-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Asteroids-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Asteroids-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AsteroidsDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AsteroidsNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Asteroids-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Asteroids-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Asteroids-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsteroidsNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/atlantis.md b/docs/environments/atlantis.md index 45ca3c58f..d79453533 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Atlantis-v5") | +| Action Space | Discrete(4) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Atlantis variants with different observation and action spaces, see the variants section. @@ -57,24 +57,12 @@ You score points for destroying enemies, keeping installations protected during Atlantis has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Atlantis-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Atlantis-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Atlantis-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Atlantis-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| AtlantisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| AtlantisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Atlantis-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Atlantis-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Atlantis-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Atlantis-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| AtlantisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| AtlantisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Atlantis-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Atlantis-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AtlantisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/atlantis2.md b/docs/environments/atlantis2.md index 92e5c3e5e..515373f9b 100644 --- a/docs/environments/atlantis2.md +++ b/docs/environments/atlantis2.md @@ -11,11 +11,11 @@ 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Atlantis2-v5") | +| Action Space | Discrete(4) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Atlantis2 variants with different observation and action spaces, see the variants section. @@ -57,10 +57,11 @@ You score points for destroying enemies, keeping installations protected during Atlantis2 has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Atlantis2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `Atlantis2NoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/backgammon.md b/docs/environments/backgammon.md index e7eb8acf2..a731f02a8 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/Backgammon-v5") | +| Action Space | Discrete(3) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Backgammon variants with different observation and action spaces, see the variants section. @@ -52,10 +52,11 @@ See variants section for the type of observation used by each environment id by Backgammon has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/Backgammon-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Backgammon-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/Backgammon-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BackgammonNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/bank_heist.md b/docs/environments/bank_heist.md index 9863fc405..2ce01c5fc 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/BankHeist-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more BankHeist variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points for robbing banks and destroying police cars. If you rob nine o BankHeist has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| BankHeist-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BankHeist-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BankHeist-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BankHeist-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BankHeistDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BankHeistNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BankHeist-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BankHeist-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BankHeist-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BankHeist-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BankHeistDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BankHeistNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BankHeist-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BankHeist-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BankHeist-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BankHeistNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/basic_math.md b/docs/environments/basic_math.md index 5d598d32d..5fa543865 100644 --- a/docs/environments/basic_math.md +++ b/docs/environments/basic_math.md @@ -11,11 +11,11 @@ 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/BasicMath-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more BasicMath variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by BasicMath has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/BasicMath-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BasicMath-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BasicMath-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BasicMathNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/battle_zone.md b/docs/environments/battle_zone.md index 995f7cc08..1631d738f 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/BattleZone-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more BattleZone variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You receive points for destroying enemies. For a more detailed documentation, se BattleZone has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| BattleZone-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BattleZone-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BattleZone-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BattleZone-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BattleZoneDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BattleZoneNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BattleZone-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BattleZone-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BattleZone-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BattleZone-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BattleZoneDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BattleZoneNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BattleZone-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BattleZone-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/BattleZone-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BattleZoneNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/beam_rider.md b/docs/environments/beam_rider.md index 14c1b71a8..a7489ab8a 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/BeamRider-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more BeamRider variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ You score points for destroying enemies. For a more detailed documentation, see BeamRider has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| BeamRider-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| BeamRider-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| BeamRider-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| BeamRider-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BeamRiderDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BeamRiderNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| BeamRider-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| BeamRider-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| BeamRider-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| BeamRider-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BeamRiderDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BeamRiderNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/BeamRider-v5 | `"rgb"` | `4` | `0.25` | -| ALE/BeamRider-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/BeamRider-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BeamRiderNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/berzerk.md b/docs/environments/berzerk.md index 57e64531c..63bdc215d 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Berzerk-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Berzerk variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points for destroying robots. For a more detailed documentation, see [ Berzerk has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Berzerk-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Berzerk-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Berzerk-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Berzerk-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BerzerkDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BerzerkNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Berzerk-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Berzerk-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Berzerk-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Berzerk-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BerzerkDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BerzerkNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Berzerk-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Berzerk-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Berzerk-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BerzerkNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/blackjack.md b/docs/environments/blackjack.md index aa27c5dd3..055de9604 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Blackjack-v5") | +| Action Space | Discrete(4) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Blackjack variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Blackjack has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/Blackjack-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Blackjack-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Blackjack-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BlackjackNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/bowling.md b/docs/environments/bowling.md index 85b16fed8..df1983a0f 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Bowling-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Bowling variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ You receive points for knocking down pins. The exact score depends on whether yo Bowling has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Bowling-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Bowling-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Bowling-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Bowling-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BowlingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BowlingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Bowling-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Bowling-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Bowling-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Bowling-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BowlingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BowlingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Bowling-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Bowling-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Bowling-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BowlingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/boxing.md b/docs/environments/boxing.md index aa173c698..1980c8930 100644 --- a/docs/environments/boxing.md +++ b/docs/environments/boxing.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Boxing-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Boxing-v5")` | For more Boxing variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points by landing punches. For a more detailed documentation, see [the Boxing has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Boxing-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Boxing-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Boxing-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Boxing-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BoxingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BoxingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Boxing-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Boxing-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Boxing-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Boxing-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BoxingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BoxingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Boxing-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Boxing-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Boxing-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BoxingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/breakout.md b/docs/environments/breakout.md index aca36c90d..7c93dbb38 100644 --- a/docs/environments/breakout.md +++ b/docs/environments/breakout.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Breakout-v5") | +| Action Space | Discrete(4) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Breakout variants with different observation and action spaces, see the variants section. ## 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. +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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889) @@ -57,22 +57,11 @@ You score points by destroying bricks in the wall. The reward for destroying a b Breakout has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Breakout-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Breakout-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Breakout-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Breakout-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| BreakoutDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| BreakoutNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Breakout-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Breakout-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Breakout-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Breakout-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| BreakoutDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| BreakoutNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Breakout-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Breakout-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Breakout-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BreakoutNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/carnival.md b/docs/environments/carnival.md index 602d6786c..960ff2063 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Carnival-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (214, 160, 3), uint8) | For more Carnival variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ You score points by destroying targets. Points (or bullets) may be subtracted if Carnival has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Carnival-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Carnival-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Carnival-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Carnival-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CarnivalDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CarnivalNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Carnival-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Carnival-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Carnival-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Carnival-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CarnivalDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CarnivalNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Carnival-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Carnival-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Carnival-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CarnivalNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/casino.md b/docs/environments/casino.md index 955ecd15c..621393d1c 100644 --- a/docs/environments/casino.md +++ b/docs/environments/casino.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Casino-v5") | | Action Space | Discrete(4) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Casino-v5")` | For more Casino variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Casino has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Casino-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Casino-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Casino-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CasinoNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/centipede.md b/docs/environments/centipede.md index a300345ac..69d6b9e15 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Centipede-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Centipede variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points by hitting centipedes, scorpions, fleas and spiders. Additional Centipede has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Centipede-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Centipede-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Centipede-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Centipede-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CentipedeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CentipedeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Centipede-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Centipede-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Centipede-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Centipede-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CentipedeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CentipedeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Centipede-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Centipede-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Centipede-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CentipedeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/chopper_command.md b/docs/environments/chopper_command.md index 2e3f7d50e..4c51bbdea 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")` | +| | | +|-------------------|-----------------------------------------| +| Make | gymnasium.make("ALE/ChopperCommand-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more ChopperCommand variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points by destroying planes and other helicopters. You score extra poi ChopperCommand has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------------|-------------|--------------|------------------------------| -| ChopperCommand-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| ChopperCommand-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| ChopperCommand-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| ChopperCommand-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ChopperCommandDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ChopperCommandNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| ChopperCommand-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| ChopperCommand-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| ChopperCommand-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| ChopperCommand-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ChopperCommandDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ChopperCommandNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/ChopperCommand-v5 | `"rgb"` | `4` | `0.25` | -| ALE/ChopperCommand-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/ChopperCommand-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ChopperCommandNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/crazy_climber.md b/docs/environments/crazy_climber.md index 110261818..27488052d 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/CrazyClimber-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more CrazyClimber variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ A table of scores awarded for completing each row of a building is provided on [ CrazyClimber has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| CrazyClimber-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| CrazyClimber-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| CrazyClimber-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| CrazyClimber-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| CrazyClimberDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| CrazyClimberNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| CrazyClimber-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| CrazyClimber-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| CrazyClimber-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| CrazyClimber-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| CrazyClimberDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| CrazyClimberNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/CrazyClimber-v5 | `"rgb"` | `4` | `0.25` | -| ALE/CrazyClimber-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/CrazyClimber-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CrazyClimberNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/crossbow.md b/docs/environments/crossbow.md index 1f0d9f982..ef61a951d 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Crossbow-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Crossbow variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Crossbow has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Crossbow-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Crossbow-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Crossbow-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `CrossbowNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/darkchambers.md b/docs/environments/darkchambers.md index deaefdc0a..e8a045bb4 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/Darkchambers-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Darkchambers variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Darkchambers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------|-------------|--------------|------------------------------| -| ALE/Darkchambers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Darkchambers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/Darkchambers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DarkchambersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/defender.md b/docs/environments/defender.md index 9e026037b..a5c3ae4c9 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Defender-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Defender variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You receive points for destroying enemies, rescuing abducted humans and keeping Defender has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Defender-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Defender-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Defender-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Defender-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DefenderDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DefenderNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Defender-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Defender-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Defender-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Defender-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DefenderDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DefenderNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Defender-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Defender-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Defender-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DefenderNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/demon_attack.md b/docs/environments/demon_attack.md index 187f40506..038e3f071 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/DemonAttack-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more DemonAttack variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ Each enemy you slay gives you points. The amount of points depends on the type o DemonAttack has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| DemonAttack-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| DemonAttack-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| DemonAttack-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| DemonAttack-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DemonAttackDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DemonAttackNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| DemonAttack-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| DemonAttack-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| DemonAttack-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| DemonAttack-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DemonAttackDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DemonAttackNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/DemonAttack-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DemonAttack-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/DemonAttack-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DemonAttackNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/donkey_kong.md b/docs/environments/donkey_kong.md index 08d6ac5e8..f756560a2 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/DonkeyKong-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more DonkeyKong variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by DonkeyKong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/DonkeyKong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DonkeyKong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/DonkeyKong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DonkeyKongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/double_dunk.md b/docs/environments/double_dunk.md index 0743b7c33..11a120afd 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/DoubleDunk-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more DoubleDunk variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ Scores follow the rules of basketball. You can get either 3 points, 2 points fou DoubleDunk has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| DoubleDunk-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| DoubleDunk-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| DoubleDunk-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| DoubleDunk-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| DoubleDunkDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| DoubleDunkNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| DoubleDunk-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| DoubleDunk-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| DoubleDunk-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| DoubleDunk-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| DoubleDunkDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| DoubleDunkNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/DoubleDunk-v5 | `"rgb"` | `4` | `0.25` | -| ALE/DoubleDunk-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/DoubleDunk-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `DoubleDunkNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/earthworld.md b/docs/environments/earthworld.md index 9eb716e49..a2bab7fb6 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/Earthworld-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Earthworld variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Earthworld has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/Earthworld-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Earthworld-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/Earthworld-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EarthworldNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/elevator_action.md b/docs/environments/elevator_action.md index 782ad8d15..5d9443f25 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")` | +| | | +|-------------------|-----------------------------------------| +| Make | gymnasium.make("ALE/ElevatorAction-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more ElevatorAction variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You start with 4 lives and are awarded 100 points for each enemy shot, and 500 p ElevatorAction has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------------|-------------|--------------|------------------------------| -| ElevatorAction-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| ElevatorAction-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| ElevatorAction-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| ElevatorAction-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ElevatorActionDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ElevatorActionNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| ElevatorAction-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| ElevatorAction-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| ElevatorAction-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| ElevatorAction-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ElevatorActionDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ElevatorActionNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/ElevatorAction-v5 | `"rgb"` | `4` | `0.25` | -| ALE/ElevatorAction-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/ElevatorAction-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ElevatorActionNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/enduro.md b/docs/environments/enduro.md index aa47427a1..50b67f70a 100644 --- a/docs/environments/enduro.md +++ b/docs/environments/enduro.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Enduro-v5") | | Action Space | Discrete(9) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Enduro-v5")` | For more Enduro variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ You get 1 point for each vehicle you overtake. Enduro has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Enduro-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Enduro-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Enduro-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Enduro-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| EnduroDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| EnduroNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Enduro-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Enduro-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Enduro-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Enduro-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| EnduroDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| EnduroNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Enduro-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Enduro-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Enduro-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EnduroNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/entombed.md b/docs/environments/entombed.md index 8c93634c8..0f421eadf 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Entombed-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Entombed variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Entombed has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Entombed-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Entombed-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Entombed-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EntombedNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/et.md b/docs/environments/et.md index 28d0d5119..85cd12114 100644 --- a/docs/environments/et.md +++ b/docs/environments/et.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Et-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Et-v5")` | For more Et variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Et has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------|-------------|--------------|------------------------------| -| ALE/Et-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Et-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------|-------------|--------------|------------------------------| +| ALE/Et-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `EtNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/fishing_derby.md b/docs/environments/fishing_derby.md index 79f2321a5..47dfb12aa 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/FishingDerby-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more FishingDerby variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The exact reward dynamics depend on the environment and are usually documented i FishingDerby has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| FishingDerby-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| FishingDerby-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| FishingDerby-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| FishingDerby-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FishingDerbyDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FishingDerbyNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| FishingDerby-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| FishingDerby-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| FishingDerby-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| FishingDerby-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FishingDerbyDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FishingDerbyNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/FishingDerby-v5 | `"rgb"` | `4` | `0.25` | -| ALE/FishingDerby-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/FishingDerby-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FishingDerbyNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/flag_capture.md b/docs/environments/flag_capture.md index 5ef4ec920..07505f7f9 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/FlagCapture-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more FlagCapture variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by FlagCapture has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/FlagCapture-v5 | `"rgb"` | `4` | `0.25` | -| ALE/FlagCapture-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/FlagCapture-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FlagCaptureNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/freeway.md b/docs/environments/freeway.md index 972bd05e7..42bac8815 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Freeway-v5") | +| Action Space | Discrete(3) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Freeway variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ The exact reward dynamics depend on the environment and are usually documented i Freeway has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Freeway-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Freeway-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Freeway-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Freeway-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FreewayDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FreewayNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Freeway-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Freeway-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Freeway-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Freeway-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FreewayDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FreewayNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Freeway-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Freeway-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Freeway-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FreewayNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/frogger.md b/docs/environments/frogger.md index cfdab505b..c65ab5e54 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Frogger-v5") | +| Action Space | Discrete(5) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Frogger variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Frogger has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Frogger-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Frogger-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Frogger-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FroggerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/frostbite.md b/docs/environments/frostbite.md index d214637cf..0009f8b75 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Frostbite-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Frostbite variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The exact reward dynamics depend on the environment and are usually documented i Frostbite has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Frostbite-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Frostbite-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Frostbite-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Frostbite-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| FrostbiteDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| FrostbiteNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Frostbite-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Frostbite-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Frostbite-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Frostbite-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| FrostbiteDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| FrostbiteNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Frostbite-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Frostbite-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Frostbite-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `FrostbiteNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/galaxian.md b/docs/environments/galaxian.md index 43a71e1c1..2fabe719b 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Galaxian-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Galaxian variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Galaxian has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Galaxian-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Galaxian-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Galaxian-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GalaxianNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/gopher.md b/docs/environments/gopher.md index 17c308613..9b628471e 100644 --- a/docs/environments/gopher.md +++ b/docs/environments/gopher.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Gopher-v5") | | Action Space | Discrete(8) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Gopher-v5")` | For more Gopher variants with different observation and action spaces, see the variants section. @@ -58,22 +58,11 @@ The exact reward dynamics depend on the environment and are usually documented i Gopher has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Gopher-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Gopher-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Gopher-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Gopher-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| GopherDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| GopherNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Gopher-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Gopher-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Gopher-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Gopher-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| GopherDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| GopherNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Gopher-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Gopher-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Gopher-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GopherNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/gravitar.md b/docs/environments/gravitar.md index e8dc39570..fed132ddd 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Gravitar-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Gravitar variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The exact reward dynamics depend on the environment and are usually documented i Gravitar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Gravitar-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Gravitar-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Gravitar-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Gravitar-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| GravitarDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| GravitarNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Gravitar-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Gravitar-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Gravitar-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Gravitar-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| GravitarDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| GravitarNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Gravitar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Gravitar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Gravitar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `GravitarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/hangman.md b/docs/environments/hangman.md index 388c35d6c..ef223eaea 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Hangman-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Hangman variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Hangman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Hangman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Hangman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Hangman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HangmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/haunted_house.md b/docs/environments/haunted_house.md index a0ac85a44..6fff0dc16 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/HauntedHouse-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more HauntedHouse variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by HauntedHouse has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------|-------------|--------------|------------------------------| -| ALE/HauntedHouse-v5 | `"rgb"` | `4` | `0.25` | -| ALE/HauntedHouse-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/HauntedHouse-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HauntedHouseNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/hero.md b/docs/environments/hero.md index ef31dd76f..2e31f86e6 100644 --- a/docs/environments/hero.md +++ b/docs/environments/hero.md @@ -13,15 +13,15 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Hero-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Hero-v5")` | For more Hero variants with different observation and action spaces, see the variants section. ## 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. +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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228) @@ -60,22 +60,11 @@ You score points for shooting critters, rescuing miners, and dynamiting walls. E Hero has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| Hero-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Hero-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Hero-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Hero-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| HeroDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| HeroNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Hero-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Hero-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Hero-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Hero-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| HeroDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| HeroNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Hero-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Hero-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Hero-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HeroNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/human_cannonball.md b/docs/environments/human_cannonball.md index f57ed85dc..55b6d9945 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")` | +| | | +|-------------------|------------------------------------------| +| Make | gymnasium.make("ALE/HumanCannonball-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more HumanCannonball variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by HumanCannonball has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| ALE/HumanCannonball-v5 | `"rgb"` | `4` | `0.25` | -| ALE/HumanCannonball-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------------|-------------|--------------|------------------------------| +| ALE/HumanCannonball-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `HumanCannonballNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/ice_hockey.md b/docs/environments/ice_hockey.md index c9958f429..0f7aaa800 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/IceHockey-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more IceHockey variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points by shooting the puck into your opponent's goal. Your opponent s IceHockey has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| IceHockey-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| IceHockey-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| IceHockey-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| IceHockey-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| IceHockeyDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| IceHockeyNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| IceHockey-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| IceHockey-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| IceHockey-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| IceHockey-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| IceHockeyDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| IceHockeyNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/IceHockey-v5 | `"rgb"` | `4` | `0.25` | -| ALE/IceHockey-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/IceHockey-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `IceHockeyNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/jamesbond.md b/docs/environments/jamesbond.md index 95bb74ec4..e83ddac43 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Jamesbond-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Jamesbond variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The game ends when you complete the last mission or when you lose the last craft Jamesbond has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Jamesbond-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Jamesbond-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Jamesbond-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Jamesbond-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| JamesbondDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| JamesbondNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Jamesbond-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Jamesbond-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Jamesbond-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Jamesbond-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| JamesbondDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| JamesbondNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Jamesbond-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Jamesbond-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Jamesbond-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `JamesbondNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/journey_escape.md b/docs/environments/journey_escape.md index 2dda072d5..87a60c3b2 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")` | +| | | +|-------------------|----------------------------------------| +| Make | gymnasium.make("ALE/JourneyEscape-v5") | +| Action Space | Discrete(16) | +| Observation Space | Box(0, 255, (230, 160, 3), uint8) | For more JourneyEscape variants with different observation and action spaces, see the variants section. @@ -61,22 +61,11 @@ At the start of the game, you will have $50,000 and 60 units of time. Your end g JourneyEscape has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------------|-------------|--------------|------------------------------| -| JourneyEscape-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| JourneyEscape-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| JourneyEscape-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| JourneyEscape-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| JourneyEscapeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| JourneyEscapeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| JourneyEscape-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| JourneyEscape-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| JourneyEscape-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| JourneyEscape-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| JourneyEscapeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| JourneyEscapeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/JourneyEscape-v5 | `"rgb"` | `4` | `0.25` | -| ALE/JourneyEscape-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/JourneyEscape-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `JourneyEscapeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kaboom.md b/docs/environments/kaboom.md index 7e45d7150..1907f99f5 100644 --- a/docs/environments/kaboom.md +++ b/docs/environments/kaboom.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Kaboom-v5") | | Action Space | Discrete(4) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Kaboom-v5")` | For more Kaboom variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Kaboom has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Kaboom-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Kaboom-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Kaboom-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KaboomNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kangaroo.md b/docs/environments/kangaroo.md index ea8b18bd5..2d9f04ad2 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Kangaroo-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Kangaroo variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ Your score will be shown at the top right corner of the game. Your end game scor Kangaroo has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Kangaroo-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Kangaroo-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Kangaroo-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Kangaroo-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KangarooDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KangarooNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Kangaroo-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Kangaroo-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Kangaroo-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Kangaroo-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KangarooDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KangarooNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Kangaroo-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Kangaroo-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Kangaroo-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KangarooNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/keystone_kapers.md b/docs/environments/keystone_kapers.md index b792beb79..00b7a46b8 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")` | +| | | +|-------------------|-----------------------------------------| +| Make | gymnasium.make("ALE/KeystoneKapers-v5") | +| Action Space | Discrete(14) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more KeystoneKapers variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by KeystoneKapers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| ALE/KeystoneKapers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KeystoneKapers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------------|-------------|--------------|------------------------------| +| ALE/KeystoneKapers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KeystoneKapersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/king_kong.md b/docs/environments/king_kong.md index 3f5198a55..6db5b699b 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/KingKong-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more KingKong variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by KingKong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/KingKong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KingKong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/KingKong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KingKongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/klax.md b/docs/environments/klax.md index 369edf753..6af1fc5eb 100644 --- a/docs/environments/klax.md +++ b/docs/environments/klax.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Klax-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Klax-v5")` | For more Klax variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Klax has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------|-------------|--------------|------------------------------| -| ALE/Klax-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Klax-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Klax-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KlaxNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/koolaid.md b/docs/environments/koolaid.md index cef5b6ecd..2dde709d5 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Koolaid-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Koolaid variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by Koolaid has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Koolaid-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Koolaid-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Koolaid-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KoolaidNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/krull.md b/docs/environments/krull.md index e3aee4bb8..a9d0657de 100644 --- a/docs/environments/krull.md +++ b/docs/environments/krull.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Krull-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Krull-v5")` | For more Krull variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You will receive various scores for each monster you kill. You can play the game Krull has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| Krull-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Krull-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Krull-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Krull-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KrullDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KrullNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Krull-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Krull-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Krull-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Krull-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KrullDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KrullNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Krull-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Krull-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------|-------------|--------------|------------------------------| +| ALE/Krull-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KrullNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/kung_fu_master.md b/docs/environments/kung_fu_master.md index c00b495e3..3ac244475 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/KungFuMaster-v5") | +| Action Space | Discrete(14) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more KungFuMaster variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by KungFuMaster has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| KungFuMaster-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| KungFuMaster-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| KungFuMaster-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| KungFuMaster-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| KungFuMasterDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| KungFuMasterNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| KungFuMaster-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| KungFuMaster-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| KungFuMaster-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| KungFuMaster-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| KungFuMasterDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| KungFuMasterNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/KungFuMaster-v5 | `"rgb"` | `4` | `0.25` | -| ALE/KungFuMaster-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/KungFuMaster-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `KungFuMasterNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/laser_gates.md b/docs/environments/laser_gates.md index 5c3e7d370..619033567 100644 --- a/docs/environments/laser_gates.md +++ b/docs/environments/laser_gates.md @@ -11,11 +11,11 @@ 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/LaserGates-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more LaserGates variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by LaserGates has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/LaserGates-v5 | `"rgb"` | `4` | `0.25` | -| ALE/LaserGates-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/LaserGates-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `LaserGatesNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/lost_luggage.md b/docs/environments/lost_luggage.md index e15ea8ac4..19a7d18d9 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/LostLuggage-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more LostLuggage variants with different observation and action spaces, see the variants section. @@ -54,10 +54,11 @@ See variants section for the type of observation used by each environment id by LostLuggage has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/LostLuggage-v5 | `"rgb"` | `4` | `0.25` | -| ALE/LostLuggage-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/LostLuggage-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `LostLuggageNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/mario_bros.md b/docs/environments/mario_bros.md index 5da734ab1..36aabed5c 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/MarioBros-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more MarioBros variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by MarioBros has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/MarioBros-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MarioBros-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/MarioBros-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MarioBrosNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/miniature_golf.md b/docs/environments/miniature_golf.md index 622422b7a..510ca42d6 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")` | +| | | +|-------------------|----------------------------------------| +| Make | gymnasium.make("ALE/MiniatureGolf-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more MiniatureGolf variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by MiniatureGolf has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| ALE/MiniatureGolf-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MiniatureGolf-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/MiniatureGolf-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MiniatureGolfNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/montezuma_revenge.md b/docs/environments/montezuma_revenge.md index 2fb88911a..87324e919 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")` | +| | | +|-------------------|-------------------------------------------| +| Make | gymnasium.make("ALE/MontezumaRevenge-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more MontezumaRevenge variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by MontezumaRevenge has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------------|-------------|--------------|------------------------------| -| MontezumaRevenge-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MontezumaRevenge-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MontezumaRevenge-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MontezumaRevenge-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MontezumaRevengeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MontezumaRevengeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MontezumaRevenge-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MontezumaRevenge-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MontezumaRevenge-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MontezumaRevenge-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MontezumaRevengeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MontezumaRevengeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MontezumaRevenge-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MontezumaRevenge-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------------|-------------|--------------|------------------------------| +| ALE/MontezumaRevenge-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MontezumaRevengeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/mr_do.md b/docs/environments/mr_do.md index 0988b0403..709c62266 100644 --- a/docs/environments/mr_do.md +++ b/docs/environments/mr_do.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/MrDo-v5") | | Action Space | Discrete(10) | | Observation Space | Box(0, 255, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/MrDo-v5")` | For more MrDo variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by MrDo has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------|-------------|--------------|------------------------------| -| ALE/MrDo-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MrDo-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/MrDo-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MrDoNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/ms_pacman.md b/docs/environments/ms_pacman.md index 1819df5ac..28a84d3bc 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/MsPacman-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more MsPacman variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by MsPacman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| MsPacman-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MsPacman-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MsPacman-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MsPacman-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MsPacmanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MsPacmanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MsPacman-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MsPacman-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MsPacman-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MsPacman-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MsPacmanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MsPacmanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MsPacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MsPacman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/MsPacman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `MsPacmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/name_this_game.md b/docs/environments/name_this_game.md index ac84f21d7..0f0a24002 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/NameThisGame-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more NameThisGame variants with different observation and action spaces, see the variants section. @@ -53,22 +53,11 @@ See variants section for the type of observation used by each environment id by NameThisGame has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| NameThisGame-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| NameThisGame-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| NameThisGame-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| NameThisGame-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| NameThisGameDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| NameThisGameNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| NameThisGame-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| NameThisGame-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| NameThisGame-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| NameThisGame-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| NameThisGameDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| NameThisGameNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/NameThisGame-v5 | `"rgb"` | `4` | `0.25` | -| ALE/NameThisGame-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/NameThisGame-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `NameThisGameNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/othello.md b/docs/environments/othello.md index fc153a185..ad46f5cb0 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Othello-v5") | +| Action Space | Discrete(10) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Othello variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by Othello has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Othello-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Othello-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Othello-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `OthelloNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pacman.md b/docs/environments/pacman.md index c203d492a..ee708fc92 100644 --- a/docs/environments/pacman.md +++ b/docs/environments/pacman.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Pacman-v5") | | Action Space | Discrete(5) | | Observation Space | Box(0, 255, (250, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Pacman-v5")` | For more Pacman variants with different observation and action spaces, see the variants section. @@ -51,24 +51,12 @@ See variants section for the type of observation used by each environment id by Pacman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| MsPacman-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| MsPacman-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| MsPacman-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| MsPacman-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| MsPacmanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| MsPacmanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| MsPacman-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| MsPacman-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| MsPacman-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| MsPacman-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| MsPacmanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| MsPacmanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/MsPacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/MsPacman-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Pacman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pacman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/MsPacman-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Pacman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PacmanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/phoenix.md b/docs/environments/phoenix.md index d2d80a170..16053c2be 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Phoenix-v5") | +| Action Space | Discrete(8) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Phoenix variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by Phoenix has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Phoenix-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Phoenix-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Phoenix-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Phoenix-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PhoenixDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PhoenixNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Phoenix-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Phoenix-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Phoenix-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Phoenix-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PhoenixDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PhoenixNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Phoenix-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Phoenix-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Phoenix-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PhoenixNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pitfall.md b/docs/environments/pitfall.md index 985b2453b..cf9b963b7 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Pitfall-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Pitfall variants with different observation and action spaces, see the variants section. @@ -60,24 +60,12 @@ You get score points for collecting treasure, you lose points through some misfo Pitfall has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Pitfall-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pitfall-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pitfall-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pitfall-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PitfallDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PitfallNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pitfall-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pitfall-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pitfall-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pitfall-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PitfallDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PitfallNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pitfall-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall-ram-v5 | `"ram"` | `4` | `0.25` | -| ALE/Pitfall2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Pitfall-v5 | `"rgb"` | `1` | `0.00` | +| ALE/Pitfall2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PitfallNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pitfall2.md b/docs/environments/pitfall2.md index 3308d9446..a5aa4812b 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Pitfall2-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Pitfall2 variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Pitfall2 has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Pitfall2-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pitfall2-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Pitfall2-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `Pitfall2NoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pong.md b/docs/environments/pong.md index 401b0bcba..cb68b1d90 100644 --- a/docs/environments/pong.md +++ b/docs/environments/pong.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Pong-v5") | | Action Space | Discrete(6) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Pong-v5")` | For more Pong variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ You get score points for getting the ball to pass the opponent's paddle. You los Pong has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| Pong-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pong-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pong-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pong-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PongDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PongNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pong-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pong-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pong-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pong-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PongDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PongNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pong-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pong-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------|-------------|--------------|------------------------------| +| ALE/Pong-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PongNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/pooyan.md b/docs/environments/pooyan.md index 4019db12a..55f337dc4 100644 --- a/docs/environments/pooyan.md +++ b/docs/environments/pooyan.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Pooyan-v5") | | Action Space | Discrete(6) | | Observation Space | Box(0, 255, (220, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Pooyan-v5")` | For more Pooyan variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ If you hit a balloon, wolf or stone with an arrow you score points. For a more d Pooyan has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Pooyan-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Pooyan-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Pooyan-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Pooyan-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PooyanDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PooyanNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Pooyan-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Pooyan-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Pooyan-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Pooyan-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PooyanDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PooyanNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Pooyan-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Pooyan-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Pooyan-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PooyanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/private_eye.md b/docs/environments/private_eye.md index 8e8d95b02..55e349e81 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/PrivateEye-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more PrivateEye variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points for completing your tasks like gathering evidence, nabbing ques PrivateEye has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| PrivateEye-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| PrivateEye-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| PrivateEye-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| PrivateEye-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| PrivateEyeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| PrivateEyeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| PrivateEye-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| PrivateEye-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| PrivateEye-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| PrivateEye-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| PrivateEyeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| PrivateEyeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/PrivateEye-v5 | `"rgb"` | `4` | `0.25` | -| ALE/PrivateEye-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/PrivateEye-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `PrivateEyeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/qbert.md b/docs/environments/qbert.md index d4ed6872a..7a9eaa3b2 100644 --- a/docs/environments/qbert.md +++ b/docs/environments/qbert.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Qbert-v5") | | Action Space | Discrete(6) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Qbert-v5")` | For more Qbert variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ You score points for changing color of the cubes to their destination colors or Qbert has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------|-------------|--------------|------------------------------| -| Qbert-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Qbert-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Qbert-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Qbert-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| QbertDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| QbertNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Qbert-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Qbert-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Qbert-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Qbert-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| QbertDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| QbertNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Qbert-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Qbert-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------|-------------|--------------|------------------------------| +| ALE/Qbert-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `QbertNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/riverraid.md b/docs/environments/riverraid.md index 7c17f03da..e362b634a 100644 --- a/docs/environments/riverraid.md +++ b/docs/environments/riverraid.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Riverraid-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Riverraid variants with different observation and action spaces, see the variants section. ## 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. +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. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=409) @@ -53,7 +53,7 @@ See variants section for the type of observation used by each environment id by ### Reward -Score points are your only reward. You get score points each time you destroy an enemy object: +Score points are your only reward. You get score points each time you destroy an enemy object: | Enemy Object | Score Points | |--------------|--------------| @@ -70,22 +70,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ Riverraid has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Riverraid-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Riverraid-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Riverraid-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Riverraid-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RiverraidDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RiverraidNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Riverraid-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Riverraid-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Riverraid-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Riverraid-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RiverraidDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RiverraidNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Riverraid-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Riverraid-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Riverraid-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RiverraidNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/road_runner.md b/docs/environments/road_runner.md index c48454729..9f8a78955 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/RoadRunner-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more RoadRunner variants with different observation and action spaces, see the variants section. @@ -69,22 +69,11 @@ For a more detailed documentation, see [the AtariAge page](https://atariage.com/ RoadRunner has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| RoadRunner-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| RoadRunner-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| RoadRunner-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| RoadRunner-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RoadRunnerDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RoadRunnerNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| RoadRunner-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| RoadRunner-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| RoadRunner-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| RoadRunner-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RoadRunnerDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RoadRunnerNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/RoadRunner-v5 | `"rgb"` | `4` | `0.25` | -| ALE/RoadRunner-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/RoadRunner-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RoadRunnerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/robotank.md b/docs/environments/robotank.md index bfff2adfa..cc9403dd0 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Robotank-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Robotank variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The number of enemies destroyed is the only reward. A small tank appears at the Robotank has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Robotank-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Robotank-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Robotank-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Robotank-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| RobotankDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| RobotankNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Robotank-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Robotank-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Robotank-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Robotank-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| RobotankDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| RobotankNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Robotank-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Robotank-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Robotank-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `RobotankNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/seaquest.md b/docs/environments/seaquest.md index ea6afbfde..9081528ac 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Seaquest-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Seaquest variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ Score points are your only reward. Blasting enemy sub and killer shark is worth Seaquest has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------------|-------------|--------------|------------------------------| -| Seaquest-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Seaquest-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Seaquest-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Seaquest-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SeaquestDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SeaquestNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Seaquest-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Seaquest-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Seaquest-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Seaquest-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SeaquestDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SeaquestNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Seaquest-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Seaquest-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Seaquest-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SeaquestNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/sir_lancelot.md b/docs/environments/sir_lancelot.md index d0963ece3..87686664a 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/SirLancelot-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more SirLancelot variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by SirLancelot has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/SirLancelot-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SirLancelot-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/SirLancelot-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SirLancelotNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/skiing.md b/docs/environments/skiing.md index e3c3455cb..1578b01a1 100644 --- a/docs/environments/skiing.md +++ b/docs/environments/skiing.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Skiing-v5") | | Action Space | Discrete(3) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Skiing-v5")` | For more Skiing variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ Seconds are your only rewards - negative rewards and penalties (e.g. missing a g Skiing has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Skiing-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Skiing-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Skiing-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Skiing-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SkiingDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SkiingNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Skiing-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Skiing-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Skiing-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Skiing-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SkiingDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SkiingNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Skiing-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Skiing-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Skiing-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SkiingNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/solaris.md b/docs/environments/solaris.md index f622e8652..1a07c830d 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Solaris-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Solaris variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You gain points for destroying enemies, rescuing cadets, making it through a cor Solaris has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Solaris-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Solaris-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Solaris-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Solaris-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SolarisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| SolarisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Solaris-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Solaris-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Solaris-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Solaris-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SolarisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| SolarisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Solaris-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Solaris-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Solaris-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SolarisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/space_invaders.md b/docs/environments/space_invaders.md index 61dae8260..a3adbd696 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")` | +| | | +|-------------------|----------------------------------------| +| Make | gymnasium.make("ALE/SpaceInvaders-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more SpaceInvaders variants with different observation and action spaces, see the variants section. @@ -57,22 +57,11 @@ You gain points for destroying space invaders. The invaders in the back rows are SpaceInvaders has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------------|-------------|--------------|------------------------------| -| SpaceInvaders-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| SpaceInvaders-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| SpaceInvaders-ramDeterministic-v0 | `"ram"` | `3` | `0.25` | -| SpaceInvaders-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| SpaceInvadersDeterministic-v0 | `"rgb"` | `3` | `0.25` | -| SpaceInvadersNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| SpaceInvaders-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| SpaceInvaders-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| SpaceInvaders-ramDeterministic-v4 | `"ram"` | `3` | `0.0` | -| SpaceInvaders-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| SpaceInvadersDeterministic-v4 | `"rgb"` | `3` | `0.0` | -| SpaceInvadersNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/SpaceInvaders-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SpaceInvaders-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/SpaceInvaders-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SpaceInvadersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/space_war.md b/docs/environments/space_war.md index 1406f4a08..545d195e5 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/SpaceWar-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (250, 160, 3), uint8) | For more SpaceWar variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by SpaceWar has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/SpaceWar-v5 | `"rgb"` | `4` | `0.25` | -| ALE/SpaceWar-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/SpaceWar-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SpaceWarNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/star_gunner.md b/docs/environments/star_gunner.md index 807efcb93..447b812eb 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/StarGunner-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more StarGunner variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ You score points for destroying enemies. You get bonus points for clearing a wav StarGunner has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------------|-------------|--------------|------------------------------| -| StarGunner-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| StarGunner-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| StarGunner-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| StarGunner-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| StarGunnerDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| StarGunnerNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| StarGunner-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| StarGunner-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| StarGunner-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| StarGunner-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| StarGunnerDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| StarGunnerNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/StarGunner-v5 | `"rgb"` | `4` | `0.25` | -| ALE/StarGunner-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/StarGunner-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `StarGunnerNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/superman.md b/docs/environments/superman.md index ecd467448..451573353 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Superman-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Superman variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Superman has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Superman-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Superman-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Superman-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SupermanNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/surround.md b/docs/environments/surround.md index c7ca6c5af..f5e3f0464 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Surround-v5") | +| Action Space | Discrete(5) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Surround variants with different observation and action spaces, see the variants section. @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by Surround has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Surround-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Surround-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Surround-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `SurroundNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tennis.md b/docs/environments/tennis.md index 02f9e5244..8922b12e4 100644 --- a/docs/environments/tennis.md +++ b/docs/environments/tennis.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Tennis-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Tennis-v5")` | For more Tennis variants with different observation and action spaces, see the variants section. @@ -60,22 +60,11 @@ The scoring is as per the sport of tennis, played till one set. For a more detai Tennis has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Tennis-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Tennis-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Tennis-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Tennis-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TennisDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TennisNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Tennis-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Tennis-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Tennis-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Tennis-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TennisDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TennisNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Tennis-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tennis-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Tennis-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TennisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tetris.md b/docs/environments/tetris.md index 97a2d5213..935dd547a 100644 --- a/docs/environments/tetris.md +++ b/docs/environments/tetris.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Tetris-v5") | | Action Space | Discrete(5) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Tetris-v5")` | For more Tetris variants with different observation and action spaces, see the variants section. @@ -51,10 +51,11 @@ See variants section for the type of observation used by each environment id by Tetris has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------|-------------|--------------|------------------------------| -| ALE/Tetris-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tetris-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Tetris-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TetrisNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tic_tac_toe_3d.md b/docs/environments/tic_tac_toe_3d.md index f97743e47..ed788d69d 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/TicTacToe3D-v5") | +| Action Space | Discrete(10) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more TicTacToe3D variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by TicTacToe3D has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|------------------------|-------------|--------------|------------------------------| -| ALE/TicTacToe3D-v5 | `"rgb"` | `4` | `0.25` | -| ALE/TicTacToe3D-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/TicTacToe3D-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TicTacToe3DNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/time_pilot.md b/docs/environments/time_pilot.md index c94ee30af..156362ae6 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/TimePilot-v5") | +| Action Space | Discrete(10) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more TimePilot variants with different observation and action spaces, see the variants section. @@ -59,22 +59,11 @@ You score points for destroying enemies, gaining more points for difficult enemi TimePilot has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| TimePilot-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| TimePilot-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| TimePilot-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| TimePilot-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TimePilotDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TimePilotNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| TimePilot-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| TimePilot-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| TimePilot-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| TimePilot-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TimePilotDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TimePilotNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/TimePilot-v5 | `"rgb"` | `4` | `0.25` | -| ALE/TimePilot-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/TimePilot-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TimePilotNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/trondead.md b/docs/environments/trondead.md index a08e457d4..a97606182 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Trondead-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Trondead variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by Trondead has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------|-------------|--------------|------------------------------| -| ALE/Trondead-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Trondead-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-----------------|-------------|--------------|------------------------------| +| ALE/Trondead-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TrondeadNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/turmoil.md b/docs/environments/turmoil.md index 25bd5ce1f..185005a34 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Turmoil-v5") | +| Action Space | Discrete(12) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Turmoil variants with different observation and action spaces, see the variants section. @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by Turmoil has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------|-------------|--------------|------------------------------| -| ALE/Turmoil-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Turmoil-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Turmoil-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TurmoilNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/tutankham.md b/docs/environments/tutankham.md index 642244bdc..b5f07a63c 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/Tutankham-v5") | +| Action Space | Discrete(8) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Tutankham variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by Tutankham has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-------------------------------|-------------|--------------|------------------------------| -| Tutankham-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Tutankham-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Tutankham-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Tutankham-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| TutankhamDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| TutankhamNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Tutankham-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Tutankham-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Tutankham-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Tutankham-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| TutankhamDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| TutankhamNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Tutankham-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Tutankham-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/Tutankham-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `TutankhamNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/up_n_down.md b/docs/environments/up_n_down.md index 8ba823c28..c989f507b 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/UpNDown-v5") | +| Action Space | Discrete(6) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more UpNDown variants with different observation and action spaces, see the variants section. @@ -53,22 +53,11 @@ See variants section for the type of observation used by each environment id by UpNDown has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| UpNDown-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| UpNDown-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| UpNDown-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| UpNDown-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| UpNDownDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| UpNDownNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| UpNDown-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| UpNDown-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| UpNDown-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| UpNDown-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| UpNDownDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| UpNDownNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/UpNDown-v5 | `"rgb"` | `4` | `0.25` | -| ALE/UpNDown-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/UpNDown-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `UpNDownNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/venture.md b/docs/environments/venture.md index f93ee95e8..2144a8665 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")` | +| | | +|-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Venture-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more Venture variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by Venture has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------------|-------------|--------------|------------------------------| -| Venture-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Venture-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Venture-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Venture-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| VentureDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| VentureNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Venture-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Venture-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Venture-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Venture-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| VentureDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| VentureNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Venture-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Venture-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------|-------------|--------------|------------------------------| +| ALE/Venture-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VentureNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_checkers.md b/docs/environments/video_checkers.md index 626988710..3c2469af0 100644 --- a/docs/environments/video_checkers.md +++ b/docs/environments/video_checkers.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|----------------------------------------| +| Make | gymnasium.make("ALE/VideoCheckers-v5") | +| Action Space | Discrete(5) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more VideoCheckers variants with different observation and action spaces, see the variants section. ## Description -Classic checkers: move your color pieces towards the opposite end of the board, jumping over opponents pieces to remove them from the board and gaining a king when you reach the other side. +Move your color pieces towards the opposite end of the board, jumping over opponents pieces to remove them from the board and gaining a king when you reach the other side. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=579) @@ -53,10 +53,11 @@ See variants section for the type of observation used by each environment id by VideoCheckers has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|--------------------------|-------------|--------------|------------------------------| -| ALE/VideoCheckers-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoCheckers-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|----------------------|-------------|--------------|------------------------------| +| ALE/VideoCheckers-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoCheckersNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_chess.md b/docs/environments/video_chess.md index 3ae8aaaef..94b33fefc 100644 --- a/docs/environments/video_chess.md +++ b/docs/environments/video_chess.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/VideoChess-v5") | +| Action Space | Discrete(10) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more VideoChess variants with different observation and action spaces, see the variants section. ## Description -This is the usual game of chess: capture the opponents king. +This is the usual game of chess, capture the opponents king. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=581) @@ -55,10 +55,11 @@ See variants section for the type of observation used by each environment id by VideoChess has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/VideoChess-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoChess-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/VideoChess-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoChessNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_cube.md b/docs/environments/video_cube.md index aa5150fa1..6112e4fdf 100644 --- a/docs/environments/video_cube.md +++ b/docs/environments/video_cube.md @@ -11,17 +11,17 @@ 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")` | +| | | +|-------------------|------------------------------------| +| Make | gymnasium.make("ALE/VideoCube-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more VideoCube variants with different observation and action spaces, see the variants section. ## Description -Solve a Rubik's cube in a nonstandard way: guide Hubie around the cube and swap tiles on the cubes face with one another until each face consists of only one color. +Solve a Rubik's cube in a nonstandard way, guide Hubie around the cube and swap tiles on the cubes face with one another until each face consists of only one color. For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=974) @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by VideoCube has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------|-------------|--------------|------------------------------| -| ALE/VideoCube-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoCube-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|------------------|-------------|--------------|------------------------------| +| ALE/VideoCube-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoCubeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/video_pinball.md b/docs/environments/video_pinball.md index eb208a33b..7a31e2cb5 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")` | +| | | +|-------------------|---------------------------------------| +| Make | gymnasium.make("ALE/VideoPinball-v5") | +| Action Space | Discrete(9) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more VideoPinball variants with different observation and action spaces, see the variants section. @@ -54,22 +54,11 @@ See variants section for the type of observation used by each environment id by VideoPinball has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------------|-------------|--------------|------------------------------| -| VideoPinball-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| VideoPinball-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| VideoPinball-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| VideoPinball-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| VideoPinballDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| VideoPinballNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| VideoPinball-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| VideoPinball-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| VideoPinball-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| VideoPinball-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| VideoPinballDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| VideoPinballNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/VideoPinball-v5 | `"rgb"` | `4` | `0.25` | -| ALE/VideoPinball-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------------|-------------|--------------|------------------------------| +| ALE/VideoPinball-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `VideoPinballNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/wizard_of_wor.md b/docs/environments/wizard_of_wor.md index 91cdb7680..2dced00cd 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/WizardOfWor-v5") | +| Action Space | Discrete(10) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more WizardOfWor variants with different observation and action spaces, see the variants section. @@ -55,22 +55,11 @@ See variants section for the type of observation used by each environment id by WizardOfWor has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| WizardOfWor-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| WizardOfWor-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| WizardOfWor-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| WizardOfWor-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| WizardOfWorDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| WizardOfWorNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| WizardOfWor-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| WizardOfWor-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| WizardOfWor-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| WizardOfWor-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| WizardOfWorDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| WizardOfWorNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/WizardOfWor-v5 | `"rgb"` | `4` | `0.25` | -| ALE/WizardOfWor-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/WizardOfWor-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `WizardOfWorNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/word_zapper.md b/docs/environments/word_zapper.md index c177bbd33..184fbc0eb 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")` | +| | | +|-------------------|-------------------------------------| +| Make | gymnasium.make("ALE/WordZapper-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more WordZapper variants with different observation and action spaces, see the variants section. @@ -56,10 +56,11 @@ See variants section for the type of observation used by each environment id by WordZapper has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|-----------------------|-------------|--------------|------------------------------| -| ALE/WordZapper-v5 | `"rgb"` | `4` | `0.25` | -| ALE/WordZapper-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|-------------------|-------------|--------------|------------------------------| +| ALE/WordZapper-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `WordZapperNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/yars_revenge.md b/docs/environments/yars_revenge.md index 713ad7f3a..5eb0a54a4 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")` | +| | | +|-------------------|--------------------------------------| +| Make | gymnasium.make("ALE/YarsRevenge-v5") | +| Action Space | Discrete(18) | +| Observation Space | Box(0, 255, (210, 160, 3), uint8) | For more YarsRevenge variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by YarsRevenge has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|---------------------------------|-------------|--------------|------------------------------| -| YarsRevenge-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| YarsRevenge-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| YarsRevenge-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| YarsRevenge-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| YarsRevengeDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| YarsRevengeNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| YarsRevenge-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| YarsRevenge-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| YarsRevenge-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| YarsRevenge-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| YarsRevengeDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| YarsRevengeNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/YarsRevenge-v5 | `"rgb"` | `4` | `0.25` | -| ALE/YarsRevenge-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|--------------------|-------------|--------------|------------------------------| +| ALE/YarsRevenge-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `YarsRevengeNoFrameskip-v4`. ## Difficulty and modes diff --git a/docs/environments/zaxxon.md b/docs/environments/zaxxon.md index 0c1a2c613..79ea77f48 100644 --- a/docs/environments/zaxxon.md +++ b/docs/environments/zaxxon.md @@ -13,9 +13,9 @@ This environment is part of the Atari environments. Please read | | | |-------------------|-----------------------------------| +| Make | gymnasium.make("ALE/Zaxxon-v5") | | Action Space | Discrete(18) | | Observation Space | Box(0, 255, (210, 160, 3), uint8) | -| Import | `gymnasium.make("ALE/Zaxxon-v5")` | For more Zaxxon variants with different observation and action spaces, see the variants section. @@ -56,22 +56,11 @@ See variants section for the type of observation used by each environment id by Zaxxon has the following variants of the environment id which have the following differences in observation, the number of frame-skips and the repeat action probability. -| Env-id | obs_type= | frameskip= | repeat_action_probability= | -|----------------------------|-------------|--------------|------------------------------| -| Zaxxon-v0 | `"rgb"` | `(2, 5)` | `0.25` | -| Zaxxon-ram-v0 | `"ram"` | `(2, 5)` | `0.25` | -| Zaxxon-ramDeterministic-v0 | `"ram"` | `4` | `0.25` | -| Zaxxon-ramNoFrameskip-v0 | `"ram"` | `1` | `0.25` | -| ZaxxonDeterministic-v0 | `"rgb"` | `4` | `0.25` | -| ZaxxonNoFrameskip-v0 | `"rgb"` | `1` | `0.25` | -| Zaxxon-v4 | `"rgb"` | `(2, 5)` | `0.0` | -| Zaxxon-ram-v4 | `"ram"` | `(2, 5)` | `0.0` | -| Zaxxon-ramDeterministic-v4 | `"ram"` | `4` | `0.0` | -| Zaxxon-ramNoFrameskip-v4 | `"ram"` | `1` | `0.0` | -| ZaxxonDeterministic-v4 | `"rgb"` | `4` | `0.0` | -| ZaxxonNoFrameskip-v4 | `"rgb"` | `1` | `0.0` | -| ALE/Zaxxon-v5 | `"rgb"` | `4` | `0.25` | -| ALE/Zaxxon-ram-v5 | `"ram"` | `4` | `0.25` | +| Env-id | obs_type= | frameskip= | repeat_action_probability= | +|---------------|-------------|--------------|------------------------------| +| ALE/Zaxxon-v5 | `"rgb"` | `1` | `0.00` | + +See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `ZaxxonNoFrameskip-v4`. ## Difficulty and modes