mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-23 15:04:20 +00:00
86 lines
3.6 KiB
Markdown
86 lines
3.6 KiB
Markdown
![]() |
---
|
||
|
title: Hero
|
||
|
---
|
||
|
|
||
|
# Hero
|
||
|
|
||
|
```{figure} ../../_static/videos/atari/hero.gif
|
||
|
:width: 120px
|
||
|
:name: Hero
|
||
|
```
|
||
|
|
||
|
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 | (210, 160, 3) |
|
||
|
| Observation High | 255 |
|
||
|
| Observation Low | 0 |
|
||
|
| Import | `gymnasium.make("ALE/Hero-v5")` |
|
||
|
|
||
|
### Description
|
||
|
You need to rescue miners that are stuck in a mine shaft. You have access to various tools: A propeller backpack that
|
||
|
allows you to fly wherever you want, sticks of dynamite that can be used to blast through walls, a laser beam to kill
|
||
|
vermin, and a raft to float across stretches of lava.
|
||
|
You have a limited amount of power. Once you run out, you lose a live.
|
||
|
Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228)
|
||
|
|
||
|
|
||
|
### Actions
|
||
|
By default, all actions that can be performed on an Atari 2600 are available in this environment.
|
||
|
Even if you use v0 or v4 or specify `full_action_space=False` during initialization, all actions
|
||
|
will be available in the default flavor.
|
||
|
|
||
|
|
||
|
### Observations
|
||
|
By default, the environment returns the RGB image that is displayed to human players as an observation. However, it is
|
||
|
possible to observe
|
||
|
- The 128 Bytes of RAM of the console
|
||
|
- A grayscale image
|
||
|
|
||
|
instead. The respective observation spaces are
|
||
|
- `Box([0 ... 0], [255 ... 255], (128,), uint8)`
|
||
|
- `Box([[0 ... 0]
|
||
|
...
|
||
|
[0 ... 0]], [[255 ... 255]
|
||
|
...
|
||
|
[255 ... 255]], (250, 160), uint8)
|
||
|
`
|
||
|
|
||
|
respectively. The general article on Atari environments outlines different ways to instantiate corresponding environments
|
||
|
via `gymnasium.make`.
|
||
|
|
||
|
### Rewards
|
||
|
You score points for shooting critters, rescuing miners, and dynamiting walls.
|
||
|
Extra points are rewarded for any power remaining after rescuing a miner.
|
||
|
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=228).
|
||
|
|
||
|
|
||
|
### Arguments
|
||
|
|
||
|
```
|
||
|
env = gymnasium.make("ALE/Hero-v5")
|
||
|
```
|
||
|
|
||
|
The various ways to configure the environment are described in detail in the article on Atari environments.
|
||
|
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.
|
||
|
|
||
|
| Environment | Valid Modes | Valid Difficulties | Default Mode |
|
||
|
|------------------|--------------------------|--------------------|---------------|
|
||
|
| Hero | `[0, ..., 4]` | `[0]` | `0` |
|
||
|
|
||
|
You may use the suffix "-ram" to switch to the RAM observation space. In v0 and v4, the suffixes "Deterministic" and "NoFrameskip"
|
||
|
are available. These are no longer supported in v5. In order to obtain equivalent behavior, pass keyword arguments to `gymnasium.make` as outlined in
|
||
|
the general article on Atari environments.
|
||
|
The versions v0 and v4 are not contained in the "ALE" namespace. I.e. they are instantiated via `gymnasium.make("Hero-v0")`.
|
||
|
|
||
|
### 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 entire action space is used by default. The environments are now in the "ALE" namespace.
|
||
|
* v4: Stickiness of actions was removed
|
||
|
* v0: Initial versions release (1.0.0)
|