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

90 lines
4.4 KiB
Markdown
Raw Normal View History

2022-09-13 20:27:34 +01:00
---
title: Phoenix
---
2022-09-13 20:27:34 +01:00
# Phoenix
```{figure} ../../_static/videos/atari/phoenix.gif
2022-09-13 20:27:34 +01:00
:width: 120px
:name: Phoenix
```
This environment is part of the <a href='..'>Atari environments</a>. 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
2023-02-15 01:30:47 +00:00
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.
2022-09-13 20:27:34 +01:00
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_thumbs.php?SoftwareLabelID=355)
2023-02-15 01:30:47 +00:00
## Actions
2022-09-13 20:27:34 +01:00
Phoenix has the action space of `Discrete(8)` with the table below listing the meaning of each action's meanings.
2023-02-15 01:30:47 +00:00
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"`.
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)`
- `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.
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
## Variants
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
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.
2023-02-15 01:30:47 +00:00
| 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` |
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
## Difficulty and modes
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
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.
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]` | `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