diff --git a/.github/workflows/build-docs.yml b/.github/workflows/docs-build-dev.yml similarity index 100% rename from .github/workflows/build-docs.yml rename to .github/workflows/docs-build-dev.yml diff --git a/.github/workflows/docs-versioning.yml b/.github/workflows/docs-build-release.yml similarity index 97% rename from .github/workflows/docs-versioning.yml rename to .github/workflows/docs-build-release.yml index bb5d86463..544f813c3 100644 --- a/.github/workflows/docs-versioning.yml +++ b/.github/workflows/docs-build-release.yml @@ -1,10 +1,10 @@ -name: Docs Versioning +name: Build release documentation website on: push: tags: - 'v?*.*.*' - - + permissions: contents: write diff --git a/.github/workflows/docs-manual-versioning.yml b/.github/workflows/docs-manual-build.yml similarity index 98% rename from .github/workflows/docs-manual-versioning.yml rename to .github/workflows/docs-manual-build.yml index a8f7083f2..8c5d877ff 100644 --- a/.github/workflows/docs-manual-versioning.yml +++ b/.github/workflows/docs-manual-build.yml @@ -1,4 +1,4 @@ -name: Manual Docs Versioning +name: Manually Build Website on: workflow_dispatch: diff --git a/.github/workflows/build-publish.yml b/.github/workflows/pypi-publish.yml similarity index 91% rename from .github/workflows/build-publish.yml rename to .github/workflows/pypi-publish.yml index 30284096c..7611a7488 100644 --- a/.github/workflows/build-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -4,7 +4,7 @@ # - https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/ # # derived from https://github.com/Farama-Foundation/PettingZoo/blob/e230f4d80a5df3baf9bd905149f6d4e8ce22be31/.github/workflows/build-publish.yml -name: build-publish +name: Build artifact for PyPI on: push: @@ -20,11 +20,7 @@ jobs: steps: - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.8' + - uses: actions/setup-python@v5 - name: Install dependencies run: python -m pip install --upgrade pip setuptools build diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/run-pre-commit.yml similarity index 95% rename from .github/workflows/pre-commit.yml rename to .github/workflows/run-pre-commit.yml index 97b55cb6c..5d0015cd1 100644 --- a/.github/workflows/pre-commit.yml +++ b/.github/workflows/run-pre-commit.yml @@ -1,6 +1,6 @@ # https://pre-commit.com # This GitHub Action assumes that the repo contains a valid .pre-commit-config.yaml file. -name: pre-commit +name: Run pre-commit on: pull_request: push: diff --git a/.github/workflows/build.yml b/.github/workflows/run-pytest.yml similarity index 93% rename from .github/workflows/build.yml rename to .github/workflows/run-pytest.yml index 4de7cbbde..7ded82063 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/run-pytest.yml @@ -1,4 +1,4 @@ -name: build +name: Run PyTest on: [pull_request, push] permissions: @@ -8,6 +8,7 @@ jobs: build-all: runs-on: ubuntu-latest strategy: + fail-fast: true matrix: python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] numpy-version: ['>=1.21,<2.0', '>=2.0'] @@ -24,7 +25,7 @@ jobs: - name: Run tests run: docker run gymnasium-all-docker pytest tests/* - name: Run doctests - # if: ${{ matrix.numpy-version == '>=2.0' }} + if: ${{ matrix.python-version != '3.8' }} run: docker run gymnasium-all-docker pytest --doctest-modules gymnasium/ build-necessary: diff --git a/docs/environments/.htaccess b/docs/environments/.htaccess new file mode 100644 index 000000000..1acaea949 --- /dev/null +++ b/docs/environments/.htaccess @@ -0,0 +1,8 @@ +# Enable mod_rewrite +RewriteEngine On + +# Redirect for the main Atari environments page +RewriteRule ^atari/?$ https://ale.farama.org/environments/ [R=301,L] + +# Redirect for all files under the Atari directory +RewriteRule ^atari/(.*)$ https://ale.farama.org/environments/$1 [R=301,L] diff --git a/docs/environments/atari.md b/docs/environments/atari.md index ab9f3617b..0269289f7 100644 --- a/docs/environments/atari.md +++ b/docs/environments/atari.md @@ -3,10 +3,6 @@ firstpage: lastpage: --- -# Atari - -A set of Atari 2600 environments simulated through [Stella](https://github.com/stella-emu/stella) and the [Arcade Learning Environment](https://github.com/mgbellemare/Arcade-Learning-Environment). - ```{toctree} :hidden: atari/adventure @@ -115,265 +111,12 @@ atari/yars_revenge atari/zaxxon ``` -```{raw} html - :file: atari/list.html -``` - -Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1) through the Stella emulator. - -```python -import gymnasium as gym -import ale_py - -gym.register_envs(ale_py) - -env = gym.make("ALE/Pong-v5") -# Optionally include the `gym.wrappers.AtariPreprocessing` - -obs, info = env.reset() -episode_over = False -while not episode_over: - action = env.action_space.sample() # replace with your policy - obs, reward, terminated, truncated, info = env.step(action) - - episode_over = terminated or truncated -env.close() -``` - -## Action Space - -Each environment will use a sub-set of the full action space listed below: - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - - - -By default, most environments use a smaller subset of the legal actions excluding any actions that don't have an effect in the game. -If users are interested in using all possible actions, pass the keyword argument `full_action_space=True` to `gymnasium.make`. - -## Observation Space - -The Atari environments observation can be -1. The RGB image that is displayed to a human player using `obs_type="rgb"` with observation space `Box(0, 255, (210, 160, 3), np.uint8)` -2. The grayscale version of the RGB image using `obs_type="grayscale"` with observation space `Box(0, 255, (210, 160), np.uint8)` -3. The RAM state (128 bytes) from the console using `obs_type="ram"` with observation space `Box(0, 255, (128), np.uint8)` - -## 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/). - -## 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. - -To avoid this, there are several methods to avoid this. - -1. Sticky actions: Instead of always simulating the action passed to the environment, there is a small -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 -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 -random between `frameskip[0]` (inclusive) and `frameskip[1]` (exclusive) in each environment step. - -## Common Arguments - -When initializing Atari environments via `gymnasium.make`, you may pass some additional arguments. These work for any -Atari environment. - -- **mode**: `int`. Game mode, see [[2]](#2). Legal values depend on the environment and are listed in the table above. - -- **difficulty**: `int`. The difficulty of the game, see [[2]](#2). Legal values depend on the environment and are listed in -the table above. Together with `mode`, this determines the "flavor" of the game. - -- **obs_type**: `str`. This argument determines what observations are returned by the environment. Its values are: - - "ram": The 128 Bytes of RAM are returned - - "rgb": An RGB rendering of the game is returned - - "grayscale": A grayscale rendering is returned - -- **frameskip**: `int` or a tuple of two `int`s. This argument controls stochastic frame skipping, as described in the section on stochasticity. - -- **repeat_action_probability**: `float`. The probability that an action is repeated, also called "sticky actions", as described in the section on stochasticity. - -- **full_action_space**: `bool`. If set to `True`, the action space consists of all legal actions on the console. Otherwise, the -action space will be reduced to a subset. - -- **render_mode**: `str`. Specifies the rendering mode. Its values are: - - human: Display the screen and enable game sounds. This will lock emulation to the ROMs specified FPS - - rgb_array: Returns the current environment RGB frame of the environment. - -## 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 | Varies with the suffix (see below). | `0.25` | `False` | -| v4 | Varies with the suffix (see below). | `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` | - -## Flavors - -Some games allow the user to set a difficulty level and a game mode. Different modes/difficulties may have different -game dynamics and (if a reduced action space is used) different action spaces. We follow the convention of [[2]](#2) and -refer to the combination of difficulty level and game mode as a flavor of a game. The following table shows -the available modes and difficulty levels for different Atari games: - -| Environment | Possible Modes | Default Mode | Possible Difficulties | Default Difficulty | -|------------------|-------------------------------------------------|----------------|-------------------------|----------------------| -| Adventure | [0, 1, 2] | 0 | [0, 1, 2, 3] | 0 | -| AirRaid | [1, ..., 8] | 1 | [0] | 0 | -| Alien | [0, 1, 2, 3] | 0 | [0, 1, 2, 3] | 0 | -| Amidar | [0] | 0 | [0, 3] | 0 | -| Assault | [0] | 0 | [0] | 0 | -| Asterix | [0] | 0 | [0] | 0 | -| Asteroids | [0, ..., 31, 128] | 0 | [0, 3] | 0 | -| Atlantis | [0, 1, 2, 3] | 0 | [0] | 0 | -| Atlantis2 | [0] | 0 | [0] | 0 | -| Backgammon | [0] | 0 | [3] | 0 | -| BankHeist | [0, 4, 8, 12, 16, 20, 24, 28] | 0 | [0, 1, 2, 3] | 0 | -| BasicMath | [5, 6, 7, 8] | 5 | [0, 2, 3] | 0 | -| BattleZone | [1, 2, 3] | 1 | [0] | 0 | -| BeamRider | [0] | 0 | [0, 1] | 0 | -| Berzerk | [1, ..., 9, 16, 17, 18] | 1 | [0] | 0 | -| Blackjack | [0] | 0 | [0, 1, 2, 3] | 0 | -| Bowling | [0, 2, 4] | 0 | [0, 1] | 0 | -| Boxing | [0] | 0 | [0, 1, 2, 3] | 0 | -| Breakout | [0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44] | 0 | [0, 1] | 0 | -| Carnival | [0] | 0 | [0] | 0 | -| Casino | [0, 2, 3] | 0 | [0, 1, 2, 3] | 0 | -| Centipede | [22, 86] | 22 | [0] | 0 | -| ChopperCommand | [0, 2] | 0 | [0, 1] | 0 | -| CrazyClimber | [0, 1, 2, 3] | 0 | [0, 1] | 0 | -| Crossbow | [0, 2, 4, 6] | 0 | [0, 1] | 0 | -| Darkchambers | [0] | 0 | [0] | 0 | -| Defender | [1, ..., 9, 16] | 1 | [0, 1] | 0 | -| DemonAttack | [1, 3, 5, 7] | 1 | [0, 1] | 0 | -| DonkeyKong | [0] | 0 | [0] | 0 | -| DoubleDunk | [0, ..., 15] | 0 | [0] | 0 | -| Earthworld | [0] | 0 | [0] | 0 | -| ElevatorAction | [0] | 0 | [0] | 0 | -| Enduro | [0] | 0 | [0] | 0 | -| Entombed | [0] | 0 | [0, 2] | 0 | -| Et | [0, 1, 2] | 0 | [0, 1, 2, 3] | 0 | -| FishingDerby | [0] | 0 | [0, 1, 2, 3] | 0 | -| FlagCapture | [8, 9, 10] | 8 | [0] | 0 | -| Freeway | [0, ..., 7] | 0 | [0, 1] | 0 | -| Frogger | [0, 1, 2] | 0 | [0, 1] | 0 | -| Frostbite | [0, 2] | 0 | [0] | 0 | -| Galaxian | [1, ..., 9] | 1 | [0, 1] | 0 | -| Gopher | [0, 2] | 0 | [0, 1] | 0 | -| Gravitar | [0, 1, 2, 3, 4] | 0 | [0] | 0 | -| Hangman | [0, 1, 2, 3] | 0 | [0, 1] | 0 | -| HauntedHouse | [0, ..., 8] | 0 | [0, 1] | 0 | -| Hero | [0, 1, 2, 3, 4] | 0 | [0] | 0 | -| HumanCannonball | [0, ..., 7] | 0 | [0, 1] | 0 | -| IceHockey | [0, 2] | 0 | [0, 1, 2, 3] | 0 | -| Jamesbond | [0, 1] | 0 | [0] | 0 | -| JourneyEscape | [0] | 0 | [0, 1] | 0 | -| Kaboom | [0] | 0 | [0] | 0 | -| Kangaroo | [0, 1] | 0 | [0] | 0 | -| KeystoneKapers | [0] | 0 | [0] | 0 | -| KingKong | [0, 1, 2, 3] | 0 | [0] | 0 | -| Klax | [0, 1, 2] | 0 | [0] | 0 | -| Koolaid | [0] | 0 | [0] | 0 | -| Krull | [0] | 0 | [0] | 0 | -| KungFuMaster | [0] | 0 | [0] | 0 | -| LaserGates | [0] | 0 | [0] | 0 | -| LostLuggage | [0, 1] | 0 | [0, 1] | 0 | -| MarioBros | [0, 2, 4, 6] | 0 | [0] | 0 | -| MiniatureGolf | [0] | 0 | [0, 1] | 0 | -| MontezumaRevenge | [0] | 0 | [0] | 0 | -| MrDo | [0, 1, 2, 3] | 0 | [0] | 0 | -| MsPacman | [0, 1, 2, 3] | 0 | [0] | 0 | -| NameThisGame | [8, 24, 40] | 8 | [0, 1] | 0 | -| Othello | [0, 1, 2] | 0 | [0, 2] | 0 | -| Pacman | [0, ..., 7] | 0 | [0, 1] | 0 | -| Phoenix | [0] | 0 | [0] | 0 | -| Pitfall | [0] | 0 | [0] | 0 | -| Pitfall2 | [0] | 0 | [0] | 0 | -| Pong | [0, 1] | 0 | [0, 1, 2, 3] | 0 | -| Pooyan | [10, 30, 50, 70] | 10 | [0] | 0 | -| PrivateEye | [0, 1, 2, 3, 4] | 0 | [0, 1, 2, 3] | 0 | -| Qbert | [0] | 0 | [0, 1] | 0 | -| Riverraid | [0] | 0 | [0, 1] | 0 | -| RoadRunner | [0] | 0 | [0] | 0 | -| Robotank | [0] | 0 | [0] | 0 | -| Seaquest | [0] | 0 | [0, 1] | 0 | -| SirLancelot | [0] | 0 | [0] | 0 | -| Skiing | [0] | 0 | [0] | 0 | -| Solaris | [0] | 0 | [0] | 0 | -| SpaceInvaders | [0, ..., 15] | 0 | [0, 1] | 0 | -| SpaceWar | [6, ..., 17] | 6 | [0] | 0 | -| StarGunner | [0, 1, 2, 3] | 0 | [0] | 0 | -| Superman | [0] | 0 | [0, 1, 2, 3] | 0 | -| Surround | [0, 2] | 0 | [0, 1, 2, 3] | 0 | -| Tennis | [0, 2] | 0 | [0, 1, 2, 3] | 0 | -| Tetris | [0] | 0 | [0] | 0 | -| TicTacToe3D | [0, ..., 8] | 0 | [0, 2] | 0 | -| TimePilot | [0] | 0 | [0, 1, 2] | 0 | -| Trondead | [0] | 0 | [0, 1] | 0 | -| Turmoil | [0, ..., 8] | 0 | [0] | 0 | -| Tutankham | [0, 4, 8, 12] | 0 | [0] | 0 | -| UpNDown | [0] | 0 | [0, 1, 2, 3] | 0 | -| Venture | [0] | 0 | [0, 1, 2, 3] | 0 | -| VideoCheckers | [1, ..., 9, 11, ..., 19] | 1 | [0] | 0 | -| VideoChess | [0, 1, 2, 3, 4] | 0 | [0] | 0 | -| VideoCube | [0, 1, 2, 100, 101, 102, ..., 5000, 5001, 5002] | 0 | [0, 1] | 0 | -| VideoPinball | [0, 2] | 0 | [0, 1] | 0 | -| WizardOfWor | [0] | 0 | [0, 1] | 0 | -| WordZapper | [0, ..., 23] | 0 | [0, 1, 2, 3] | 0 | -| YarsRevenge | [0, 32, 64, 96] | 0 | [0, 1] | 0 | -| Zaxxon | [0, 8, 16, 24] | 0 | [0] | 0 | - -## References - -(#1)= -[1] -MG Bellemare, Y Naddaf, J Veness, and M Bowling. -"The arcade learning environment: An evaluation platform for general agents." -Journal of Artificial Intelligence Research (2012). - -(#2)= -[2] -Machado et al. -"Revisiting the Arcade Learning Environment: Evaluation Protocols -and Open Problems for General Agents" -Journal of Artificial Intelligence Research (2018) -URL: https://jair.org/index.php/jair/article/view/11182 + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/adventure.md b/docs/environments/atari/adventure.md index bd08542eb..8229a40f2 100644 --- a/docs/environments/atari/adventure.md +++ b/docs/environments/atari/adventure.md @@ -1,92 +1,9 @@ ---- -title: Adventure ---- - -# Adventure - -```{figure} ../../_static/videos/atari/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")` | - -For more Adventure variants with different observation and action spaces, see the variants section. - -## Description - -You must find the enchanted chalice and return it to the golden castle. You can pick up various objects (keys, a sword,a bridge, or a magnet) and have to fight or outmanoeuvre dragons. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1) - -## Actions - -Adventure has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Adventure uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/air_raid.md b/docs/environments/atari/air_raid.md index 63aa79f86..3c8fcf3e5 100644 --- a/docs/environments/atari/air_raid.md +++ b/docs/environments/atari/air_raid.md @@ -1,87 +1,9 @@ ---- -title: AirRaid ---- - -# AirRaid - -```{figure} ../../_static/videos/atari/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")` | - -For more AirRaid variants with different observation and action spaces, see the variants section. - -## Description - -You control a ship that can move sideways. You must protect two buildings (one on the right and one on the left side of the screen) from flying saucers that are trying to drop bombs on them. - -## Actions - -AirRaid has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[1, ..., 8]` | `1` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/alien.md b/docs/environments/atari/alien.md index 00c615cb2..e19e8e95d 100644 --- a/docs/environments/atari/alien.md +++ b/docs/environments/atari/alien.md @@ -1,93 +1,9 @@ ---- -title: Alien ---- - -# Alien - -```{figure} ../../_static/videos/atari/alien.gif -:width: 120px -:name: Alien -``` - -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/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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815) - -## Actions - -Alien has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Alien uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/amidar.md b/docs/environments/atari/amidar.md index 622d36f8a..3ed67955d 100644 --- a/docs/environments/atari/amidar.md +++ b/docs/environments/atari/amidar.md @@ -1,92 +1,9 @@ ---- -title: Amidar ---- - -# Amidar - -```{figure} ../../_static/videos/atari/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) | -| 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817) - -## Actions - -Amidar has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPFIRE` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | -| `9` | `DOWNFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/assault.md b/docs/environments/atari/assault.md index 87aac40bd..c060d86eb 100644 --- a/docs/environments/atari/assault.md +++ b/docs/environments/atari/assault.md @@ -1,90 +1,9 @@ ---- -title: Assault ---- - -# Assault - -```{figure} ../../_static/videos/atari/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")` | - -For more Assault variants with different observation and action spaces, see the variants section. - -## Description - -You control a vehicle that can move sideways. A big mother ship circles overhead and continually deploys smaller drones. You must destroy these enemies and dodge their attacks. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=827) - -## Actions - -Assault has the action space of `Discrete(7)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `RIGHTFIRE` | -| `6` | `LEFTFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/asterix.md b/docs/environments/atari/asterix.md index c236e5d3a..b97310fca 100644 --- a/docs/environments/atari/asterix.md +++ b/docs/environments/atari/asterix.md @@ -1,91 +1,9 @@ ---- -title: Asterix ---- - -# Asterix - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325) - -## Actions - -Asterix has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## Rewards -A table of scores awarded for collecting the different objects is provided on the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/asteroids.md b/docs/environments/atari/asteroids.md index 479885117..797cd69d8 100644 --- a/docs/environments/atari/asteroids.md +++ b/docs/environments/atari/asteroids.md @@ -1,93 +1,9 @@ ---- -title: Asteroids ---- - -# Asteroids - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=828) - -## Actions - -Asteroids has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|---------------|---------|--------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `UPFIRE` | -| `9` | `RIGHTFIRE` | `10` | `LEFTFIRE` | `11` | `DOWNFIRE` | -| `12` | `UPRIGHTFIRE` | `13` | `UPLEFTFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|---------------------|----------------|--------------------------|----------------------| -| `[0, ..., 31, 128]` | `0` | `[0, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/atlantis.md b/docs/environments/atari/atlantis.md index 9412c5449..f40917547 100644 --- a/docs/environments/atari/atlantis.md +++ b/docs/environments/atari/atlantis.md @@ -1,92 +1,9 @@ ---- -title: Atlantis ---- - -# Atlantis - -```{figure} ../../_static/videos/atari/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")` | - -For more Atlantis variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835) - -## Actions - -Atlantis has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHTFIRE` | -| `3` | `LEFTFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/atlantis2.md b/docs/environments/atari/atlantis2.md index 2e4b221e4..e2ec6d89f 100644 --- a/docs/environments/atari/atlantis2.md +++ b/docs/environments/atari/atlantis2.md @@ -1,75 +1,9 @@ ---- -title: Atlantis2 ---- - -# Atlantis2 - -```{figure} ../../_static/videos/atari/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")` | - -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. - -## Actions - -Atlantis2 has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHTFIRE` | -| `3` | `LEFTFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/backgammon.md b/docs/environments/atari/backgammon.md index e0a3e68c1..3196312c5 100644 --- a/docs/environments/atari/backgammon.md +++ b/docs/environments/atari/backgammon.md @@ -1,76 +1,9 @@ ---- -title: Backgammon ---- - -# Backgammon - -```{figure} ../../_static/videos/atari/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")` | - -For more Backgammon variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to move all your pieces off the board (called 'bearing off'). Players take turns rolling dice and moving their pieces. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=12) - -## Actions - -Backgammon has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `FIRE` | `1` | `RIGHT` | `2` | `LEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/bank_heist.md b/docs/environments/atari/bank_heist.md index a1857d6da..c916f47c9 100644 --- a/docs/environments/atari/bank_heist.md +++ b/docs/environments/atari/bank_heist.md @@ -1,93 +1,9 @@ ---- -title: BankHeist ---- - -# BankHeist - -```{figure} ../../_static/videos/atari/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")` | - -For more BankHeist variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008) - -## Actions - -BankHeist has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As BankHeist uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|---------------------------------|----------------|--------------------------|----------------------| -| `[0, 4, 8, 12, 16, 20, 24, 28]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/basic_math.md b/docs/environments/atari/basic_math.md index cd0c296a3..e1bee0c74 100644 --- a/docs/environments/atari/basic_math.md +++ b/docs/environments/atari/basic_math.md @@ -1,77 +1,9 @@ ---- -title: BasicMath ---- - -# BasicMath - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=14) - -## Actions - -BasicMath has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[5, 6, 7, 8]` | `5` | `[0, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/battle_zone.md b/docs/environments/atari/battle_zone.md index aefa08a32..7aea2ab95 100644 --- a/docs/environments/atari/battle_zone.md +++ b/docs/environments/atari/battle_zone.md @@ -1,93 +1,9 @@ ---- -title: BattleZone ---- - -# BattleZone - -```{figure} ../../_static/videos/atari/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")` | - -For more BattleZone variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=859) - -## Actions - -BattleZone has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As BattleZone uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[1, 2, 3]` | `1` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/beam_rider.md b/docs/environments/atari/beam_rider.md index 28e2c79e2..20d70d609 100644 --- a/docs/environments/atari/beam_rider.md +++ b/docs/environments/atari/beam_rider.md @@ -1,91 +1,9 @@ ---- -title: BeamRider ---- - -# BeamRider - -```{figure} ../../_static/videos/atari/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")` | - -For more BeamRider variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=860) - -## Actions - -BeamRider has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/berzerk.md b/docs/environments/atari/berzerk.md index bac7708f3..f443a1633 100644 --- a/docs/environments/atari/berzerk.md +++ b/docs/environments/atari/berzerk.md @@ -1,93 +1,9 @@ ---- -title: Berzerk ---- - -# Berzerk - -```{figure} ../../_static/videos/atari/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")` | - -For more Berzerk variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=866) - -## Actions - -Berzerk has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Berzerk uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|---------------------------|----------------|--------------------------|----------------------| -| `[1, ..., 9, 16, 17, 18]` | `1` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/blackjack.md b/docs/environments/atari/blackjack.md index 6cc00bb2f..10f0b1809 100644 --- a/docs/environments/atari/blackjack.md +++ b/docs/environments/atari/blackjack.md @@ -1,77 +1,9 @@ ---- -title: Blackjack ---- - -# Blackjack - -```{figure} ../../_static/videos/atari/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")` | - -For more Blackjack variants with different observation and action spaces, see the variants section. - -## Description - -Compete against a dealer to draw cards and score as close to 21 as possible without going over ('bust'). - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=34) - -## Actions - -Blackjack has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `DOWN` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/bowling.md b/docs/environments/atari/bowling.md index e2ad07ff2..857a3c90e 100644 --- a/docs/environments/atari/bowling.md +++ b/docs/environments/atari/bowling.md @@ -1,90 +1,9 @@ ---- -title: Bowling ---- - -# Bowling - -```{figure} ../../_static/videos/atari/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")` | - -For more Bowling variants with different observation and action spaces, see the variants section. - -## 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". - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879) - -## Actions - -Bowling has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `DOWN` | `4` | `UPFIRE` | `5` | `DOWNFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2, 4]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/boxing.md b/docs/environments/atari/boxing.md index d983f4981..2c6a40c2e 100644 --- a/docs/environments/atari/boxing.md +++ b/docs/environments/atari/boxing.md @@ -1,93 +1,9 @@ ---- -title: Boxing ---- - -# Boxing - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882) - -## Actions - -Boxing has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Boxing uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/breakout.md b/docs/environments/atari/breakout.md index d85d92599..069383f7e 100644 --- a/docs/environments/atari/breakout.md +++ b/docs/environments/atari/breakout.md @@ -1,90 +1,9 @@ ---- -title: Breakout ---- - -# Breakout - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889) - -## Actions - -Breakout has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------------------------------------|----------------|--------------------------|----------------------| -| `[0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/carnival.md b/docs/environments/atari/carnival.md index bd54aabf3..71b98bc2a 100644 --- a/docs/environments/atari/carnival.md +++ b/docs/environments/atari/carnival.md @@ -1,90 +1,9 @@ ---- -title: Carnival ---- - -# Carnival - -```{figure} ../../_static/videos/atari/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")` | - -For more Carnival variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908) - -## Actions - -Carnival has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/casino.md b/docs/environments/atari/casino.md index 761e11ce0..899289c1f 100644 --- a/docs/environments/atari/casino.md +++ b/docs/environments/atari/casino.md @@ -1,77 +1,9 @@ ---- -title: Casino ---- - -# Casino - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -This is actually several games packaged together. Games 1 and 2 are Blackjack, where the second allows card splitting (which is when a player splits their cards into two groups and plays two hands simultaneously). Game 3 is stud poker, which involves drawing cards, betting, and attempting to get the highest scoring poker hand. Game 4 is poker solitaire, which involves filling a 5 by 5 matrix with cards and scoring the poker hands formed by the rows. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=70) - -## Actions - -Casino has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `DOWN` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2, 3]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/centipede.md b/docs/environments/atari/centipede.md index 5933c7cd0..40ce854a5 100644 --- a/docs/environments/atari/centipede.md +++ b/docs/environments/atari/centipede.md @@ -1,93 +1,9 @@ ---- -title: Centipede ---- - -# Centipede - -```{figure} ../../_static/videos/atari/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")` | - -For more Centipede variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911) - -## Actions - -Centipede has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Centipede uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[22, 86]` | `22` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/chopper_command.md b/docs/environments/atari/chopper_command.md index f1ac933f6..54eeac773 100644 --- a/docs/environments/atari/chopper_command.md +++ b/docs/environments/atari/chopper_command.md @@ -1,93 +1,9 @@ ---- -title: ChopperCommand ---- - -# ChopperCommand - -```{figure} ../../_static/videos/atari/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")` | - -For more ChopperCommand variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=921) - -## Actions - -ChopperCommand has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As ChopperCommand uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/crazy_climber.md b/docs/environments/atari/crazy_climber.md index fcb4654d4..7a14e55c8 100644 --- a/docs/environments/atari/crazy_climber.md +++ b/docs/environments/atari/crazy_climber.md @@ -1,91 +1,9 @@ ---- -title: CrazyClimber ---- - -# CrazyClimber - -```{figure} ../../_static/videos/atari/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")` | - -For more CrazyClimber variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=113) - -## Actions - -CrazyClimber has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## Rewards -A table of scores awarded for completing each row of a building is provided on the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=113). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/crossbow.md b/docs/environments/atari/crossbow.md index 4a9c510eb..217280263 100644 --- a/docs/environments/atari/crossbow.md +++ b/docs/environments/atari/crossbow.md @@ -1,80 +1,9 @@ ---- -title: Crossbow ---- - -# Crossbow - -```{figure} ../../_static/videos/atari/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")` | - -For more Crossbow variants with different observation and action spaces, see the variants section. - -## Description - -You must retrieve stolen treasures from the Evil Master's castle. Along the way you face enemies who you can shoot at with a crossbow. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=115) - -## Actions - -Crossbow has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Crossbow uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2, 4, 6]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/darkchambers.md b/docs/environments/atari/darkchambers.md index e079c3a56..611872404 100644 --- a/docs/environments/atari/darkchambers.md +++ b/docs/environments/atari/darkchambers.md @@ -1,80 +1,9 @@ ---- -title: Darkchambers ---- - -# Darkchambers - -```{figure} ../../_static/videos/atari/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")` | - -For more Darkchambers variants with different observation and action spaces, see the variants section. - -## Description - -You must survive 26 levels of enemies and curses and collect as much treasure as you can along the way. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=122) - -## Actions - -Darkchambers has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Darkchambers uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/defender.md b/docs/environments/atari/defender.md index c317f3c22..a5bd4b882 100644 --- a/docs/environments/atari/defender.md +++ b/docs/environments/atari/defender.md @@ -1,93 +1,9 @@ ---- -title: Defender ---- - -# Defender - -```{figure} ../../_static/videos/atari/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")` | - -For more Defender variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=128) - -## Actions - -Defender has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Defender uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[1, ..., 9, 16]` | `1` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/demon_attack.md b/docs/environments/atari/demon_attack.md index 097dff3c6..b93eb15bd 100644 --- a/docs/environments/atari/demon_attack.md +++ b/docs/environments/atari/demon_attack.md @@ -1,90 +1,9 @@ ---- -title: DemonAttack ---- - -# DemonAttack - -```{figure} ../../_static/videos/atari/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")` | - -For more DemonAttack variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=135) - -## Actions - -DemonAttack has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[1, 3, 5, 7]` | `1` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/donkey_kong.md b/docs/environments/atari/donkey_kong.md index 45d8330be..eb2831f6f 100644 --- a/docs/environments/atari/donkey_kong.md +++ b/docs/environments/atari/donkey_kong.md @@ -1,80 +1,9 @@ ---- -title: DonkeyKong ---- - -# DonkeyKong - -```{figure} ../../_static/videos/atari/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")` | - -For more DonkeyKong variants with different observation and action spaces, see the variants section. - -## Description - -You play as Mario trying to save your girlfriend who has been kidnapped by Donkey Kong. Remove rivets and jump over fireballs, with a score that starts high and counts down throughout the game. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=149) - -## Actions - -DonkeyKong has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As DonkeyKong uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/double_dunk.md b/docs/environments/atari/double_dunk.md index ede837b60..bd39c2127 100644 --- a/docs/environments/atari/double_dunk.md +++ b/docs/environments/atari/double_dunk.md @@ -1,93 +1,9 @@ ---- -title: DoubleDunk ---- - -# DoubleDunk - -```{figure} ../../_static/videos/atari/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")` | - -For more DoubleDunk variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=153) - -## Actions - -DoubleDunk has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As DoubleDunk uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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. - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 15]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/earthworld.md b/docs/environments/atari/earthworld.md index 00f113ee7..52cdbdaad 100644 --- a/docs/environments/atari/earthworld.md +++ b/docs/environments/atari/earthworld.md @@ -1,80 +1,9 @@ ---- -title: Earthworld ---- - -# Earthworld - -```{figure} ../../_static/videos/atari/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")` | - -For more Earthworld variants with different observation and action spaces, see the variants section. - -## Description - -A quest to find the sword of Ultimate Sorcery. You must navigate through 12 zodiac-themed rooms in order to solve a puzzle. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=541) - -## Actions - -Earthworld has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Earthworld uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/elevator_action.md b/docs/environments/atari/elevator_action.md index 4e0ead7ca..0ada5a7de 100644 --- a/docs/environments/atari/elevator_action.md +++ b/docs/environments/atari/elevator_action.md @@ -1,93 +1,9 @@ ---- -title: ElevatorAction ---- - -# ElevatorAction - -```{figure} ../../_static/videos/atari/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")` | - -For more ElevatorAction variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1131) - -## Actions - -ElevatorAction has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As ElevatorAction uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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. - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/enduro.md b/docs/environments/atari/enduro.md index 7a8029966..f7c60dda5 100644 --- a/docs/environments/atari/enduro.md +++ b/docs/environments/atari/enduro.md @@ -1,91 +1,9 @@ ---- -title: Enduro ---- - -# Enduro - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=163) - -## Actions - -Enduro has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `DOWNRIGHT` | -| `6` | `DOWNLEFT` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## Rewards -You get 1 point for each vehicle you overtake. - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/entombed.md b/docs/environments/atari/entombed.md index b9969dc6b..da33c3de7 100644 --- a/docs/environments/atari/entombed.md +++ b/docs/environments/atari/entombed.md @@ -1,80 +1,9 @@ ---- -title: Entombed ---- - -# Entombed - -```{figure} ../../_static/videos/atari/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")` | - -For more Entombed variants with different observation and action spaces, see the variants section. - -## Description - -You and your team of archeologists must navigate a maze filled with zombies. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=165) - -## Actions - -Entombed has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Entombed uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 2]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/et.md b/docs/environments/atari/et.md index b50191ddb..1381b28dd 100644 --- a/docs/environments/atari/et.md +++ b/docs/environments/atari/et.md @@ -1,80 +1,9 @@ ---- -title: Et ---- - -# Et - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -Help E.T. (the extra-terrestrial) get home! He has to collect pieces of a telephone, call his ship, and get to the landing pad. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=157) - -## Actions - -Et has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Et uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/fishing_derby.md b/docs/environments/atari/fishing_derby.md index d16d650e5..a7e0f0fc5 100644 --- a/docs/environments/atari/fishing_derby.md +++ b/docs/environments/atari/fishing_derby.md @@ -1,94 +1,9 @@ ---- -title: FishingDerby ---- - -# FishingDerby - -```{figure} ../../_static/videos/atari/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")` | - -For more FishingDerby variants with different observation and action spaces, see the variants section. - -## Description - -Your objective is to catch more sunfish than your opponent. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=182) - -## Actions - -FishingDerby has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As FishingDerby uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## 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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/flag_capture.md b/docs/environments/atari/flag_capture.md index 3e9a5ec56..2a95fd0ae 100644 --- a/docs/environments/atari/flag_capture.md +++ b/docs/environments/atari/flag_capture.md @@ -1,80 +1,9 @@ ---- -title: FlagCapture ---- - -# FlagCapture - -```{figure} ../../_static/videos/atari/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")` | - -For more FlagCapture variants with different observation and action spaces, see the variants section. - -## Description - -You are an explorer navigating from square to square, collecting clues, and looking for a flag. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=183) - -## Actions - -FlagCapture has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As FlagCapture uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[8, 9, 10]` | `8` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/freeway.md b/docs/environments/atari/freeway.md index 59b1377eb..99495d7e2 100644 --- a/docs/environments/atari/freeway.md +++ b/docs/environments/atari/freeway.md @@ -1,90 +1,9 @@ ---- -title: Freeway ---- - -# Freeway - -```{figure} ../../_static/videos/atari/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")` | - -For more Freeway variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=192) - -## Actions - -Freeway has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `UP` | `2` | `DOWN` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## 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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 7]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/frogger.md b/docs/environments/atari/frogger.md index 3892b83dd..0e8163942 100644 --- a/docs/environments/atari/frogger.md +++ b/docs/environments/atari/frogger.md @@ -1,77 +1,9 @@ ---- -title: Frogger ---- - -# Frogger - -```{figure} ../../_static/videos/atari/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")` | - -For more Frogger variants with different observation and action spaces, see the variants section. - -## Description - -You are a frog trying to make their way home. Cross a highway and a perilous river without being crushed or eaten. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=194) - -## Actions - -Frogger has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/frostbite.md b/docs/environments/atari/frostbite.md index 019f93b9b..cd8bb4c99 100644 --- a/docs/environments/atari/frostbite.md +++ b/docs/environments/atari/frostbite.md @@ -1,93 +1,9 @@ ---- -title: Frostbite ---- - -# Frostbite - -```{figure} ../../_static/videos/atari/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")` | - -For more Frostbite variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=199) - -## Actions - -Frostbite has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Frostbite uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## 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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/galaxian.md b/docs/environments/atari/galaxian.md index ac5a35ccf..57fdf6a5d 100644 --- a/docs/environments/atari/galaxian.md +++ b/docs/environments/atari/galaxian.md @@ -1,77 +1,9 @@ ---- -title: Galaxian ---- - -# Galaxian - -```{figure} ../../_static/videos/atari/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")` | - -For more Galaxian variants with different observation and action spaces, see the variants section. - -## Description - -Protect your laser base from a Galaxian invasion. Defeat each wave by firing lasers at the attackers. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=202) - -## Actions - -Galaxian has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[1, ..., 9]` | `1` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/gopher.md b/docs/environments/atari/gopher.md index 434414184..e90fd2486 100644 --- a/docs/environments/atari/gopher.md +++ b/docs/environments/atari/gopher.md @@ -1,91 +1,9 @@ ---- -title: Gopher ---- - -# Gopher - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -The player controls a shovel-wielding farmer who protects a crop of three carrots from a gopher. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=218) - -## Actions - -Gopher has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-------------|---------|------------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `UPFIRE` | -| `6` | `RIGHTFIRE` | `7` | `LEFTFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## 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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/gravitar.md b/docs/environments/atari/gravitar.md index ceed85373..9a7a174c4 100644 --- a/docs/environments/atari/gravitar.md +++ b/docs/environments/atari/gravitar.md @@ -1,93 +1,9 @@ ---- -title: Gravitar ---- - -# Gravitar - -```{figure} ../../_static/videos/atari/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")` | - -For more Gravitar variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=223) - -## Actions - -Gravitar has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Gravitar uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## 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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3, 4]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/hangman.md b/docs/environments/atari/hangman.md index f55b7b84f..98016c223 100644 --- a/docs/environments/atari/hangman.md +++ b/docs/environments/atari/hangman.md @@ -1,80 +1,9 @@ ---- -title: Hangman ---- - -# Hangman - -```{figure} ../../_static/videos/atari/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")` | - -For more Hangman variants with different observation and action spaces, see the variants section. - -## Description - -Guess the hidden word one letter at a time, and don't make too many incorrect guesses or you will lose. Word difficulty increases as you traverse through the games. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=231) - -## Actions - -Hangman has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Hangman uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/haunted_house.md b/docs/environments/atari/haunted_house.md index bfc78a232..25684797f 100644 --- a/docs/environments/atari/haunted_house.md +++ b/docs/environments/atari/haunted_house.md @@ -1,80 +1,9 @@ ---- -title: HauntedHouse ---- - -# HauntedHouse - -```{figure} ../../_static/videos/atari/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")` | - -For more HauntedHouse variants with different observation and action spaces, see the variants section. - -## Description - -Explore a mansion haunted by the ghost of mean, old Samuel Graves. Your goal is to find three pieces of a magic urn and leave the mansion before losing your 9 lives. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=233) - -## Actions - -HauntedHouse has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As HauntedHouse uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 8]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/hero.md b/docs/environments/atari/hero.md index f7f959a4f..5df8069ee 100644 --- a/docs/environments/atari/hero.md +++ b/docs/environments/atari/hero.md @@ -1,93 +1,9 @@ ---- -title: Hero ---- - -# Hero - -```{figure} ../../_static/videos/atari/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) | -| 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228) - -## Actions - -Hero has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Hero uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3, 4]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/human_cannonball.md b/docs/environments/atari/human_cannonball.md index e416b2792..eb34d7054 100644 --- a/docs/environments/atari/human_cannonball.md +++ b/docs/environments/atari/human_cannonball.md @@ -1,80 +1,9 @@ ---- -title: HumanCannonball ---- - -# HumanCannonball - -```{figure} ../../_static/videos/atari/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")` | - -For more HumanCannonball variants with different observation and action spaces, see the variants section. - -## Description - -Shoot a person out of a cannonball and try to get them into the water tower. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=238) - -## Actions - -HumanCannonball has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As HumanCannonball uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 7]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/ice_hockey.md b/docs/environments/atari/ice_hockey.md index 3a15ce3ff..fbbdeadcc 100644 --- a/docs/environments/atari/ice_hockey.md +++ b/docs/environments/atari/ice_hockey.md @@ -1,93 +1,9 @@ ---- -title: IceHockey ---- - -# IceHockey - -```{figure} ../../_static/videos/atari/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")` | - -For more IceHockey variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=241) - -## Actions - -IceHockey has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As IceHockey uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/jamesbond.md b/docs/environments/atari/jamesbond.md index f52875feb..4b0543b41 100644 --- a/docs/environments/atari/jamesbond.md +++ b/docs/environments/atari/jamesbond.md @@ -1,93 +1,9 @@ ---- -title: Jamesbond ---- - -# Jamesbond - -```{figure} ../../_static/videos/atari/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")` | - -For more Jamesbond variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=250) - -## Actions - -Jamesbond has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Jamesbond uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/journey_escape.md b/docs/environments/atari/journey_escape.md index f1a06e8ce..281f33f3f 100644 --- a/docs/environments/atari/journey_escape.md +++ b/docs/environments/atari/journey_escape.md @@ -1,94 +1,9 @@ ---- -title: JourneyEscape ---- - -# JourneyEscape - -```{figure} ../../_static/videos/atari/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")` | - -For more JourneyEscape variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=252) - -## Actions - -JourneyEscape has the action space of `Discrete(16)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|----------------|---------|--------------|---------|-----------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | -| `9` | `RIGHTFIRE` | `10` | `LEFTFIRE` | `11` | `DOWNFIRE` | -| `12` | `UPRIGHTFIRE` | `13` | `UPLEFTFIRE` | `14` | `DOWNRIGHTFIRE` | -| `15` | `DOWNLEFTFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/kaboom.md b/docs/environments/atari/kaboom.md index a217ccd51..76e77473a 100644 --- a/docs/environments/atari/kaboom.md +++ b/docs/environments/atari/kaboom.md @@ -1,77 +1,9 @@ ---- -title: Kaboom ---- - -# Kaboom - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -A mad bomber is dropping bombs! Try to catch each of them in a bucket of water before they hit the ground. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=257) - -## Actions - -Kaboom has the action space of `Discrete(4)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/kangaroo.md b/docs/environments/atari/kangaroo.md index 1833ac41c..698f46b9e 100644 --- a/docs/environments/atari/kangaroo.md +++ b/docs/environments/atari/kangaroo.md @@ -1,93 +1,9 @@ ---- -title: Kangaroo ---- - -# Kangaroo - -```{figure} ../../_static/videos/atari/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")` | - -For more Kangaroo variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=923) - -## Actions - -Kangaroo has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Kangaroo uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/keystone_kapers.md b/docs/environments/atari/keystone_kapers.md index ff5dfe970..371f3986e 100644 --- a/docs/environments/atari/keystone_kapers.md +++ b/docs/environments/atari/keystone_kapers.md @@ -1,80 +1,9 @@ ---- -title: KeystoneKapers ---- - -# KeystoneKapers - -```{figure} ../../_static/videos/atari/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")` | - -For more KeystoneKapers variants with different observation and action spaces, see the variants section. - -## Description - -You are a police officer (or 'Kop') trying to catch a 'Krook' as quickly as you can. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=261) - -## Actions - -KeystoneKapers has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|------------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/king_kong.md b/docs/environments/atari/king_kong.md index fe635dbd7..34944e56d 100644 --- a/docs/environments/atari/king_kong.md +++ b/docs/environments/atari/king_kong.md @@ -1,77 +1,9 @@ ---- -title: KingKong ---- - -# KingKong - -```{figure} ../../_static/videos/atari/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")` | - -For more KingKong variants with different observation and action spaces, see the variants section. - -## Description - -Climb the Empire State Building to save the person that King Kong kidnapped and placed there. Beware the bombs that King Kong throws at you as you climb! - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=265) - -## Actions - -KingKong has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/klax.md b/docs/environments/atari/klax.md index 2e4a69e24..2e86768fb 100644 --- a/docs/environments/atari/klax.md +++ b/docs/environments/atari/klax.md @@ -1,80 +1,9 @@ ---- -title: Klax ---- - -# Klax - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -Flip tumbling tiles into bins to create rows of three or more matching-colored tiles (such a row is called a Klax). - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1130) - -## Actions - -Klax has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Klax uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/koolaid.md b/docs/environments/atari/koolaid.md index bea6be468..892ac3db8 100644 --- a/docs/environments/atari/koolaid.md +++ b/docs/environments/atari/koolaid.md @@ -1,78 +1,9 @@ ---- -title: Koolaid ---- - -# Koolaid - -```{figure} ../../_static/videos/atari/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")` | - -For more Koolaid variants with different observation and action spaces, see the variants section. - -## Description - -You are the Kool-Aid Man and you are trying to stop Thirsties from drinking your pool water by running into them. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=266) - -## Actions - -Koolaid has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/krull.md b/docs/environments/atari/krull.md index 0537e17ea..f234a048a 100644 --- a/docs/environments/atari/krull.md +++ b/docs/environments/atari/krull.md @@ -1,93 +1,9 @@ ---- -title: Krull ---- - -# Krull - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=267) - -## Actions - -Krull has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Krull uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/kung_fu_master.md b/docs/environments/atari/kung_fu_master.md index 90f89374e..6705d2895 100644 --- a/docs/environments/atari/kung_fu_master.md +++ b/docs/environments/atari/kung_fu_master.md @@ -1,92 +1,9 @@ ---- -title: KungFuMaster ---- - -# KungFuMaster - -```{figure} ../../_static/videos/atari/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")` | - -For more KungFuMaster variants with different observation and action spaces, see the variants section. - -## Description - -You are a Kung-Fu Master fighting your way through the Evil Wizard's temple. Your goal is to rescue Princess Victoria, defeating various enemies along the way. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=268) - -## Actions - -KungFuMaster has the action space of `Discrete(14)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------------|---------|----------------|---------|--------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `DOWNRIGHT` | -| `6` | `DOWNLEFT` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | -| `9` | `DOWNFIRE` | `10` | `UPRIGHTFIRE` | `11` | `UPLEFTFIRE` | -| `12` | `DOWNRIGHTFIRE` | `13` | `DOWNLEFTFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/laser_gates.md b/docs/environments/atari/laser_gates.md index 830984091..0a2d63dbc 100644 --- a/docs/environments/atari/laser_gates.md +++ b/docs/environments/atari/laser_gates.md @@ -1,80 +1,9 @@ ---- -title: LaserGates ---- - -# LaserGates - -```{figure} ../../_static/videos/atari/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")` | - -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 destroy the four Failsafe Detonators. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=271) - -## Actions - -LaserGates has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As LaserGates uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/lost_luggage.md b/docs/environments/atari/lost_luggage.md index d021ce53d..b4a149149 100644 --- a/docs/environments/atari/lost_luggage.md +++ b/docs/environments/atari/lost_luggage.md @@ -1,78 +1,9 @@ ---- -title: LostLuggage ---- - -# LostLuggage - -```{figure} ../../_static/videos/atari/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")` | - -For more LostLuggage variants with different observation and action spaces, see the variants section. - -## Description - -Catch falling luggage before it spills open on the ground. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=276) - -## Actions - -LostLuggage has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/mario_bros.md b/docs/environments/atari/mario_bros.md index f1c22efb9..05e309e31 100644 --- a/docs/environments/atari/mario_bros.md +++ b/docs/environments/atari/mario_bros.md @@ -1,80 +1,9 @@ ---- -title: MarioBros ---- - -# MarioBros - -```{figure} ../../_static/videos/atari/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")` | - -For more MarioBros variants with different observation and action spaces, see the variants section. - -## Description - -Help Mario and Luigi knock pipe pests into a puddle of water. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=286) - -## Actions - -MarioBros has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As MarioBros uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2, 4, 6]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/miniature_golf.md b/docs/environments/atari/miniature_golf.md index ce5b02948..59350032a 100644 --- a/docs/environments/atari/miniature_golf.md +++ b/docs/environments/atari/miniature_golf.md @@ -1,80 +1,9 @@ ---- -title: MiniatureGolf ---- - -# MiniatureGolf - -```{figure} ../../_static/videos/atari/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")` | - -For more MiniatureGolf variants with different observation and action spaces, see the variants section. - -## Description - -Hit a golf ball as few times as possible in order to get it into the hole, avoiding obstacles. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=305) - -## Actions - -MiniatureGolf has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As MiniatureGolf uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/montezuma_revenge.md b/docs/environments/atari/montezuma_revenge.md index efe664efd..cd640c8ce 100644 --- a/docs/environments/atari/montezuma_revenge.md +++ b/docs/environments/atari/montezuma_revenge.md @@ -1,92 +1,9 @@ ---- -title: MontezumaRevenge ---- - -# MontezumaRevenge - -```{figure} ../../_static/videos/atari/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")` | - -For more MontezumaRevenge variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to acquire Montezuma's treasure by making your way through a maze of chambers within the emperor's fortress. You must avoid deadly creatures while collecting valuables and tools which can help you escape with the treasure. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=310) - -## Actions - -MontezumaRevenge has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As MontezumaRevenge uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/mr_do.md b/docs/environments/atari/mr_do.md index 1e5c1da63..167f99995 100644 --- a/docs/environments/atari/mr_do.md +++ b/docs/environments/atari/mr_do.md @@ -1,79 +1,9 @@ ---- -title: MrDo ---- - -# MrDo - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -Help Mr. Do harvest apples before the bad guys get to him. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=318) - -## Actions - -MrDo has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPFIRE` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | -| `9` | `DOWNFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/ms_pacman.md b/docs/environments/atari/ms_pacman.md index 7ad66951e..b10a447be 100644 --- a/docs/environments/atari/ms_pacman.md +++ b/docs/environments/atari/ms_pacman.md @@ -1,90 +1,9 @@ ---- -title: MsPacman ---- - -# MsPacman - -```{figure} ../../_static/videos/atari/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")` | - -For more MsPacman variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to collect all of the pellets on the screen while avoiding the ghosts. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_page.php?SoftwareLabelID=924) - -## Actions - -MsPacman has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPRIGHT` | -| `6` | `UPLEFT` | `7` | `DOWNRIGHT` | `8` | `DOWNLEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/name_this_game.md b/docs/environments/atari/name_this_game.md index 7b5fe9e2f..eb84c177d 100644 --- a/docs/environments/atari/name_this_game.md +++ b/docs/environments/atari/name_this_game.md @@ -1,89 +1,9 @@ ---- -title: NameThisGame ---- - -# NameThisGame - -```{figure} ../../_static/videos/atari/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")` | - -For more NameThisGame variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to defend the treasure that you have discovered. You must fight off a shark and an octopus while keeping an eye on your oxygen supply. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=323) - -## Actions - -NameThisGame has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[8, 24, 40]` | `8` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/othello.md b/docs/environments/atari/othello.md index 911df98f4..6d4aa4c6a 100644 --- a/docs/environments/atari/othello.md +++ b/docs/environments/atari/othello.md @@ -1,79 +1,9 @@ ---- -title: Othello ---- - -# Othello - -```{figure} ../../_static/videos/atari/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")` | - -For more Othello variants with different observation and action spaces, see the variants section. - -## Description - -Take turns placing tiles of your color (white or black) on a grid. You can surround an opponents tiles to change their color to yours. The goals is to end the game with the most tiles of your color on the board. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=335) - -## Actions - -Othello has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2]` | `0` | `[0, 2]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/pacman.md b/docs/environments/atari/pacman.md index e5f5e821f..58861da33 100644 --- a/docs/environments/atari/pacman.md +++ b/docs/environments/atari/pacman.md @@ -1,89 +1,9 @@ ---- -title: Pacman ---- - -# Pacman - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -A classic arcade game. Move Pac Man around a maze collecting food and avoiding ghosts- unless you eat a Power Pellet, then you can eat the ghosts too! - -## Actions - -Pacman has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 7]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/phoenix.md b/docs/environments/atari/phoenix.md index 365d41e08..1559f5f65 100644 --- a/docs/environments/atari/phoenix.md +++ b/docs/environments/atari/phoenix.md @@ -1,90 +1,9 @@ ---- -title: Phoenix ---- - -# Phoenix - -```{figure} ../../_static/videos/atari/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")` | - -For more Phoenix variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to reach and shoot the alien pilot. On your way there, you must eliminate waves of war birds while avoiding their bombs. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=355) - -## Actions - -Phoenix has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|------------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `RIGHTFIRE` | -| `6` | `LEFTFIRE` | `7` | `DOWNFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/pitfall.md b/docs/environments/atari/pitfall.md index 3c4cda5de..475380f1f 100644 --- a/docs/environments/atari/pitfall.md +++ b/docs/environments/atari/pitfall.md @@ -1,95 +1,9 @@ ---- -title: Pitfall ---- - -# Pitfall - -```{figure} ../../_static/videos/atari/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")` | - -For more Pitfall variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=360) - -## Actions - -Pitfall has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Pitfall uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/pitfall2.md b/docs/environments/atari/pitfall2.md index b0f819e0c..ab46f88cb 100644 --- a/docs/environments/atari/pitfall2.md +++ b/docs/environments/atari/pitfall2.md @@ -1,80 +1,9 @@ ---- -title: Pitfall2 ---- - -# Pitfall2 - -```{figure} ../../_static/videos/atari/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")` | - -For more Pitfall2 variants with different observation and action spaces, see the variants section. - -## Description - -Navigate Peruvian caves searching for niece Rhonda and cat Quicklaw as well as the lost Raj diamond. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=359) - -## Actions - -Pitfall2 has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Pitfall2 uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/pong.md b/docs/environments/atari/pong.md index 9bd59aac4..0e1990632 100644 --- a/docs/environments/atari/pong.md +++ b/docs/environments/atari/pong.md @@ -1,90 +1,9 @@ ---- -title: Pong ---- - -# Pong - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=587) - -## Actions - -Pong has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/pooyan.md b/docs/environments/atari/pooyan.md index b7ff54a00..a5433bb7b 100644 --- a/docs/environments/atari/pooyan.md +++ b/docs/environments/atari/pooyan.md @@ -1,90 +1,9 @@ ---- -title: Pooyan ---- - -# Pooyan - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=372) - -## Actions - -Pooyan has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `DOWN` | `4` | `UPFIRE` | `5` | `DOWNFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|--------------------|----------------|--------------------------|----------------------| -| `[10, 30, 50, 70]` | `10` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/private_eye.md b/docs/environments/atari/private_eye.md index a61227ade..72886e1bc 100644 --- a/docs/environments/atari/private_eye.md +++ b/docs/environments/atari/private_eye.md @@ -1,93 +1,9 @@ ---- -title: PrivateEye ---- - -# PrivateEye - -```{figure} ../../_static/videos/atari/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")` | - -For more PrivateEye variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=376) - -## Actions - -PrivateEye has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As PrivateEye uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3, 4]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/qbert.md b/docs/environments/atari/qbert.md index c94983db9..3417753d2 100644 --- a/docs/environments/atari/qbert.md +++ b/docs/environments/atari/qbert.md @@ -1,90 +1,9 @@ ---- -title: Qbert ---- - -# Qbert - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=1224) - -## Actions - -Qbert has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/riverraid.md b/docs/environments/atari/riverraid.md index 1632180de..9105672fc 100644 --- a/docs/environments/atari/riverraid.md +++ b/docs/environments/atari/riverraid.md @@ -1,101 +1,9 @@ ---- -title: Riverraid ---- - -# Riverraid - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=409) - -## Actions - -Riverraid has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Riverraid uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## Rewards -Score points are your only reward. You get score points each time you destroy an enemy object: -| Enemy Object | Score Points | -|--------------|--------------| -| Tanker | 30 | -| Helicopter | 60 | -| Fuel Depot | 80 | -| Jet | 100 | -| Bridge | 500 | -For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=409). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/road_runner.md b/docs/environments/atari/road_runner.md index 503e07bf6..0006eec0e 100644 --- a/docs/environments/atari/road_runner.md +++ b/docs/environments/atari/road_runner.md @@ -1,100 +1,9 @@ ---- -title: RoadRunner ---- - -# RoadRunner - -```{figure} ../../_static/videos/atari/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")` | - -For more RoadRunner variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=412) - -## Actions - -RoadRunner has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As RoadRunner uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## Rewards -Score points are your only reward. You get score points each time you: -| actions | points | -|-------------------------------------------------------|--------| -| eat a pile of birdseed | 100 | -| eat steel shot | 100 | -| get the coyote hit by a mine (cannonball, rock, etc.) | 200 | -| get the coyote hit by a truck | 1000 | -For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=412). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/robotank.md b/docs/environments/atari/robotank.md index 397597d8e..df59ef020 100644 --- a/docs/environments/atari/robotank.md +++ b/docs/environments/atari/robotank.md @@ -1,93 +1,9 @@ ---- -title: Robotank ---- - -# Robotank - -```{figure} ../../_static/videos/atari/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")` | - -For more Robotank variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=416) - -## Actions - -Robotank has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Robotank uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/seaquest.md b/docs/environments/atari/seaquest.md index 666a98e80..879f883da 100644 --- a/docs/environments/atari/seaquest.md +++ b/docs/environments/atari/seaquest.md @@ -1,93 +1,9 @@ ---- -title: Seaquest ---- - -# Seaquest - -```{figure} ../../_static/videos/atari/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")` | - -For more Seaquest variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=424) - -## Actions - -Seaquest has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Seaquest uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/sir_lancelot.md b/docs/environments/atari/sir_lancelot.md index ffc43fbe0..b77393d5a 100644 --- a/docs/environments/atari/sir_lancelot.md +++ b/docs/environments/atari/sir_lancelot.md @@ -1,77 +1,9 @@ ---- -title: SirLancelot ---- - -# SirLancelot - -```{figure} ../../_static/videos/atari/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")` | - -For more SirLancelot variants with different observation and action spaces, see the variants section. - -## Description - -You control Sir Lancelot, riding atop Pegasus, and your goal is to save a prisoner locked in a castle and protected by a fire-breathing dragon. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=431) - -## Actions - -SirLancelot has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/skiing.md b/docs/environments/atari/skiing.md index d84a84371..83d24269b 100644 --- a/docs/environments/atari/skiing.md +++ b/docs/environments/atari/skiing.md @@ -1,89 +1,9 @@ ---- -title: Skiing ---- - -# Skiing - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=434) - -## Actions - -Skiing has the action space of `Discrete(3)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `RIGHT` | `2` | `LEFT` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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](https://atariage.com/manual_html_page.php?SoftwareLabelID=434) in particular the Slalom racing section. - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/solaris.md b/docs/environments/atari/solaris.md index 885c4ab7f..1878cdbcd 100644 --- a/docs/environments/atari/solaris.md +++ b/docs/environments/atari/solaris.md @@ -1,93 +1,9 @@ ---- -title: Solaris ---- - -# Solaris - -```{figure} ../../_static/videos/atari/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")` | - -For more Solaris variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=450) - -## Actions - -Solaris has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Solaris uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/space_invaders.md b/docs/environments/atari/space_invaders.md index 1167ffd1c..eba3e5ec4 100644 --- a/docs/environments/atari/space_invaders.md +++ b/docs/environments/atari/space_invaders.md @@ -1,90 +1,9 @@ ---- -title: SpaceInvaders ---- - -# SpaceInvaders - -```{figure} ../../_static/videos/atari/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")` | - -For more SpaceInvaders variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=460) - -## Actions - -SpaceInvaders has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `RIGHTFIRE` | `5` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 15]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/space_war.md b/docs/environments/atari/space_war.md index 7277c75bd..36f15e23e 100644 --- a/docs/environments/atari/space_war.md +++ b/docs/environments/atari/space_war.md @@ -1,80 +1,9 @@ ---- -title: SpaceWar ---- - -# SpaceWar - -```{figure} ../../_static/videos/atari/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")` | - -For more SpaceWar variants with different observation and action spaces, see the variants section. - -## Description - -Use your Star Ship to compete in a sequence of games where you try to shoot your opponent as many times as possible without being hit yourself. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=470) - -## Actions - -SpaceWar has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As SpaceWar uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[6, ..., 17]` | `6` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/star_gunner.md b/docs/environments/atari/star_gunner.md index b92ffa35b..e419bbb62 100644 --- a/docs/environments/atari/star_gunner.md +++ b/docs/environments/atari/star_gunner.md @@ -1,93 +1,9 @@ ---- -title: StarGunner ---- - -# StarGunner - -```{figure} ../../_static/videos/atari/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")` | - -For more StarGunner variants with different observation and action spaces, see the variants section. - -## Description - -Stop the alien invasion by shooting down alien saucers and creatures while avoiding bombs. - -For a more detailed documentation, see [the AtariAge page](http://www.atarimania.com/game-atari-2600-vcs-stargunner_16921.html) - -## Actions - -StarGunner has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As StarGunner uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/superman.md b/docs/environments/atari/superman.md index 6221d5707..63a62849e 100644 --- a/docs/environments/atari/superman.md +++ b/docs/environments/atari/superman.md @@ -1,80 +1,9 @@ ---- -title: Superman ---- - -# Superman - -```{figure} ../../_static/videos/atari/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")` | - -For more Superman variants with different observation and action spaces, see the variants section. - -## Description - -Play as Superman trying to capture Lex Luther and avoid the kryptonite satellites along the way. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=533) - -## Actions - -Superman has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Superman uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/surround.md b/docs/environments/atari/surround.md index 030cbb3f7..cbc12344e 100644 --- a/docs/environments/atari/surround.md +++ b/docs/environments/atari/surround.md @@ -1,77 +1,9 @@ ---- -title: Surround ---- - -# Surround - -```{figure} ../../_static/videos/atari/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")` | - -For more Surround variants with different observation and action spaces, see the variants section. - -## Description - -Surround your opponent without running into anything yourself. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=537) - -## Actions - -Surround has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/tennis.md b/docs/environments/atari/tennis.md index 6fed8d433..396eff2fb 100644 --- a/docs/environments/atari/tennis.md +++ b/docs/environments/atari/tennis.md @@ -1,93 +1,9 @@ ---- -title: Tennis ---- - -# Tennis - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## 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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=555) - -## Actions - -Tennis has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Tennis uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/tetris.md b/docs/environments/atari/tetris.md index c6ccbfadf..75b2cee22 100644 --- a/docs/environments/atari/tetris.md +++ b/docs/environments/atari/tetris.md @@ -1,75 +1,9 @@ ---- -title: Tetris ---- - -# Tetris - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -Direct falling tile-based shapes to try and perfectly fill the board without leaving empty space. - -## Actions - -Tetris has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|-----------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/tic_tac_toe_3d.md b/docs/environments/atari/tic_tac_toe_3d.md index 273b1181d..8e7dea773 100644 --- a/docs/environments/atari/tic_tac_toe_3d.md +++ b/docs/environments/atari/tic_tac_toe_3d.md @@ -1,79 +1,9 @@ ---- -title: TicTacToe3D ---- - -# TicTacToe3D - -```{figure} ../../_static/videos/atari/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")` | - -For more TicTacToe3D variants with different observation and action spaces, see the variants section. - -## Description - -Players take turns placing their mark (an X or an O) on a 3-dimensional, 4x4x4 grid in an attempt to get 4 in a row before their opponent does. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=521) - -## Actions - -TicTacToe3D has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 8]` | `0` | `[0, 2]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/time_pilot.md b/docs/environments/atari/time_pilot.md index 2e9ea6f70..3eaf244ef 100644 --- a/docs/environments/atari/time_pilot.md +++ b/docs/environments/atari/time_pilot.md @@ -1,92 +1,9 @@ ---- -title: TimePilot ---- - -# TimePilot - -```{figure} ../../_static/videos/atari/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")` | - -For more TimePilot variants with different observation and action spaces, see the variants section. - -## 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. - -For a more detailed documentation, see [the AtariAge page](http://www.atarimania.com/game-atari-2600-vcs-time-pilot_8038.html) - -## Actions - -TimePilot has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPFIRE` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | -| `9` | `DOWNFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - -## 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). - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/trondead.md b/docs/environments/atari/trondead.md index 1effd66d3..8e60e3086 100644 --- a/docs/environments/atari/trondead.md +++ b/docs/environments/atari/trondead.md @@ -1,80 +1,9 @@ ---- -title: Trondead ---- - -# Trondead - -```{figure} ../../_static/videos/atari/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")` | - -For more Trondead variants with different observation and action spaces, see the variants section. - -## Description - -Use your deadly saucer to knock out encroaching opponents before they get to you. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=569) - -## Actions - -Trondead has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Trondead uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/turmoil.md b/docs/environments/atari/turmoil.md index d9c3d0b89..8ee7b97c8 100644 --- a/docs/environments/atari/turmoil.md +++ b/docs/environments/atari/turmoil.md @@ -1,79 +1,9 @@ ---- -title: Turmoil ---- - -# Turmoil - -```{figure} ../../_static/videos/atari/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")` | - -For more Turmoil variants with different observation and action spaces, see the variants section. - -## Description - -Blast aliens while avoiding deadly collisions. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=571) - -## Actions - -Turmoil has the action space of `Discrete(12)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `RIGHTFIRE` | `11` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 8]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/tutankham.md b/docs/environments/atari/tutankham.md index 2b47dc5aa..290cc64e6 100644 --- a/docs/environments/atari/tutankham.md +++ b/docs/environments/atari/tutankham.md @@ -1,90 +1,9 @@ ---- -title: Tutankham ---- - -# Tutankham - -```{figure} ../../_static/videos/atari/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")` | - -For more Tutankham variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to rack up points by finding treasures in the mazes of the tomb while eliminating its guardians. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=572) - -## Actions - -Tutankham has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-------------|---------|------------|---------|-----------| -| `0` | `NOOP` | `1` | `UP` | `2` | `RIGHT` | -| `3` | `LEFT` | `4` | `DOWN` | `5` | `UPFIRE` | -| `6` | `RIGHTFIRE` | `7` | `LEFTFIRE` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 4, 8, 12]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/up_n_down.md b/docs/environments/atari/up_n_down.md index 7d5420c84..c790190a4 100644 --- a/docs/environments/atari/up_n_down.md +++ b/docs/environments/atari/up_n_down.md @@ -1,89 +1,9 @@ ---- -title: UpNDown ---- - -# UpNDown - -```{figure} ../../_static/videos/atari/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")` | - -For more UpNDown variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to steer your baja bugger to collect prizes and eliminate opponents. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=574) - -## Actions - -UpNDown has the action space of `Discrete(6)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-----------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `DOWN` | `4` | `UPFIRE` | `5` | `DOWNFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/venture.md b/docs/environments/atari/venture.md index 7bd26b04d..d90e9711a 100644 --- a/docs/environments/atari/venture.md +++ b/docs/environments/atari/venture.md @@ -1,92 +1,9 @@ ---- -title: Venture ---- - -# Venture - -```{figure} ../../_static/videos/atari/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")` | - -For more Venture variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to capture the treasure in every chamber of the dungeon while eliminating the monsters. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=576) - -## Actions - -Venture has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Venture uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/video_checkers.md b/docs/environments/atari/video_checkers.md index 1a337313f..ba7581817 100644 --- a/docs/environments/atari/video_checkers.md +++ b/docs/environments/atari/video_checkers.md @@ -1,77 +1,9 @@ ---- -title: VideoCheckers ---- - -# VideoCheckers - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=579) - -## Actions - -VideoCheckers has the action space of `Discrete(5)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-------------|---------|------------|---------|-----------| -| `0` | `FIRE` | `1` | `UPRIGHT` | `2` | `UPLEFT` | -| `3` | `DOWNRIGHT` | `4` | `DOWNLEFT` | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|----------------------------|----------------|--------------------------|----------------------| -| `[1, ..., 9, 11, ..., 19]` | `1` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/video_chess.md b/docs/environments/atari/video_chess.md index 91d02e37c..fb878082a 100644 --- a/docs/environments/atari/video_chess.md +++ b/docs/environments/atari/video_chess.md @@ -1,79 +1,9 @@ ---- -title: VideoChess ---- - -# VideoChess - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=581) - -## Actions - -VideoChess has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-----------|---------|-------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 3, 4]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/video_cube.md b/docs/environments/atari/video_cube.md index b0f2c9ead..96fb70c1f 100644 --- a/docs/environments/atari/video_cube.md +++ b/docs/environments/atari/video_cube.md @@ -1,80 +1,9 @@ ---- -title: VideoCube ---- - -# VideoCube - -```{figure} ../../_static/videos/atari/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")` | - -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. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=974) - -## Actions - -VideoCube has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As VideoCube uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|--------------------------|----------------------| -| `[0, 1, 2, 100, 101, 102, 200, 201, 202, 300, 301, 302, 400, 401, 402, 500, 501, 502, 600, 601, 602, 700, 701, 702, 800, 801, 802, 900, 901, 902, 1000, 1001, 1002, 1100, 1101, 1102, 1200, 1201, 1202, 1300, 1301, 1302, 1400, 1401, 1402, 1500, 1501, 1502, 1600, 1601, 1602, 1700, 1701, 1702, 1800, 1801, 1802, 1900, 1901, 1902, 2000, 2001, 2002, 2100, 2101, 2102, 2200, 2201, 2202, 2300, 2301, 2302, 2400, 2401, 2402, 2500, 2501, 2502, 2600, 2601, 2602, 2700, 2701, 2702, 2800, 2801, 2802, 2900, 2901, 2902, 3000, 3001, 3002, 3100, 3101, 3102, 3200, 3201, 3202, 3300, 3301, 3302, 3400, 3401, 3402, 3500, 3501, 3502, 3600, 3601, 3602, 3700, 3701, 3702, 3800, 3801, 3802, 3900, 3901, 3902, 4000, 4001, 4002, 4100, 4101, 4102, 4200, 4201, 4202, 4300, 4301, 4302, 4400, 4401, 4402, 4500, 4501, 4502, 4600, 4601, 4602, 4700, 4701, 4702, 4800, 4801, 4802, 4900, 4901, 4902, 5000, 5001, 5002]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/video_pinball.md b/docs/environments/atari/video_pinball.md index 75a84feaf..bee8420b4 100644 --- a/docs/environments/atari/video_pinball.md +++ b/docs/environments/atari/video_pinball.md @@ -1,90 +1,9 @@ ---- -title: VideoPinball ---- - -# VideoPinball - -```{figure} ../../_static/videos/atari/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")` | - -For more VideoPinball variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to keep the ball in play as long as possible and to score as many points as possible. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=588) - -## Actions - -VideoPinball has the action space of `Discrete(9)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|-----------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPFIRE` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 2]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/wizard_of_wor.md b/docs/environments/atari/wizard_of_wor.md index 8ac4796c2..5448bdbef 100644 --- a/docs/environments/atari/wizard_of_wor.md +++ b/docs/environments/atari/wizard_of_wor.md @@ -1,91 +1,9 @@ ---- -title: WizardOfWor ---- - -# WizardOfWor - -```{figure} ../../_static/videos/atari/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")` | - -For more WizardOfWor variants with different observation and action spaces, see the variants section. - -## Description - -Your goal is to beat the Wizard using your laser and radar scanner. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=598) - -## Actions - -WizardOfWor has the action space of `Discrete(10)` with the table below listing the meaning of each action's meanings. -To enable all 18 possible actions that can be performed on an Atari 2600, specify `full_action_space=True` during -initialization or by passing `full_action_space=True` to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|------------|---------|-------------|---------|------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPFIRE` | `7` | `RIGHTFIRE` | `8` | `LEFTFIRE` | -| `9` | `DOWNFIRE` | | | | | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/word_zapper.md b/docs/environments/atari/word_zapper.md index feab01176..59daa6683 100644 --- a/docs/environments/atari/word_zapper.md +++ b/docs/environments/atari/word_zapper.md @@ -1,80 +1,9 @@ ---- -title: WordZapper ---- - -# WordZapper - -```{figure} ../../_static/videos/atari/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")` | - -For more WordZapper variants with different observation and action spaces, see the variants section. - -## Description - -Shoot letters under time pressure in the prescribed order as they scroll across the screen. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=599) - -## Actions - -WordZapper has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As WordZapper uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, ..., 23]` | `0` | `[0, 1, 2, 3]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/yars_revenge.md b/docs/environments/atari/yars_revenge.md index 110fd3fa8..44f33a802 100644 --- a/docs/environments/atari/yars_revenge.md +++ b/docs/environments/atari/yars_revenge.md @@ -1,92 +1,9 @@ ---- -title: YarsRevenge ---- - -# YarsRevenge - -```{figure} ../../_static/videos/atari/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")` | - -For more YarsRevenge variants with different observation and action spaces, see the variants section. - -## Description - -The objective is to break a path through the shield and destroy the Qotile with a blast from the Zorlon Cannon. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_page.php?SoftwareLabelID=603¤tPage=1&maxPages=12) - -## Actions - -YarsRevenge has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As YarsRevenge uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 32, 64, 96]` | `0` | `[0, 1]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/atari/zaxxon.md b/docs/environments/atari/zaxxon.md index 5441f234e..dc9438327 100644 --- a/docs/environments/atari/zaxxon.md +++ b/docs/environments/atari/zaxxon.md @@ -1,92 +1,9 @@ ---- -title: Zaxxon ---- - -# Zaxxon - -```{figure} ../../_static/videos/atari/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) | -| 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. - -## Description - -Your goal is to stop the evil robot Zaxxon and its armies from enslaving the galaxy by piloting your fighter and shooting enemies. - -For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=606) - -## Actions - -Zaxxon has the action space `Discrete(18)` with the table below listing the meaning of each action's meanings. -As Zaxxon uses the full set of actions then specifying `full_action_space=True` will not modify the action space of the environment if passed to `gymnasium.make`. - -| Value | Meaning | Value | Meaning | Value | Meaning | -|---------|--------------|---------|-----------------|---------|----------------| -| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` | -| `3` | `RIGHT` | `4` | `LEFT` | `5` | `DOWN` | -| `6` | `UPRIGHT` | `7` | `UPLEFT` | `8` | `DOWNRIGHT` | -| `9` | `DOWNLEFT` | `10` | `UPFIRE` | `11` | `RIGHTFIRE` | -| `12` | `LEFTFIRE` | `13` | `DOWNFIRE` | `14` | `UPRIGHTFIRE` | -| `15` | `UPLEFTFIRE` | `16` | `DOWNRIGHTFIRE` | `17` | `DOWNLEFTFIRE` | - -## Observations - -Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`. - -- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)` -- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)` -- `obs_type="grayscale" -> Box(0, 255, (210, 160), np.uint8)`, a grayscale version of the "rgb" type - -See variants section for the type of observation used by each environment id by default. - - - -## Variants - -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` | - -## Difficulty and modes - -It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`. -A flavor is a combination of a game mode and a difficulty setting. The table below lists the possible difficulty and mode values -along with the default values. - -| Available Modes | Default Mode | Available Difficulties | Default Difficulty | -|-------------------|----------------|--------------------------|----------------------| -| `[0, 8, 16, 24]` | `0` | `[0]` | `0` | - -## Version History - -A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments. - -* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace. -* v4: Stickiness of actions was removed -* v0: Initial versions release + + + + Redirecting to Atari Documentation's new home + + +

If you are not redirected automatically, follow this link to the new page.

+ + diff --git a/docs/environments/third_party_environments.md b/docs/environments/third_party_environments.md index 9024caba1..fdda46aef 100644 --- a/docs/environments/third_party_environments.md +++ b/docs/environments/third_party_environments.md @@ -28,6 +28,13 @@ goal-RL ([Gymnasium-Robotics](https://robotics.farama.org/)), *If you'd like to contribute an environment, please reach out on [Discord](https://discord.gg/bnJ6kubTg6).* +### [Buffalo-Gym: Multi-Armed Bandit Gymnasium](https://github.com/foreverska/buffalo-gym) + +![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.29.1-blue) +![GitHub stars](https://img.shields.io/github/stars/foreverska/buffalo-gym) + +Buffalo-Gym is a Multi-Armed Bandit (MAB) gymnasium built primarily to assist in debugging RL implementations. MABs are often easy to reason about what the agent is learning and whether it is correct. Buffalo-gym encompasses Bandits, Contextual bandits, and contextual bandits with aliasing. + ### [CARL: context adaptive RL](https://github.com/automl/CARL) ![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.27.1-blue) @@ -49,6 +56,13 @@ Craftium wraps the [Minetest](https://www.minetest.net/) game engine into the Gy A benchmark library for [Dynamic Algorithm Configuration](https://www.automl.org/dynamic-algorithm-configuration/). Its focus is on reproducibility and comparability of different DAC methods as well as easy analysis of the optimization process. +### [EV2Gym: A Realistic EV-V2G-Gym Simulator for EV Smart Charging](https://github.com/StavrosOrf/EV2Gym) + +![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.27.1-blue) +![GitHub stars](https://img.shields.io/github/stars/StavrosOrf/EV2Gym) + +EV2Gym is a fully customizable and easily configurable environment for Electric Vehicle (EV) smart charging simulations on a small and large scale. Also, includes non-RL baseline implementations such as mathematical programming, model predictive control, and heuristics. + ### [flappy-bird-env](https://github.com/robertoschiavone/flappy-bird-env) ![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) @@ -63,6 +77,13 @@ Flappy Bird as a Farama Gymnasium environment. A simple environment for single-agent reinforcement learning algorithms on a clone of [Flappy Bird](https://en.wikipedia.org/wiki/Flappy_Bird), the hugely popular arcade-style mobile game. Both state and pixel observation environments are available. +### [FlyCraft: A Fixed-wing UAV Environment](https://github.com/GongXudong/fly-craft) + +![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) +![GitHub stars](https://img.shields.io/github/stars/GongXudong/fly-craft) + +FlyCraft is a Gymnasium environment for fixed-wing UAV tasks. By default, FlyCraft provides two tasks: attitude control and velocity vector control. These tasks are characterized by their multi-goal and long-horizon nature, posing significant challenges for RL exploration. Additionally, the rewards can be configured as either Markovian or non-Markovian, making FlyCraft suitable for research on non-Markovian problems. + ### [gym-cellular-automata: Cellular Automata environments](https://github.com/elbecerrasoto/gym-cellular-automata) ![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) @@ -98,6 +119,13 @@ An environment for guiding automated theorem provers based on saturation algorit Gym Trading Env simulates stock (or crypto) market from historical data. It was designed to be fast and easily customizable. +### [ICU-Sepsis: A Benchmark MDP Built from Real Medical Data](https://github.com/icu-sepsis/icu-sepsis) + +![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) +![GitHub stars](https://img.shields.io/github/stars/icu-sepsis/icu-sepsis) + +ICU-Sepsis is a tabular reinforcement learning environment that simulates the treatment of sepsis in an intensive care unit (ICU). Introduced in the paper [ICU-Sepsis: A Benchmark MDP Built from Real Medical Data](https://arxiv.org/abs/2406.05646), the environment is lightweight and easy to use, yet challenging for most reinforcement learning algorithms. + ### [matrix-mdp: Easily create discrete MDPs](https://github.com/Paul-543NA/matrix-mdp-gym) ![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.26.2-blue) @@ -161,33 +189,19 @@ spark-sched-sim simulates Spark clusters for RL-based job scheduling algorithms. Gymnasium wrapper for various environments in the SUMO traffic simulator. Supports both single and multiagent settings (using [pettingzoo](https://pettingzoo.farama.org/)). -### [tmrl: TrackMania 2020 through RL](https://github.com/trackmania-rl/tmrl/) +### [Tetris Gymnasium: A fully configurable Gymnasium compatible Tetris environment](https://github.com/Max-We/Tetris-Gymnasium) -![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.27.1-blue) -![GitHub stars](https://img.shields.io/github/stars/trackmania-rl/tmrl) +![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) +![GitHub stars](https://img.shields.io/github/stars/Max-We/Tetris-Gymnasium) -tmrl is a distributed framework for training Deep Reinforcement Learning AIs in real-time applications. It is demonstrated on the TrackMania 2020 video game. +Tetris Gymnasium is a clean implementation of Tetris as a Gymnasium environment. It can be extensively customized (e.g. board dimensions, gravity, ...), is well documented and includes many examples on how to use it e.g. by providing training scripts. -### [EV2Gym: A Realistic EV-V2G-Gym Simulator for EV Smart Charging](https://github.com/StavrosOrf/EV2Gym) +### [tmrl: TrackMania 2020 through RL](https://github.com/trackmania-rl/tmrl/) ![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.27.1-blue) -![GitHub stars](https://img.shields.io/github/stars/StavrosOrf/EV2Gym) - -EV2Gym is a fully customizable and easily configurable environment for Electric Vehicle (EV) smart charging simulations on a small and large scale. Also, includes non-RL baseline implementations such as mathematical programming, model predictive control, and heuristics. - -### [Buffalo-Gym: Multi-Armed Bandit Gymnasium](https://github.com/foreverska/buffalo-gym) - -![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.29.1-blue) -![GitHub stars](https://img.shields.io/github/stars/foreverska/buffalo-gym) - -Buffalo-Gym is a Multi-Armed Bandit (MAB) gymnasium built primarily to assist in debugging RL implementations. MABs are often easy to reason about what the agent is learning and whether it is correct. Buffalo-gym encompasses Bandits, Contextual bandits, and contextual bandits with aliasing. - -### [ICU-Sepsis: A Benchmark MDP Built from Real Medical Data](https://github.com/icu-sepsis/icu-sepsis) - -![Gymnasium version dependency](https://img.shields.io/badge/Gymnasium-v0.28.1-blue) -![GitHub stars](https://img.shields.io/github/stars/icu-sepsis/icu-sepsis) +![GitHub stars](https://img.shields.io/github/stars/trackmania-rl/tmrl) -ICU-Sepsis is a tabular reinforcement learning environment that simulates the treatment of sepsis in an intensive care unit (ICU). Introduced in the paper [ICU-Sepsis: A Benchmark MDP Built from Real Medical Data](https://arxiv.org/abs/2406.05646), the environment is lightweight and easy to use, yet challenging for most reinforcement learning algorithms. +tmrl is a distributed framework for training Deep Reinforcement Learning AIs in real-time applications. It is demonstrated on the TrackMania 2020 video game. ## Third-Party Environments using Gym diff --git a/gymnasium/spaces/dict.py b/gymnasium/spaces/dict.py index 128cf8c71..49ff4c907 100644 --- a/gymnasium/spaces/dict.py +++ b/gymnasium/spaces/dict.py @@ -20,7 +20,7 @@ class Dict(Space[typing.Dict[str, Any]], typing.Mapping[str, Space[Any]]): >>> from gymnasium.spaces import Dict, Box, Discrete >>> observation_space = Dict({"position": Box(-1, 1, shape=(2,)), "color": Discrete(3)}, seed=42) >>> observation_space.sample() - {'color': 0, 'position': array([-0.3991573 , 0.21649833], dtype=float32)} + {'color': np.int64(0), 'position': array([-0.3991573 , 0.21649833], dtype=float32)} With a nested dict: diff --git a/gymnasium/spaces/discrete.py b/gymnasium/spaces/discrete.py index 41b9c356a..9a4575252 100644 --- a/gymnasium/spaces/discrete.py +++ b/gymnasium/spaces/discrete.py @@ -18,10 +18,10 @@ class Discrete(Space[np.int64]): >>> from gymnasium.spaces import Discrete >>> observation_space = Discrete(2, seed=42) # {0, 1} >>> observation_space.sample() - 0 + np.int64(0) >>> observation_space = Discrete(3, start=-1, seed=42) # {-1, 0, 1} >>> observation_space.sample() - -1 + np.int64(-1) """ def __init__( diff --git a/gymnasium/spaces/oneof.py b/gymnasium/spaces/oneof.py index 08aa50a5a..50e463be4 100644 --- a/gymnasium/spaces/oneof.py +++ b/gymnasium/spaces/oneof.py @@ -19,9 +19,9 @@ class OneOf(Space[Any]): >>> from gymnasium.spaces import OneOf, Box, Discrete >>> observation_space = OneOf((Discrete(2), Box(-1, 1, shape=(2,))), seed=123) >>> observation_space.sample() # the first element is the space index (Box in this case) and the second element is the sample from Box - (0, 0) + (np.int64(0), np.int64(0)) >>> observation_space.sample() # this time the Discrete space was sampled as index=0 - (1, array([-0.00711833, -0.7257502 ], dtype=float32)) + (np.int64(1), array([-0.00711833, -0.7257502 ], dtype=float32)) >>> observation_space[0] Discrete(2) >>> observation_space[1] diff --git a/gymnasium/spaces/tuple.py b/gymnasium/spaces/tuple.py index c7d2330d6..05a1f652a 100644 --- a/gymnasium/spaces/tuple.py +++ b/gymnasium/spaces/tuple.py @@ -19,7 +19,7 @@ class Tuple(Space[typing.Tuple[Any, ...]], typing.Sequence[Any]): >>> from gymnasium.spaces import Tuple, Box, Discrete >>> observation_space = Tuple((Discrete(2), Box(-1, 1, shape=(2,))), seed=42) >>> observation_space.sample() - (0, array([-0.3991573 , 0.21649833], dtype=float32)) + (np.int64(0), array([-0.3991573 , 0.21649833], dtype=float32)) """ def __init__( @@ -47,14 +47,14 @@ def is_np_flattenable(self): """Checks whether this space can be flattened to a :class:`spaces.Box`.""" return all(space.is_np_flattenable for space in self.spaces) - def seed(self, seed: int | tuple[int] | None = None) -> tuple[int, ...]: + def seed(self, seed: int | typing.Sequence[int] | None = None) -> tuple[int, ...]: """Seed the PRNG of this space and all subspaces. Depending on the type of seed, the subspaces will be seeded differently * ``None`` - All the subspaces will use a random initial seed * ``Int`` - The integer is used to seed the :class:`Tuple` space that is used to generate seed values for each of the subspaces. Warning, this does not guarantee unique seeds for all the subspaces. - * ``List`` - Values used to seed the subspaces. This allows the seeding of multiple composite subspaces ``[42, 54, ...]``. + * ``List`` / ``Tuple`` - Values used to seed the subspaces. This allows the seeding of multiple composite subspaces ``[42, 54, ...]``. Args: seed: An optional list of ints or int to seed the (sub-)spaces. diff --git a/gymnasium/spaces/utils.py b/gymnasium/spaces/utils.py index 6a0cff405..3ce554707 100644 --- a/gymnasium/spaces/utils.py +++ b/gymnasium/spaces/utils.py @@ -573,3 +573,102 @@ def _flatten_space_oneof(space: OneOf) -> Box: dtype = np.result_type(*[s.dtype for s in space.spaces if hasattr(s, "dtype")]) return Box(low=low, high=high, shape=(max_flatdim,), dtype=dtype) + + +@singledispatch +def is_space_dtype_shape_equiv(space_1: Space, space_2: Space) -> bool: + """Returns if two spaces share a common dtype and shape (plus any critical variables). + + This function is primarily used to check for compatibility of different spaces in a vector environment. + + Args: + space_1: A Gymnasium space + space_2: A Gymnasium space + + Returns: + If the two spaces share a common dtype and shape (plus any critical variables). + """ + if isinstance(space_1, Space) and isinstance(space_2, Space): + raise NotImplementedError( + "`check_dtype_shape_equivalence` doesn't support Generic Gymnasium Spaces, " + ) + else: + raise TypeError() + + +@is_space_dtype_shape_equiv.register(Box) +@is_space_dtype_shape_equiv.register(Discrete) +@is_space_dtype_shape_equiv.register(MultiDiscrete) +@is_space_dtype_shape_equiv.register(MultiBinary) +def _is_space_fundamental_dtype_shape_equiv(space_1, space_2): + return ( + # this check is necessary as singledispatch only checks the first variable and there are many options + type(space_1) is type(space_2) + and space_1.shape == space_2.shape + and space_1.dtype == space_2.dtype + ) + + +@is_space_dtype_shape_equiv.register(Text) +def _is_space_text_dtype_shape_equiv(space_1: Text, space_2): + return ( + isinstance(space_2, Text) + and space_1.max_length == space_2.max_length + and space_1.character_set == space_2.character_set + ) + + +@is_space_dtype_shape_equiv.register(Dict) +def _is_space_dict_dtype_shape_equiv(space_1: Dict, space_2): + return ( + isinstance(space_2, Dict) + and space_1.keys() == space_2.keys() + and all( + is_space_dtype_shape_equiv(space_1[key], space_2[key]) + for key in space_1.keys() + ) + ) + + +@is_space_dtype_shape_equiv.register(Tuple) +def _is_space_tuple_dtype_shape_equiv(space_1, space_2): + return isinstance(space_2, Tuple) and all( + is_space_dtype_shape_equiv(space_1[i], space_2[i]) for i in range(len(space_1)) + ) + + +@is_space_dtype_shape_equiv.register(Graph) +def _is_space_graph_dtype_shape_equiv(space_1: Graph, space_2): + return ( + isinstance(space_2, Graph) + and is_space_dtype_shape_equiv(space_1.node_space, space_2.node_space) + and ( + (space_1.edge_space is None and space_2.edge_space is None) + or ( + space_1.edge_space is not None + and space_2.edge_space is not None + and is_space_dtype_shape_equiv(space_1.edge_space, space_2.edge_space) + ) + ) + ) + + +@is_space_dtype_shape_equiv.register(OneOf) +def _is_space_oneof_dtype_shape_equiv(space_1: OneOf, space_2): + return ( + isinstance(space_2, OneOf) + and len(space_1) == len(space_2) + and all( + is_space_dtype_shape_equiv(space_1[i], space_2[i]) + for i in range(len(space_1)) + ) + ) + + +@is_space_dtype_shape_equiv.register(Sequence) +def _is_space_sequence_dtype_shape_equiv(space_1: Sequence, space_2): + return ( + isinstance(space_2, Sequence) + and space_1.stack is space_2.stack + and is_space_dtype_shape_equiv(space_1.feature_space, space_2.feature_space) + ) diff --git a/gymnasium/vector/async_vector_env.py b/gymnasium/vector/async_vector_env.py index 89999951d..3d7e24b78 100644 --- a/gymnasium/vector/async_vector_env.py +++ b/gymnasium/vector/async_vector_env.py @@ -14,7 +14,7 @@ import numpy as np -from gymnasium import logger +from gymnasium import Space, logger from gymnasium.core import ActType, Env, ObsType, RenderFrame from gymnasium.error import ( AlreadyPendingCallError, @@ -22,8 +22,10 @@ CustomSpaceError, NoAsyncCallError, ) +from gymnasium.spaces.utils import is_space_dtype_shape_equiv from gymnasium.vector.utils import ( CloudpickleWrapper, + batch_differing_spaces, batch_space, clear_mpi_env_vars, concatenate, @@ -98,6 +100,7 @@ def __init__( ] | None ) = None, + observation_mode: str | Space = "same", ): """Vectorized environment that runs multiple environments in parallel. @@ -113,11 +116,15 @@ def __init__( so for some environments you may want to have it set to ``False``. worker: If set, then use that worker in a subprocess instead of a default one. Can be useful to override some inner vector env logic, for instance, how resets on termination or truncation are handled. + observation_mode: Defines how environment observation spaces should be batched. 'same' defines that there should be ``n`` copies of identical spaces. + 'different' defines that there can be multiple observation spaces with different parameters though requires the same shape and dtype, + warning, may raise unexpected errors. Passing a ``Tuple[Space, Space]`` object allows defining a custom ``single_observation_space`` and + ``observation_space``, warning, may raise unexpected errors. Warnings: worker is an advanced mode option. It provides a high degree of flexibility and a high chance to shoot yourself in the foot; thus, if you are writing your own worker, it is recommended to start - from the code for ``_worker`` (or ``_worker_shared_memory``) method, and add changes. + from the code for ``_worker`` (or ``_async_worker``) method, and add changes. Raises: RuntimeError: If the observation space of some sub-environment does not match observation_space @@ -128,6 +135,7 @@ def __init__( self.env_fns = env_fns self.shared_memory = shared_memory self.copy = copy + self.observation_mode = observation_mode self.num_envs = len(env_fns) @@ -139,14 +147,31 @@ def __init__( self.metadata = dummy_env.metadata self.render_mode = dummy_env.render_mode - self.single_observation_space = dummy_env.observation_space self.single_action_space = dummy_env.action_space - - self.observation_space = batch_space( - self.single_observation_space, self.num_envs - ) self.action_space = batch_space(self.single_action_space, self.num_envs) + if isinstance(observation_mode, tuple) and len(observation_mode) == 2: + assert isinstance(observation_mode[0], Space) + assert isinstance(observation_mode[1], Space) + self.observation_space, self.single_observation_space = observation_mode + else: + if observation_mode == "same": + self.single_observation_space = dummy_env.observation_space + self.observation_space = batch_space( + self.single_observation_space, self.num_envs + ) + elif observation_mode == "different": + # the environment is created and instantly destroy, might cause issues for some environment + # but I don't believe there is anything else we can do, for users with issues, pre-compute the spaces and use the custom option. + env_spaces = [env().observation_space for env in self.env_fns] + + self.single_observation_space = env_spaces[0] + self.observation_space = batch_differing_spaces(env_spaces) + else: + raise ValueError( + f"Invalid `observation_mode`, expected: 'same' or 'different' or tuple of single and batch observation space, actual got {observation_mode}" + ) + dummy_env.close() del dummy_env @@ -162,9 +187,7 @@ def __init__( ) except CustomSpaceError as e: raise ValueError( - "Using `shared_memory=True` in `AsyncVectorEnv` is incompatible with non-standard Gymnasium observation spaces (i.e. custom spaces inheriting from `gymnasium.Space`), " - "and is only compatible with default Gymnasium spaces (e.g. `Box`, `Tuple`, `Dict`) for batching. " - "Set `shared_memory=False` if you use custom observation spaces." + "Using `AsyncVector(..., shared_memory=True)` caused an error, you can disable this feature with `shared_memory=False` however this is slower." ) from e else: _obs_buffer = None @@ -591,20 +614,33 @@ def _poll_pipe_envs(self, timeout: int | None = None): def _check_spaces(self): self._assert_is_running() - spaces = (self.single_observation_space, self.single_action_space) for pipe in self.parent_pipes: - pipe.send(("_check_spaces", spaces)) + pipe.send( + ( + "_check_spaces", + ( + self.observation_mode, + self.single_observation_space, + self.single_action_space, + ), + ) + ) results, successes = zip(*[pipe.recv() for pipe in self.parent_pipes]) self._raise_if_errors(successes) same_observation_spaces, same_action_spaces = zip(*results) if not all(same_observation_spaces): - raise RuntimeError( - f"Some environments have an observation space different from `{self.single_observation_space}`. " - "In order to batch observations, the observation spaces from all environments must be equal." - ) + if self.observation_mode == "same": + raise RuntimeError( + "AsyncVectorEnv(..., observation_mode='same') however some of the sub-environments observation spaces are not equivalent. If this is intentional, use `observation_mode='different'` instead." + ) + else: + raise RuntimeError( + "AsyncVectorEnv(..., observation_mode='different' or custom space) however the sub-environment's observation spaces do not share a common shape and dtype." + ) + if not all(same_action_spaces): raise RuntimeError( f"Some environments have an action space different from `{self.single_action_space}`. " @@ -714,9 +750,20 @@ def _async_worker( env.set_wrapper_attr(name, value) pipe.send((None, True)) elif command == "_check_spaces": + obs_mode, single_obs_space, single_action_space = data + pipe.send( ( - (data[0] == observation_space, data[1] == action_space), + ( + ( + single_obs_space == observation_space + if obs_mode == "same" + else is_space_dtype_shape_equiv( + single_obs_space, observation_space + ) + ), + single_action_space == action_space, + ), True, ) ) diff --git a/gymnasium/vector/sync_vector_env.py b/gymnasium/vector/sync_vector_env.py index b47c85f32..b92a26889 100644 --- a/gymnasium/vector/sync_vector_env.py +++ b/gymnasium/vector/sync_vector_env.py @@ -7,9 +7,16 @@ import numpy as np -from gymnasium import Env +from gymnasium import Env, Space from gymnasium.core import ActType, ObsType, RenderFrame -from gymnasium.vector.utils import batch_space, concatenate, create_empty_array, iterate +from gymnasium.spaces.utils import is_space_dtype_shape_equiv +from gymnasium.vector.utils import ( + batch_differing_spaces, + batch_space, + concatenate, + create_empty_array, + iterate, +) from gymnasium.vector.vector_env import ArrayType, VectorEnv @@ -57,19 +64,23 @@ def __init__( self, env_fns: Iterator[Callable[[], Env]] | Sequence[Callable[[], Env]], copy: bool = True, + observation_mode: str | Space = "same", ): """Vectorized environment that serially runs multiple environments. Args: env_fns: iterable of callable functions that create the environments. copy: If ``True``, then the :meth:`reset` and :meth:`step` methods return a copy of the observations. - + observation_mode: Defines how environment observation spaces should be batched. 'same' defines that there should be ``n`` copies of identical spaces. + 'different' defines that there can be multiple observation spaces with the same length but different high/low values batched together. Passing a ``Space`` object + allows the user to set some custom observation space mode not covered by 'same' or 'different.' Raises: RuntimeError: If the observation space of some sub-environment does not match observation_space (or, by default, the observation space of the first sub-environment). """ self.copy = copy self.env_fns = env_fns + self.observation_mode = observation_mode # Initialise all sub-environments self.envs = [env_fn() for env_fn in env_fns] @@ -80,17 +91,44 @@ def __init__( self.metadata = self.envs[0].metadata self.render_mode = self.envs[0].render_mode - # Initialises the single spaces from the sub-environments - self.single_observation_space = self.envs[0].observation_space self.single_action_space = self.envs[0].action_space - self._check_spaces() - - # Initialise the obs and action space based on the single versions and num of sub-environments - self.observation_space = batch_space( - self.single_observation_space, self.num_envs - ) self.action_space = batch_space(self.single_action_space, self.num_envs) + if isinstance(observation_mode, tuple) and len(observation_mode) == 2: + assert isinstance(observation_mode[0], Space) + assert isinstance(observation_mode[1], Space) + self.observation_space, self.single_observation_space = observation_mode + else: + if observation_mode == "same": + self.single_observation_space = self.envs[0].observation_space + self.observation_space = batch_space( + self.single_observation_space, self.num_envs + ) + elif observation_mode == "different": + self.single_observation_space = self.envs[0].observation_space + self.observation_space = batch_differing_spaces( + [env.observation_space for env in self.envs] + ) + else: + raise ValueError( + f"Invalid `observation_mode`, expected: 'same' or 'different' or tuple of single and batch observation space, actual got {observation_mode}" + ) + + # check sub-environment obs and action spaces + for env in self.envs: + if observation_mode == "same": + assert ( + env.observation_space == self.single_observation_space + ), f"SyncVectorEnv(..., observation_mode='same') however the sub-environments observation spaces are not equivalent. single_observation_space={self.single_observation_space}, sub-environment observation_space={env.observation_space}. If this is intentional, use `observation_mode='different'` instead." + else: + assert is_space_dtype_shape_equiv( + env.observation_space, self.single_observation_space + ), f"SyncVectorEnv(..., observation_mode='different' or custom space) however the sub-environments observation spaces do not share a common shape and dtype, single_observation_space={self.single_observation_space}, sub-environment observation space={env.observation_space}" + + assert ( + env.action_space == self.single_action_space + ), f"Sub-environment action space doesn't make the `single_action_space`, action_space={env.action_space}, single_action_space={self.single_action_space}" + # Initialise attributes used in `step` and `reset` self._observations = create_empty_array( self.single_observation_space, n=self.num_envs, fn=np.zeros @@ -265,20 +303,3 @@ def close_extras(self, **kwargs: Any): """Close the environments.""" if hasattr(self, "envs"): [env.close() for env in self.envs] - - def _check_spaces(self) -> bool: - """Check that each of the environments obs and action spaces are equivalent to the single obs and action space.""" - for env in self.envs: - if not (env.observation_space == self.single_observation_space): - raise RuntimeError( - f"Some environments have an observation space different from `{self.single_observation_space}`. " - "In order to batch observations, the observation spaces from all environments must be equal." - ) - - if not (env.action_space == self.single_action_space): - raise RuntimeError( - f"Some environments have an action space different from `{self.single_action_space}`. " - "In order to batch actions, the action spaces from all environments must be equal." - ) - - return True diff --git a/gymnasium/vector/utils/__init__.py b/gymnasium/vector/utils/__init__.py index a0ad58c3e..53c989d5f 100644 --- a/gymnasium/vector/utils/__init__.py +++ b/gymnasium/vector/utils/__init__.py @@ -7,6 +7,7 @@ write_to_shared_memory, ) from gymnasium.vector.utils.space_utils import ( + batch_differing_spaces, batch_space, concatenate, create_empty_array, @@ -16,6 +17,7 @@ __all__ = [ "batch_space", + "batch_differing_spaces", "iterate", "concatenate", "create_empty_array", diff --git a/gymnasium/vector/utils/shared_memory.py b/gymnasium/vector/utils/shared_memory.py index 3e5678054..914f6c962 100644 --- a/gymnasium/vector/utils/shared_memory.py +++ b/gymnasium/vector/utils/shared_memory.py @@ -103,7 +103,7 @@ def _create_oneof_shared_memory(space: OneOf, n: int = 1, ctx=mp): @create_shared_memory.register(Sequence) def _create_dynamic_shared_memory(space: Graph | Sequence, n: int = 1, ctx=mp): raise TypeError( - f"As {space} has a dynamic shape so its not possible to make a static shared memory." + f"As {space} has a dynamic shape so its not possible to make a static shared memory. For `AsyncVectorEnv`, disable `shared_memory`." ) @@ -154,22 +154,18 @@ def _read_base_from_shared_memory( @read_from_shared_memory.register(Tuple) def _read_tuple_from_shared_memory(space: Tuple, shared_memory, n: int = 1): - subspace_samples = tuple( + return tuple( read_from_shared_memory(subspace, memory, n=n) for (memory, subspace) in zip(shared_memory, space.spaces) ) - return tuple(zip(*subspace_samples)) @read_from_shared_memory.register(Dict) def _read_dict_from_shared_memory(space: Dict, shared_memory, n: int = 1): - subspace_samples = { + return { key: read_from_shared_memory(subspace, shared_memory[key], n=n) for (key, subspace) in space.spaces.items() } - return tuple( - {key: subspace_samples[key][i] for key in space.keys()} for i in range(n) - ) @read_from_shared_memory.register(Text) diff --git a/gymnasium/vector/utils/space_utils.py b/gymnasium/vector/utils/space_utils.py index 8eb0dd7dd..c4d5ef68d 100644 --- a/gymnasium/vector/utils/space_utils.py +++ b/gymnasium/vector/utils/space_utils.py @@ -1,6 +1,7 @@ """Space-based utility functions for vector environments. -- ``batch_space``: Create a (batched) space, containing multiple copies of a single space. +- ``batch_space``: Create a (batched) space containing multiple copies of a single space. +- ``batch_differing_spaces``: Create a (batched) space containing copies of different compatible spaces (share a common dtype and shape) - ``concatenate``: Concatenate multiple samples from (unbatched) space into a single object. - ``Iterate``: Iterate over the elements of a (batched) space and items. - ``create_empty_array``: Create an empty (possibly nested) (normally numpy-based) array, used in conjunction with ``concatenate(..., out=array)`` @@ -32,7 +33,13 @@ from gymnasium.spaces.space import T_cov -__all__ = ["batch_space", "iterate", "concatenate", "create_empty_array"] +__all__ = [ + "batch_space", + "batch_differing_spaces", + "iterate", + "concatenate", + "create_empty_array", +] @singledispatch @@ -139,6 +146,116 @@ def _batch_space_custom(space: Graph | Text | Sequence | OneOf, n: int = 1): return batched_space +@singledispatch +def batch_differing_spaces(spaces: list[Space]): + """Batch a Sequence of spaces that allows the subspaces to contain minor differences.""" + assert len(spaces) > 0, "Expects a non-empty list of spaces" + assert all( + isinstance(space, type(spaces[0])) for space in spaces + ), f"Expects all spaces to be the same shape, actual types: {[type(space) for space in spaces]}" + assert ( + type(spaces[0]) in batch_differing_spaces.registry + ), f"Requires the Space type to have a registered `batch_differing_space`, current list: {batch_differing_spaces.registry}" + + return batch_differing_spaces.dispatch(type(spaces[0]))(spaces) + + +@batch_differing_spaces.register(Box) +def _batch_differing_spaces_box(spaces: list[Box]): + assert all( + spaces[0].dtype == space.dtype for space in spaces + ), f"Expected all dtypes to be equal, actually {[space.dtype for space in spaces]}" + assert all( + spaces[0].low.shape == space.low.shape for space in spaces + ), f"Expected all Box.low shape to be equal, actually {[space.low.shape for space in spaces]}" + assert all( + spaces[0].high.shape == space.high.shape for space in spaces + ), f"Expected all Box.high shape to be equal, actually {[space.high.shape for space in spaces]}" + + return Box( + low=np.array([space.low for space in spaces]), + high=np.array([space.high for space in spaces]), + dtype=spaces[0].dtype, + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(Discrete) +def _batch_differing_spaces_discrete(spaces: list[Discrete]): + return MultiDiscrete( + nvec=np.array([space.n for space in spaces]), + start=np.array([space.start for space in spaces]), + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(MultiDiscrete) +def _batch_differing_spaces_multi_discrete(spaces: list[MultiDiscrete]): + assert all( + spaces[0].dtype == space.dtype for space in spaces + ), f"Expected all dtypes to be equal, actually {[space.dtype for space in spaces]}" + assert all( + spaces[0].nvec.shape == space.nvec.shape for space in spaces + ), f"Expects all MultiDiscrete.nvec shape, actually {[space.nvec.shape for space in spaces]}" + assert all( + spaces[0].start.shape == space.start.shape for space in spaces + ), f"Expects all MultiDiscrete.start shape, actually {[space.start.shape for space in spaces]}" + + return Box( + low=np.array([space.start for space in spaces]), + high=np.array([space.start + space.nvec for space in spaces]) - 1, + dtype=spaces[0].dtype, + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(MultiBinary) +def _batch_differing_spaces_multi_binary(spaces: list[MultiBinary]): + assert all(spaces[0].shape == space.shape for space in spaces) + + return Box( + low=0, + high=1, + shape=(len(spaces),) + spaces[0].shape, + dtype=spaces[0].dtype, + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(Tuple) +def _batch_differing_spaces_tuple(spaces: list[Tuple]): + return Tuple( + tuple( + batch_differing_spaces(subspaces) + for subspaces in zip(*[space.spaces for space in spaces]) + ), + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(Dict) +def _batch_differing_spaces_dict(spaces: list[Dict]): + assert all(spaces[0].keys() == space.keys() for space in spaces) + + return Dict( + { + key: batch_differing_spaces([space[key] for space in spaces]) + for key in spaces[0].keys() + }, + seed=deepcopy(spaces[0].np_random), + ) + + +@batch_differing_spaces.register(Graph) +@batch_differing_spaces.register(Text) +@batch_differing_spaces.register(Sequence) +@batch_differing_spaces.register(OneOf) +def _batch_spaces_undefined(spaces: list[Graph | Text | Sequence | OneOf]): + return Tuple( + [deepcopy(space) for space in spaces], seed=deepcopy(spaces[0].np_random) + ) + + @singledispatch def iterate(space: Space[T_cov], items: Iterable[T_cov]) -> Iterator: """Iterate over the elements of a (batched) space. diff --git a/gymnasium/wrappers/common.py b/gymnasium/wrappers/common.py index e66f6f7af..9b3d225bd 100644 --- a/gymnasium/wrappers/common.py +++ b/gymnasium/wrappers/common.py @@ -96,8 +96,11 @@ def __init__( Args: env: The environment to apply the wrapper - max_episode_steps: An optional max episode steps (if ``None``, ``env.spec.max_episode_steps`` is used) + max_episode_steps: the environment step after which the episode is truncated (``elapsed >= max_episode_steps``) """ + assert ( + isinstance(max_episode_steps, int) and max_episode_steps > 0 + ), f"Expect the `max_episode_steps` to be positive, actually: {max_episode_steps}" gym.utils.RecordConstructorArgs.__init__( self, max_episode_steps=max_episode_steps ) diff --git a/gymnasium/wrappers/stateful_observation.py b/gymnasium/wrappers/stateful_observation.py index 1ac798034..edffe3d77 100644 --- a/gymnasium/wrappers/stateful_observation.py +++ b/gymnasium/wrappers/stateful_observation.py @@ -557,9 +557,9 @@ class MaxAndSkipObservation( >>> wrapped_obs0, *_ = wrapped_env.reset(seed=123) >>> wrapped_obs1, *_ = wrapped_env.step(1) >>> np.all(obs0 == wrapped_obs0) - True + np.True_ >>> np.all(wrapped_obs1 == skip_and_max_obs) - True + np.True_ Change logs: * v1.0.0 - Initially add diff --git a/gymnasium/wrappers/stateful_reward.py b/gymnasium/wrappers/stateful_reward.py index cfcc9995e..67e2b784f 100644 --- a/gymnasium/wrappers/stateful_reward.py +++ b/gymnasium/wrappers/stateful_reward.py @@ -58,7 +58,7 @@ class NormalizeReward( ... >>> env.close() >>> np.var(episode_rewards) - 0.0008876301247721108 + np.float64(0.0008876301247721108) Example with the normalize reward wrapper: >>> import numpy as np @@ -76,7 +76,7 @@ class NormalizeReward( >>> env.close() >>> # will approach 0.99 with more episodes >>> np.var(episode_rewards) - 0.010162116476634746 + np.float64(0.010162116476634746) Change logs: * v0.21.0 - Initially added diff --git a/gymnasium/wrappers/transform_action.py b/gymnasium/wrappers/transform_action.py index 8ab5bb581..a069ab04f 100644 --- a/gymnasium/wrappers/transform_action.py +++ b/gymnasium/wrappers/transform_action.py @@ -146,7 +146,7 @@ class RescaleAction( >>> wrapped_env = RescaleAction(env, min_action=min_action, max_action=max_action) >>> wrapped_env_obs, _, _, _, _ = wrapped_env.step(max_action) >>> np.all(obs == wrapped_env_obs) - True + np.True_ Change logs: * v0.15.4 - Initially added diff --git a/gymnasium/wrappers/transform_observation.py b/gymnasium/wrappers/transform_observation.py index 0dafe69a8..824a401c3 100644 --- a/gymnasium/wrappers/transform_observation.py +++ b/gymnasium/wrappers/transform_observation.py @@ -594,11 +594,11 @@ class AddRenderObservation( >>> obs, _ = env.reset(seed=123) >>> image = env.render() >>> np.all(obs == image) - True + np.True_ >>> obs, *_ = env.step(env.action_space.sample()) >>> image = env.render() >>> np.all(obs == image) - True + np.True_ Example - Add the rendered image to the original observation as a dictionary item: >>> env = gym.make("CartPole-v1", render_mode="rgb_array") @@ -611,11 +611,11 @@ class AddRenderObservation( >>> obs["state"] array([ 0.01823519, -0.0446179 , -0.02796401, -0.03156282], dtype=float32) >>> np.all(obs["pixels"] == env.render()) - True + np.True_ >>> obs, reward, terminates, truncates, info = env.step(env.action_space.sample()) >>> image = env.render() >>> np.all(obs["pixels"] == image) - True + np.True_ Change logs: * v0.15.0 - Initially added as ``PixelObservationWrapper`` diff --git a/gymnasium/wrappers/transform_reward.py b/gymnasium/wrappers/transform_reward.py index d30248b09..b17308c25 100644 --- a/gymnasium/wrappers/transform_reward.py +++ b/gymnasium/wrappers/transform_reward.py @@ -77,7 +77,7 @@ class ClipReward(TransformReward[ObsType, ActType], gym.utils.RecordConstructorA >>> _ = env.reset() >>> _, rew, _, _, _ = env.step(1) >>> rew - 0.5 + np.float64(0.5) Change logs: * v1.0.0 - Initially added diff --git a/gymnasium/wrappers/vector/dict_info_to_list.py b/gymnasium/wrappers/vector/dict_info_to_list.py index c7afa537a..c66783fc3 100644 --- a/gymnasium/wrappers/vector/dict_info_to_list.py +++ b/gymnasium/wrappers/vector/dict_info_to_list.py @@ -54,13 +54,13 @@ class DictInfoToList(VectorWrapper): >>> _ = envs.action_space.seed(123) >>> _, _, _, _, infos = envs.step(envs.action_space.sample()) >>> infos - {'x_position': array([0.03332211, 0.10172355]), '_x_position': array([ True, True]), 'x_velocity': array([-0.06296527, 0.89345848]), '_x_velocity': array([ True, True]), 'reward_run': array([-0.06296527, 0.89345848]), '_reward_run': array([ True, True]), 'reward_ctrl': array([-0.24503503, -0.21944423]), '_reward_ctrl': array([ True, True])} + {'x_position': array([0.03332211, 0.10172355]), '_x_position': array([ True, True]), 'x_velocity': array([-0.06296527, 0.89345848]), '_x_velocity': array([ True, True]), 'reward_run': array([-0.06296527, 0.89345848]), '_reward_run': array([ True, True]), 'reward_ctrl': array([-0.24503504, -0.21944423], dtype=float32), '_reward_ctrl': array([ True, True])} >>> envs = DictInfoToList(envs) >>> _ = envs.reset(seed=123) >>> _ = envs.action_space.seed(123) >>> _, _, _, _, infos = envs.step(envs.action_space.sample()) >>> infos - [{'x_position': 0.0333221090036294, 'x_velocity': -0.06296527291998574, 'reward_run': -0.06296527291998574, 'reward_ctrl': -0.2450350284576416}, {'x_position': 0.10172354684460168, 'x_velocity': 0.8934584807363618, 'reward_run': 0.8934584807363618, 'reward_ctrl': -0.21944422721862794}] + [{'x_position': np.float64(0.0333221090036294), 'x_velocity': np.float64(-0.06296527291998574), 'reward_run': np.float64(-0.06296527291998574), 'reward_ctrl': np.float32(-0.24503504)}, {'x_position': np.float64(0.10172354684460168), 'x_velocity': np.float64(0.8934584807363618), 'reward_run': np.float64(0.8934584807363618), 'reward_ctrl': np.float32(-0.21944423)}] Change logs: * v0.24.0 - Initially added as ``VectorListInfo`` diff --git a/gymnasium/wrappers/vector/stateful_observation.py b/gymnasium/wrappers/vector/stateful_observation.py index 75a80416f..266c488d1 100644 --- a/gymnasium/wrappers/vector/stateful_observation.py +++ b/gymnasium/wrappers/vector/stateful_observation.py @@ -35,9 +35,9 @@ class NormalizeObservation(VectorObservationWrapper, gym.utils.RecordConstructor >>> for _ in range(100): ... obs, *_ = envs.step(envs.action_space.sample()) >>> np.mean(obs) - 0.024251968 + np.float32(0.024251968) >>> np.std(obs) - 0.62259156 + np.float32(0.62259156) >>> envs.close() Example with the normalize reward wrapper: @@ -49,9 +49,9 @@ class NormalizeObservation(VectorObservationWrapper, gym.utils.RecordConstructor >>> for _ in range(100): ... obs, *_ = envs.step(envs.action_space.sample()) >>> np.mean(obs) - -0.2359734 + np.float32(-0.2359734) >>> np.std(obs) - 1.1938739 + np.float32(1.1938739) >>> envs.close() """ diff --git a/gymnasium/wrappers/vector/stateful_reward.py b/gymnasium/wrappers/vector/stateful_reward.py index 14cd03f4f..2e0e8ea50 100644 --- a/gymnasium/wrappers/vector/stateful_reward.py +++ b/gymnasium/wrappers/vector/stateful_reward.py @@ -50,9 +50,9 @@ class NormalizeReward(VectorWrapper, gym.utils.RecordConstructorArgs): ... >>> envs.close() >>> np.mean(episode_rewards) - -0.03359492141887935 + np.float64(-0.03359492141887935) >>> np.std(episode_rewards) - 0.029028230434438706 + np.float64(0.029028230434438706) Example with the normalize reward wrapper: >>> import gymnasium as gym @@ -68,9 +68,9 @@ class NormalizeReward(VectorWrapper, gym.utils.RecordConstructorArgs): ... >>> envs.close() >>> np.mean(episode_rewards) - -0.1598639586606745 + np.float64(-0.1598639586606745) >>> np.std(episode_rewards) - 0.27800309628058434 + np.float64(0.27800309628058434) """ def __init__( diff --git a/gymnasium/wrappers/vector/vectorize_action.py b/gymnasium/wrappers/vector/vectorize_action.py index 1f517f663..3dc4a797a 100644 --- a/gymnasium/wrappers/vector/vectorize_action.py +++ b/gymnasium/wrappers/vector/vectorize_action.py @@ -33,7 +33,7 @@ class TransformAction(VectorActionWrapper): >>> obs array([[-0.46553135, -0.00142543], [-0.498371 , -0.00715587], - [-0.4651575 , -0.00624371]], dtype=float32) + [-0.46515748, -0.00624371]], dtype=float32) Example - With action transformation: >>> import gymnasium as gym diff --git a/gymnasium/wrappers/vector/vectorize_observation.py b/gymnasium/wrappers/vector/vectorize_observation.py index 68b5ef8b6..88bd539ad 100644 --- a/gymnasium/wrappers/vector/vectorize_observation.py +++ b/gymnasium/wrappers/vector/vectorize_observation.py @@ -321,15 +321,15 @@ class RescaleObservation(VectorizeTransformObservation): >>> envs = gym.make_vec("MountainCar-v0", num_envs=3, vectorization_mode="sync") >>> obs, info = envs.reset(seed=123) >>> obs.min() - -0.46352962 + np.float32(-0.46352962) >>> obs.max() - 0.0 + np.float32(0.0) >>> envs = RescaleObservation(envs, min_obs=-5.0, max_obs=5.0) >>> obs, info = envs.reset(seed=123) >>> obs.min() - -0.90849805 + np.float32(-0.90849805) >>> obs.max() - 0.0 + np.float32(0.0) >>> envs.close() """ diff --git a/tests/spaces/test_utils.py b/tests/spaces/test_utils.py index 01e445da2..66030bf47 100644 --- a/tests/spaces/test_utils.py +++ b/tests/spaces/test_utils.py @@ -6,7 +6,15 @@ import gymnasium as gym from gymnasium.spaces import Box, Graph, Sequence, utils +from gymnasium.spaces.utils import is_space_dtype_shape_equiv from gymnasium.utils.env_checker import data_equivalence +from gymnasium.vector.utils import ( + batch_space, + create_shared_memory, + iterate, + read_from_shared_memory, + write_to_shared_memory, +) from tests.spaces.utils import TESTING_SPACES, TESTING_SPACES_IDS @@ -162,3 +170,41 @@ def test_unflatten_multidiscrete_error(): value = np.array([0, 0]) with pytest.raises(ValueError): utils.unflatten(gym.spaces.MultiDiscrete([1, 1]), value) + + +@pytest.mark.parametrize("space", TESTING_SPACES, ids=TESTING_SPACES_IDS) +def test_is_space_dtype_shape_equiv(space): + assert is_space_dtype_shape_equiv(space, space) is True + + +@pytest.mark.parametrize("space_1", TESTING_SPACES, ids=TESTING_SPACES_IDS) +def test_all_space_pairs_for_is_space_dtype_shape_equiv(space_1): + """Practically check that the `is_space_dtype_shape_equiv` works as expected for `shared_memory`.""" + for space_2 in TESTING_SPACES: + compatible = is_space_dtype_shape_equiv(space_1, space_2) + + if compatible: + try: + shared_memory = create_shared_memory(space_1, n=2) + except TypeError as err: + assert ( + "has a dynamic shape so its not possible to make a static shared memory." + in str(err) + ) + continue + + batched_space = batch_space(space_1, n=2) + + space_1.seed(123) + space_2.seed(123) + sample_1 = space_1.sample() + sample_2 = space_2.sample() + + write_to_shared_memory(space_1, 0, sample_1, shared_memory) + write_to_shared_memory(space_2, 1, sample_2, shared_memory) + + read_samples = read_from_shared_memory(space_1, shared_memory, n=2) + read_sample_1, read_sample_2 = iterate(batched_space, read_samples) + + assert data_equivalence(sample_1, read_sample_1) + assert data_equivalence(sample_2, read_sample_2) diff --git a/tests/vector/test_observation_mode.py b/tests/vector/test_observation_mode.py new file mode 100644 index 000000000..7aff2e08f --- /dev/null +++ b/tests/vector/test_observation_mode.py @@ -0,0 +1,121 @@ +import re +from functools import partial + +import numpy as np +import pytest + +from gymnasium.spaces import Box, Dict, Discrete +from gymnasium.vector import AsyncVectorEnv, SyncVectorEnv +from gymnasium.vector.utils import batch_differing_spaces +from tests.testing_env import GenericTestEnv + + +def create_env(obs_space): + return lambda: GenericTestEnv(observation_space=obs_space) + + +# Test cases for both SyncVectorEnv and AsyncVectorEnv +@pytest.mark.parametrize( + "vector_env_fn", + [SyncVectorEnv, AsyncVectorEnv, partial(AsyncVectorEnv, shared_memory=False)], + ids=[ + "SyncVectorEnv", + "AsyncVectorEnv(shared_memory=True)", + "AsyncVectorEnv(shared_memory=False)", + ], +) +class TestVectorEnvObservationModes: + + def test_invalid_observation_mode(self, vector_env_fn): + with pytest.raises( + ValueError, + match=re.escape( + "Invalid `observation_mode`, expected: 'same' or 'different' or tuple of single and batch observation space, actual got invalid" + ), + ): + vector_env_fn( + [create_env(Box(low=0, high=1, shape=(5,))) for _ in range(3)], + observation_mode="invalid", + ) + + def test_obs_mode_same_different_spaces(self, vector_env_fn): + spaces = [Box(low=0, high=i, shape=(2,)) for i in range(1, 4)] + with pytest.raises( + (AssertionError, RuntimeError), + match="the sub-environments observation spaces are not equivalent. .*If this is intentional, use `observation_mode='different'` instead.", + ): + vector_env_fn( + [create_env(space) for space in spaces], observation_mode="same" + ) + + @pytest.mark.parametrize( + "observation_mode", + [ + "different", + ( + Box( + low=0, + high=np.repeat(np.arange(1, 4), 5).reshape((3, 5)), + shape=(3, 5), + ), + Box(low=0, high=1, shape=(5,)), + ), + ], + ) + def test_obs_mode_different_different_spaces(self, vector_env_fn, observation_mode): + spaces = [Box(low=0, high=i, shape=(5,)) for i in range(1, 4)] + envs = vector_env_fn( + [create_env(space) for space in spaces], observation_mode=observation_mode + ) + assert envs.observation_space == batch_differing_spaces(spaces) + assert envs.single_observation_space == spaces[0] + + envs.reset() + envs.step(envs.action_space.sample()) + envs.close() + + @pytest.mark.parametrize( + "observation_mode", + [ + "different", + (Box(low=0, high=4, shape=(3, 5)), Box(low=0, high=4, shape=(5,))), + ], + ) + def test_obs_mode_different_different_shapes(self, vector_env_fn, observation_mode): + spaces = [Box(low=0, high=1, shape=(i + 1,)) for i in range(3)] + with pytest.raises( + (AssertionError, RuntimeError), + # match=re.escape( + # "Expected all Box.low shape to be equal, actually [(1,), (2,), (3,)]" + # ), + ): + vector_env_fn( + [create_env(space) for space in spaces], + observation_mode=observation_mode, + ) + + @pytest.mark.parametrize( + "observation_mode", + [ + "same", + "different", + (Box(low=0, high=4, shape=(3, 5)), Box(low=0, high=4, shape=(5,))), + ], + ) + def test_mixed_observation_spaces(self, vector_env_fn, observation_mode): + spaces = [ + Box(low=0, high=1, shape=(3,)), + Discrete(5), + Dict({"a": Discrete(2), "b": Box(low=0, high=1, shape=(2,))}), + ] + + with pytest.raises( + (AssertionError, RuntimeError), + # match=re.escape( + # "Expects all spaces to be the same shape, actual types: [, , ]" + # ), + ): + vector_env_fn( + [create_env(space) for space in spaces], + observation_mode=observation_mode, + ) diff --git a/tests/vector/test_sync_vector_env.py b/tests/vector/test_sync_vector_env.py index 8ec187b98..cd0d685e7 100644 --- a/tests/vector/test_sync_vector_env.py +++ b/tests/vector/test_sync_vector_env.py @@ -1,5 +1,7 @@ """Test the `SyncVectorEnv` implementation.""" +import re + import numpy as np import pytest @@ -139,7 +141,12 @@ def test_check_spaces_sync_vector_env(): env_fns = [make_env("CartPole-v1", i) for i in range(8)] # FrozenLake-v1 - Discrete(16), action_space: Discrete(4) env_fns[1] = make_env("FrozenLake-v1", 1) - with pytest.raises(RuntimeError): + with pytest.raises( + AssertionError, + match=re.escape( + "SyncVectorEnv(..., observation_mode='same') however the sub-environments observation spaces are not equivalent." + ), + ): env = SyncVectorEnv(env_fns) env.close() diff --git a/tests/vector/test_vector_env.py b/tests/vector/test_vector_env.py index 0593b4101..6286d9623 100644 --- a/tests/vector/test_vector_env.py +++ b/tests/vector/test_vector_env.py @@ -1,13 +1,17 @@ """Test vector environment implementations.""" +from __future__ import annotations + from functools import partial import numpy as np import pytest +from gymnasium.core import ActType, ObsType from gymnasium.spaces import Discrete from gymnasium.utils.env_checker import data_equivalence from gymnasium.vector import AsyncVectorEnv, SyncVectorEnv +from tests.spaces.utils import TESTING_SPACES, TESTING_SPACES_IDS from tests.testing_env import GenericTestEnv from tests.vector.testing_utils import make_env @@ -61,6 +65,49 @@ def test_vector_env_equal(shared_memory): sync_env.close() +def debug_step_func(self, action: ActType) -> tuple[ObsType, float, bool, bool, dict]: + assert action in self.action_space + return self.observation_space.sample(), 0, False, False, {} + + +@pytest.mark.parametrize( + "vectoriser", + ( + SyncVectorEnv, + partial(AsyncVectorEnv, shared_memory=True), + partial(AsyncVectorEnv, shared_memory=False), + ), + ids=["Sync", "Async with shared memory", "Async without shared memory"], +) +@pytest.mark.parametrize("space", TESTING_SPACES, ids=TESTING_SPACES_IDS) +def test_vector_obs_action_spaces(vectoriser, space, num_envs=3): + try: + envs = vectoriser( + [ + lambda: GenericTestEnv( + action_space=space, + observation_space=space, + step_func=debug_step_func, + ) + for _ in range(num_envs) + ] + ) + except TypeError as err: + assert ( + "has a dynamic shape so its not possible to make a static shared memory." + in str(err) + ) + pytest.skip("Skipping space with dynamic shape") + + assert envs.observation_space == envs.action_space + + obs, _ = envs.reset() + assert obs in envs.observation_space + obs, _, _, _, _ = envs.step(envs.action_space.sample()) + + envs.close() + + @pytest.mark.parametrize( "vectoriser", ( diff --git a/tests/vector/utils/test_shared_memory.py b/tests/vector/utils/test_shared_memory.py index 6ff18a833..806f76b6a 100644 --- a/tests/vector/utils/test_shared_memory.py +++ b/tests/vector/utils/test_shared_memory.py @@ -9,7 +9,9 @@ from gymnasium.error import CustomSpaceError from gymnasium.utils.env_checker import data_equivalence from gymnasium.vector.utils import ( + batch_space, create_shared_memory, + iterate, read_from_shared_memory, write_to_shared_memory, ) @@ -31,8 +33,7 @@ def test_shared_memory_create_read_write(space, num, ctx): ) ctx = _ctx - samples = [space.sample() for _ in range(num)] - + batched_space = batch_space(space, n=num) try: shared_memory = create_shared_memory(space, n=num, ctx=ctx) except TypeError as err: @@ -42,11 +43,13 @@ def test_shared_memory_create_read_write(space, num, ctx): ) pytest.skip("Skipping space with dynamic shape") + samples = [space.sample() for _ in range(num)] for i, sample in enumerate(samples): write_to_shared_memory(space, i, sample, shared_memory) read_samples = read_from_shared_memory(space, shared_memory, n=num) - for read_sample, sample in zip(read_samples, samples): + assert read_samples in batched_space + for read_sample, sample in zip(iterate(batched_space, read_samples), samples): assert data_equivalence(read_sample, sample) diff --git a/tests/vector/utils/test_space_utils.py b/tests/vector/utils/test_space_utils.py index 18bfc9cab..c03df1269 100644 --- a/tests/vector/utils/test_space_utils.py +++ b/tests/vector/utils/test_space_utils.py @@ -4,13 +4,20 @@ import re from typing import Iterable +import numpy as np import pytest from gymnasium import Space from gymnasium.error import CustomSpaceError -from gymnasium.spaces import Tuple +from gymnasium.spaces import Box, Tuple from gymnasium.utils.env_checker import data_equivalence -from gymnasium.vector.utils import batch_space, concatenate, create_empty_array, iterate +from gymnasium.vector.utils import ( + batch_differing_spaces, + batch_space, + concatenate, + create_empty_array, + iterate, +) from tests.spaces.utils import TESTING_SPACES, TESTING_SPACES_IDS, CustomSpace from tests.vector.utils.utils import is_rng_equal @@ -68,13 +75,13 @@ def test_batch_space_deterministic(space: Space, n: int, base_seed: int): space_a = space space_a.seed(base_seed) space_b = copy.deepcopy(space_a) - is_rng_equal(space_a.np_random, space_b.np_random) + assert is_rng_equal(space_a.np_random, space_b.np_random) assert space_a.np_random is not space_b.np_random # Batch the spaces and check that the np_random are not reference equal space_a_batched = batch_space(space_a, n) space_b_batched = batch_space(space_b, n) - is_rng_equal(space_a_batched.np_random, space_b_batched.np_random) + assert is_rng_equal(space_a_batched.np_random, space_b_batched.np_random) assert space_a_batched.np_random is not space_b_batched.np_random # Create that the batched space is not reference equal to the origin spaces assert space_a.np_random is not space_a_batched.np_random @@ -101,7 +108,7 @@ def test_batch_space_different_samples(space: Space, n: int, base_seed: int): batched_space = batch_space(space, n) assert space.np_random is not batched_space.np_random - is_rng_equal(space.np_random, batched_space.np_random) + assert is_rng_equal(space.np_random, batched_space.np_random) batched_sample = batched_space.sample() unbatched_samples = list(iterate(batched_space, batched_sample)) @@ -149,3 +156,68 @@ def test_custom_space(): empty_array = create_empty_array(custom_space) assert empty_array is None + + +@pytest.mark.parametrize( + "spaces,expected_space", + [ + ( + ( + Box(low=0, high=1, shape=(2,), dtype=np.float32), + Box(low=2, high=np.array([3, 5], dtype=np.float32)), + ), + Box(low=np.array([[0, 0], [2, 2]]), high=np.array([[1, 1], [3, 5]])), + ), + ], +) +def test_varying_spaces(spaces: "list[Space]", expected_space): + """Test the batch spaces function.""" + batched_space = batch_differing_spaces(spaces) + assert batched_space == expected_space + + batch_samples = batched_space.sample() + for sub_space, sub_sample in zip(spaces, iterate(batched_space, batch_samples)): + assert sub_sample in sub_space + + +@pytest.mark.parametrize("space", TESTING_SPACES, ids=TESTING_SPACES_IDS) +@pytest.mark.parametrize("n", [1, 3]) +def test_batch_differing_space_vs_batch_space(space, n): + """Test the batch_spaces and batch_space functions.""" + batched_space = batch_space(space, n) + batched_spaces = batch_differing_spaces([copy.deepcopy(space) for _ in range(n)]) + + assert batched_space == batched_spaces, f"{batched_space=}, {batched_spaces=}" + + +@pytest.mark.parametrize("space", TESTING_SPACES, ids=TESTING_SPACES_IDS) +@pytest.mark.parametrize("n", [1, 2, 5], ids=[f"n={n}" for n in [1, 2, 5]]) +@pytest.mark.parametrize( + "base_seed", [123, 456], ids=[f"seed={base_seed}" for base_seed in [123, 456]] +) +def test_batch_differing_spaces_deterministic(space: Space, n: int, base_seed: int): + """Tests the batched spaces are deterministic by using a copied version.""" + # Copy the spaces and check that the np_random are not reference equal + space_a = space + space_a.seed(base_seed) + space_b = copy.deepcopy(space_a) + assert is_rng_equal(space_a.np_random, space_b.np_random) + assert space_a.np_random is not space_b.np_random + + # Batch the spaces and check that the np_random are not reference equal + space_a_batched = batch_differing_spaces([space_a for _ in range(n)]) + space_b_batched = batch_differing_spaces([space_b for _ in range(n)]) + assert is_rng_equal(space_a_batched.np_random, space_b_batched.np_random) + assert space_a_batched.np_random is not space_b_batched.np_random + # Create that the batched space is not reference equal to the origin spaces + assert space_a.np_random is not space_a_batched.np_random + + # Check that batched space a and b random number generator are not effected by the original space + space_a.sample() + space_a_batched_sample = space_a_batched.sample() + space_b_batched_sample = space_b_batched.sample() + for a_sample, b_sample in zip( + iterate(space_a_batched, space_a_batched_sample), + iterate(space_b_batched, space_b_batched_sample), + ): + assert data_equivalence(a_sample, b_sample) diff --git a/tests/wrappers/test_time_limit.py b/tests/wrappers/test_time_limit.py index 2d5261963..b5ac8e899 100644 --- a/tests/wrappers/test_time_limit.py +++ b/tests/wrappers/test_time_limit.py @@ -57,3 +57,24 @@ def patched_step(_action): _, _, terminated, truncated, _ = env.step(env.action_space.sample()) assert terminated is True assert truncated is True + + +def test_max_episode_steps(): + env = gym.make("CartPole-v1", disable_env_checker=True) + + assert env.spec.max_episode_steps == 500 + assert TimeLimit(env, max_episode_steps=10).spec.max_episode_steps == 10 + + with pytest.raises( + AssertionError, + match="Expect the `max_episode_steps` to be positive, actually: -1", + ): + TimeLimit(env, max_episode_steps=-1) + + with pytest.raises( + AssertionError, + match="Expect the `max_episode_steps` to be positive, actually: None", + ): + TimeLimit(env, max_episode_steps=None) + + env.close()