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

98 lines
4.8 KiB
Markdown
Raw Normal View History

2022-09-13 20:27:34 +01:00
---
title: Gopher
---
2022-09-13 20:27:34 +01:00
# Gopher
```{figure} ../../_static/videos/atari/gopher.gif
2022-09-13 20:27:34 +01:00
:width: 120px
:name: Gopher
```
This environment is part of the <a href='..'>Atari environments</a>. Please read that page first for general information.
| | |
|---|---|
| Action Space | Discrete(8) |
| Observation Shape | (210, 160, 3) |
| Observation High | 255 |
| Observation Low | 0 |
| Import | `gymnasium.make("ALE/Gopher-v5")` |
For more Gopher variants with different observation and action spaces, see the variants section.
## Description
2023-02-15 01:30:47 +00:00
The player controls a shovel-wielding farmer who protects a crop of three carrots from a gopher.
2022-09-13 20:27:34 +01:00
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=218)
2023-02-15 01:30:47 +00:00
## Actions
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
Gopher has the action space `Discrete(8)` with the table below lists the meaning of each action's meanings.
As Gopher 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
| Value | Meaning | Value | Meaning | Value | Meaning |
|---------|-------------|---------|------------|---------|-----------|
| `0` | `NOOP` | `1` | `FIRE` | `2` | `UP` |
| `3` | `RIGHT` | `4` | `LEFT` | `5` | `UPFIRE` |
| `6` | `RIGHTFIRE` | `7` | `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.
2022-09-13 20:27:34 +01:00
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)`
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)`
### Rewards
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
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).
2022-09-19 21:14:09 +01:00
2023-02-15 01:30:47 +00:00
Atari environments are simulated via the Arcade Learning Environment (ALE) [[1]](#1).
2022-09-13 20:27:34 +01:00
2023-02-15 01:30:47 +00:00
## 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` |
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.
* v4: Stickiness of actions was removed
* v0: Initial versions release