mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-01 22:11:25 +00:00
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
|
---
|
||
|
|
title: Klax
|
||
|
|
---
|
||
|
|
|
||
|
|
# Klax
|
||
|
|
|
||
|
|
```{figure} ../../_static/videos/atari/klax.gif
|
||
|
|
:width: 120px
|
||
|
|
:name: Klax
|
||
|
|
```
|
||
|
|
|
||
|
|
This environment is part of the <a href='..'>Atari environments</a>. Please read that page first for general information.
|
||
|
|
|
||
|
|
| | |
|
||
|
|
|---|---|
|
||
|
|
| Action Space | Discrete(18) |
|
||
|
|
| Observation Shape | (250, 160, 3) |
|
||
|
|
| Observation High | 255 |
|
||
|
|
| Observation Low | 0 |
|
||
|
|
| Import | `gymnasium.make("ALE/Klax-v5")` |
|
||
|
|
|
||
|
|
For more Klax variants with different observation and action spaces, see the variants section.
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
Klax 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
|
||
|
|
|
||
|
|
Klax has the action space `Discrete(18)` with the table below lists 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 |
|
||
|
|
|---------|-----------------|
|
||
|
|
| `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 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.
|
||
|
|
|
||
|
|
- `obs_type="rgb" -> observation_space=Box(0, 255, (210, 160, 3), np.uint8)`
|
||
|
|
- `obs_type="ram" -> observation_space=Box(0, 255, (128,), np.uint8)`
|
||
|
|
|
||
|
|
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)`
|
||
|
|
|
||
|
|
## 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 frameskipping was removed. The environments are now in the "ALE" namespace.
|
||
|
|
* v4: Stickiness of actions was removed
|
||
|
|
* v0: Initial versions release
|