Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Redirect Atari pages to ale.farama.org/environments #1163

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Redirect Atari pages to ale.farama.org/environments #1163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9db4d33
Redirect Atari pages to `ale.farama.org/environments`
pseudo-rnd-thoughts Sep 18, 2024
ddad044
Change to use markdown html meta redirect
pseudo-rnd-thoughts Sep 19, 2024
d7f2265
pre-commit
pseudo-rnd-thoughts Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/environments/.htaccess
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]
275 changes: 9 additions & 266 deletions docs/environments/atari.md
View file
Open in desktop

Large diffs are not rendered by default.

101 changes: 9 additions & 92 deletions docs/environments/atari/adventure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,92 +1,9 @@
---
title: Adventure
---

# Adventure

```{figure} ../../_static/videos/atari/adventure.gif
:width: 120px
:name: Adventure
```

This environment is part of the <a href='..'>Atari environments</a>. 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
<html>
<head>
<meta http-equiv="refresh" content="0; url=https://ale.farama.org/environments/adventure">
<title>Redirecting to Atari Documentation's new home</title>
</head>
<body>
<p>If you are not redirected automatically, follow this <a href="https://ale.farama.org/environments/adventure">link to the new page</a>.</p>
</body>
</html>
96 changes: 9 additions & 87 deletions docs/environments/atari/air_raid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,87 +1,9 @@
---
title: AirRaid
---

# AirRaid

```{figure} ../../_static/videos/atari/air_raid.gif
:width: 120px
:name: AirRaid
```

This environment is part of the <a href='..'>Atari environments</a>. 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
<html>
<head>
<meta http-equiv="refresh" content="0; url=https://ale.farama.org/environments/air_raid">
<title>Redirecting to Atari Documentation's new home</title>
</head>
<body>
<p>If you are not redirected automatically, follow this <a href="https://ale.farama.org/environments/air_raid">link to the new page</a>.</p>
</body>
</html>
102 changes: 9 additions & 93 deletions docs/environments/atari/alien.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,93 +1,9 @@
---
title: Alien
---

# Alien

```{figure} ../../_static/videos/atari/alien.gif
:width: 120px
:name: Alien
```

This environment is part of the <a href='..'>Atari environments</a>. 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
<html>
<head>
<meta http-equiv="refresh" content="0; url=https://ale.farama.org/environments/alien">
<title>Redirecting to Atari Documentation's new home</title>
</head>
<body>
<p>If you are not redirected automatically, follow this <a href="https://ale.farama.org/environments/alien">link to the new page</a>.</p>
</body>
</html>
Loading
Loading