Files
Gymnasium/docs/environments/atari/atlantis.md

100 lines
5.2 KiB
Markdown
Raw Normal View History

2022-09-13 20:27:34 +01:00
---
title: Atlantis
---
# Atlantis
```{figure} ../../_static/videos/atari/atlantis.gif
2022-09-13 20:27:34 +01:00
:width: 120px
2023-02-15 01:30:47 +00:00
:name: Atlantis
2022-09-13 20:27:34 +01:00
```
This environment is part of the <a href='..'>Atari environments</a>. Please read that page first for general information.
| | |
|---|---|
| Action Space | Discrete(4) |
| Observation Shape | (210, 160, 3) |
| Observation High | 255 |
| Observation Low | 0 |
| Import | `gymnasium.make("ALE/Atlantis-v5")` |
For more Atlantis variants with different observation and action spaces, see the variants section.
## Description
2023-02-15 01:30:47 +00:00
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)
2022-09-13 20:27:34 +01:00
## Actions
2023-02-15 01:30:47 +00:00
Atlantis has the action space `Discrete(4)` with the table below lists the meaning of each action's meanings.
As Atlantis uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment.
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`.
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
| Value | Meaning |
|---------|-------------|
| `0` | `NOOP` |
| `1` | `FIRE` |
| `2` | `RIGHTFIRE` |
| `3` | `LEFTFIRE` |
## Observations
2023-02-15 01:30:47 +00:00
Atari environment have two possible observation types, the observation space is listed below.
See variants section for the type of observation used by each environment id.
2023-02-15 01:30:47 +00:00
- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)`
- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)`
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
Additionally, `obs_type="grayscale"` cause the environment return a grayscale version of the rgb array for observations with the observation space being `Box(0, 255, (210, 160), np.uint8)`
2022-09-13 20:27:34 +01:00
### Rewards
2022-09-13 20:27:34 +01:00
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).
2023-02-15 01:30:47 +00:00
## 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
2022-09-13 20:27:34 +01:00
It is possible to specify various flavors of the environment via the keyword arguments `difficulty` and `mode`.
2023-02-15 01:30:47 +00:00
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.
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
| Available Modes | Default Mode | Available Difficulties | Default Difficulty |
|-------------------|----------------|--------------------------|----------------------|
| `[0, 1, 2, 3]` | `0` | `[0]` | `0` |
2022-09-13 20:27:34 +01:00
## Version History
2023-02-15 01:30:47 +00:00
A thorough discussion of the intricate differences between the versions and configurations can be found in the general article on Atari environments.
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
* v5: Stickiness was added back and stochastic frameskipping was removed. The environments are now in the "ALE" namespace.
2022-09-13 20:27:34 +01:00
* v4: Stickiness of actions was removed
2023-02-15 01:30:47 +00:00
* v0: Initial versions release