gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-24 23:43:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make atari documentation consistent (#418)

Browse Source
This commit is contained in:
Mark Towers
2023-03-30 15:49:37 +01:00
committed by GitHub
parent 46af646be1
commit 7fa9702cd4
105 changed files with 632 additions and 790 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/scripts/gen_atari_table.py
View File

@@ -91,7 +91,7 @@ for rom_id in tqdm(ALL_ATARI_GAMES):
if env_data["atariage_url"]:
env_url = f"""
For a more detailed documentation, see [the AtariAge page]({env_data['atariage_url']})
"""
"""
else:
env_url = ""
reward_description = env_data["reward_description"]
@@ -111,11 +111,10 @@ For a more detailed documentation, see [the AtariAge page]({env_data['atariage_u
tablefmt="github",
)
if env.action_space.n == 18:
action_description = f"""{env_name} has the action space `{env.action_space}` with the table below lists the meaning of each action's meanings.
action_description = f"""{env_name} has the action space `{env.action_space}` with the table below listing the meaning of each action's meanings.
As {env_name} 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`."""
else:
action_description = f"""{env_name} has the action space `{env.action_space}` with the table below lists the meaning of each action's meanings.
As {env_name} uses a reduced set of actions for `v0`, `v4` and `v5` versions of the environment.
action_description = f"""{env_name} has the action space of `{env.action_space}` with the table below listing the meaning of each action's meanings.
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`."""
@@ -186,9 +185,7 @@ This environment is part of the <a href='..'>Atari environments</a>. Please read
| | |
|---|---|
| Action Space | {env.action_space} |
| Observation Shape | {env.observation_space.shape} |
| Observation High | {env.observation_space.high.max()} |
| Observation Low | {env.observation_space.low.min()} |
| Observation Space | {env.observation_space} |
| Import | `gymnasium.make("{env.spec.id}")` |
For more {env_name} variants with different observation and action spaces, see the variants section.
@@ -205,13 +202,14 @@ For more {env_name} variants with different observation and action spaces, see t
## 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.
Atari environments have three possible observation types: `"rgb"`, `"grayscale"` and `"ram"`.
- `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.
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)`
{reward_description}
## Variants