Skip to content

Commit cf7673e

Browse files
Update environment docs
1 parent b26a69d commit cf7673e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+461
-354
lines changed

docs/_scripts/environment-docs.json

+20-20
Large diffs are not rendered by default.

docs/environments/adventure.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,10 @@ See variants section for the type of observation used by each environment id by
5656
Adventure has the following variants of the environment id which have the following differences in observation,
5757
the number of frame-skips and the repeat action probability.
5858

59-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
60-
|------------------|-------------|--------------|------------------------------|
61-
| ALE/Adventure-v5 | `"rgb"` | `1` | `0.00` |
59+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
60+
|-------------------------|-------------|--------------|------------------------------|
61+
| AdventureNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
62+
| ALE/Adventure-v5 | `"rgb"` | `4` | `0.25` |
6263

6364
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AdventureNoFrameskip-v4`.
6465

docs/environments/air_raid.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,10 @@ See variants section for the type of observation used by each environment id by
5151
AirRaid has the following variants of the environment id which have the following differences in observation,
5252
the number of frame-skips and the repeat action probability.
5353

54-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
55-
|----------------|-------------|--------------|------------------------------|
56-
| ALE/AirRaid-v5 | `"rgb"` | `1` | `0.00` |
54+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
55+
|-----------------------|-------------|--------------|------------------------------|
56+
| AirRaidNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
57+
| ALE/AirRaid-v5 | `"rgb"` | `4` | `0.25` |
5758

5859
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AirRaidNoFrameskip-v4`.
5960

docs/environments/alien.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ You score points by destroying eggs, killing aliens, using pulsars, and collecti
6060
Alien has the following variants of the environment id which have the following differences in observation,
6161
the number of frame-skips and the repeat action probability.
6262

63-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64-
|--------------|-------------|--------------|------------------------------|
65-
| ALE/Alien-v5 | `"rgb"` | `1` | `0.00` |
63+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64+
|---------------------|-------------|--------------|------------------------------|
65+
| AlienNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
66+
| ALE/Alien-v5 | `"rgb"` | `4` | `0.25` |
6667

6768
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AlienNoFrameskip-v4`.
6869

docs/environments/amidar.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,10 @@ You score points by traversing new parts of the grid. Coloring an entire box in
5959
Amidar has the following variants of the environment id which have the following differences in observation,
6060
the number of frame-skips and the repeat action probability.
6161

62-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
63-
|---------------|-------------|--------------|------------------------------|
64-
| ALE/Amidar-v5 | `"rgb"` | `1` | `0.00` |
62+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
63+
|----------------------|-------------|--------------|------------------------------|
64+
| AmidarNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
65+
| ALE/Amidar-v5 | `"rgb"` | `4` | `0.25` |
6566

6667
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AmidarNoFrameskip-v4`.
6768

docs/environments/assault.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more Assault variants with different observation and action spaces, see the
2121

2222
## Description
2323

24-
You control a vehicle that can move sideways. A big mother ship circles overhead and continually deploys smaller drones.You must destroy these enemies and dodge their attacks.
24+
You control a vehicle that can move sideways. A big mother ship circles overhead and continually deploys smaller drones. You must destroy these enemies and dodge their attacks.
2525

2626
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=827)
2727

@@ -54,9 +54,10 @@ See variants section for the type of observation used by each environment id by
5454
Assault has the following variants of the environment id which have the following differences in observation,
5555
the number of frame-skips and the repeat action probability.
5656

57-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
58-
|----------------|-------------|--------------|------------------------------|
59-
| ALE/Assault-v5 | `"rgb"` | `1` | `0.00` |
57+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
58+
|-----------------------|-------------|--------------|------------------------------|
59+
| AssaultNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
60+
| ALE/Assault-v5 | `"rgb"` | `4` | `0.25` |
6061

6162
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AssaultNoFrameskip-v4`.
6263

docs/environments/asterix.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,10 @@ A table of scores awarded for collecting the different objects is provided on [t
5858
Asterix has the following variants of the environment id which have the following differences in observation,
5959
the number of frame-skips and the repeat action probability.
6060

61-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
62-
|----------------|-------------|--------------|------------------------------|
63-
| ALE/Asterix-v5 | `"rgb"` | `1` | `0.00` |
61+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
62+
|-----------------------|-------------|--------------|------------------------------|
63+
| AsterixNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
64+
| ALE/Asterix-v5 | `"rgb"` | `4` | `0.25` |
6465

6566
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsterixNoFrameskip-v4`.
6667

docs/environments/asteroids.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ You score points for destroying asteroids, satellites and UFOs. The smaller the
6060
Asteroids has the following variants of the environment id which have the following differences in observation,
6161
the number of frame-skips and the repeat action probability.
6262

63-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64-
|------------------|-------------|--------------|------------------------------|
65-
| ALE/Asteroids-v5 | `"rgb"` | `1` | `0.00` |
63+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64+
|-------------------------|-------------|--------------|------------------------------|
65+
| AsteroidsNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
66+
| ALE/Asteroids-v5 | `"rgb"` | `4` | `0.25` |
6667

6768
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AsteroidsNoFrameskip-v4`.
6869

docs/environments/atlantis.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more Atlantis variants with different observation and action spaces, see the
2121

2222
## Description
2323

24-
Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts.You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.
24+
Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts. You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.
2525

2626
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)
2727

@@ -57,10 +57,12 @@ You score points for destroying enemies, keeping installations protected during
5757
Atlantis has the following variants of the environment id which have the following differences in observation,
5858
the number of frame-skips and the repeat action probability.
5959

60-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
61-
|------------------|-------------|--------------|------------------------------|
62-
| ALE/Atlantis-v5 | `"rgb"` | `1` | `0.00` |
63-
| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` |
60+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
61+
|-------------------------|-------------|--------------|------------------------------|
62+
| Atlantis2NoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
63+
| AtlantisNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
64+
| ALE/Atlantis-v5 | `"rgb"` | `4` | `0.25` |
65+
| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` |
6466

6567
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `AtlantisNoFrameskip-v4`.
6668

docs/environments/atlantis2.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more Atlantis2 variants with different observation and action spaces, see th
2121

2222
## Description
2323

24-
Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts.You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.
24+
Your job is to defend the submerged city of Atlantis. Your enemies slowly descend towards the city and you must destroy them before they reach striking distance. To this end, you control three defense posts. You lose if your enemies manage to destroy all seven of Atlantis' installations. You may rebuild installations after you have fought of a wave of enemies and scored a sufficient number of points.
2525

2626
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)
2727

@@ -57,9 +57,10 @@ You score points for destroying enemies, keeping installations protected during
5757
Atlantis2 has the following variants of the environment id which have the following differences in observation,
5858
the number of frame-skips and the repeat action probability.
5959

60-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
61-
|------------------|-------------|--------------|------------------------------|
62-
| ALE/Atlantis2-v5 | `"rgb"` | `1` | `0.00` |
60+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
61+
|-------------------------|-------------|--------------|------------------------------|
62+
| Atlantis2NoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
63+
| ALE/Atlantis2-v5 | `"rgb"` | `4` | `0.25` |
6364

6465
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `Atlantis2NoFrameskip-v4`.
6566

docs/environments/backgammon.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,10 @@ See variants section for the type of observation used by each environment id by
5252
Backgammon has the following variants of the environment id which have the following differences in observation,
5353
the number of frame-skips and the repeat action probability.
5454

55-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
56-
|-------------------|-------------|--------------|------------------------------|
57-
| ALE/Backgammon-v5 | `"rgb"` | `1` | `0.00` |
55+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
56+
|--------------------------|-------------|--------------|------------------------------|
57+
| BackgammonNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
58+
| ALE/Backgammon-v5 | `"rgb"` | `4` | `0.25` |
5859

5960
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BackgammonNoFrameskip-v4`.
6061

docs/environments/bank_heist.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For more BankHeist variants with different observation and action spaces, see th
2121

2222
## Description
2323

24-
You are a bank robber and (naturally) want to rob as many banks as possible. You control your getaway car and must navigate maze-like cities. The police chases you and will appear whenever you rob a bank. You may destroy police cars by dropping sticks of dynamite. You can fill up your gas tank by entering a new city.At the beginning of the game you have four lives. Lives are lost if you run out of gas, are caught by the police,or run over the dynamite you have previously dropped.
24+
You are a bank robber and (naturally) want to rob as many banks as possible. You control your getaway car and must navigate maze-like cities. The police chases you and will appear whenever you rob a bank. You may destroy police cars by dropping sticks of dynamite. You can fill up your gas tank by entering a new city. At the beginning of the game you have four lives. Lives are lost if you run out of gas, are caught by the police,or run over the dynamite you have previously dropped.
2525

2626
For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008)
2727

@@ -60,9 +60,10 @@ You score points for robbing banks and destroying police cars. If you rob nine o
6060
BankHeist has the following variants of the environment id which have the following differences in observation,
6161
the number of frame-skips and the repeat action probability.
6262

63-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64-
|------------------|-------------|--------------|------------------------------|
65-
| ALE/BankHeist-v5 | `"rgb"` | `1` | `0.00` |
63+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64+
|-------------------------|-------------|--------------|------------------------------|
65+
| BankHeistNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
66+
| ALE/BankHeist-v5 | `"rgb"` | `4` | `0.25` |
6667

6768
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BankHeistNoFrameskip-v4`.
6869

docs/environments/basic_math.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,10 @@ See variants section for the type of observation used by each environment id by
5353
BasicMath has the following variants of the environment id which have the following differences in observation,
5454
the number of frame-skips and the repeat action probability.
5555

56-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
57-
|------------------|-------------|--------------|------------------------------|
58-
| ALE/BasicMath-v5 | `"rgb"` | `1` | `0.00` |
56+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
57+
|-------------------------|-------------|--------------|------------------------------|
58+
| BasicMathNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
59+
| ALE/BasicMath-v5 | `"rgb"` | `4` | `0.25` |
5960

6061
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BasicMathNoFrameskip-v4`.
6162

docs/environments/battle_zone.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,10 @@ You receive points for destroying enemies. For a more detailed documentation, se
6060
BattleZone has the following variants of the environment id which have the following differences in observation,
6161
the number of frame-skips and the repeat action probability.
6262

63-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64-
|-------------------|-------------|--------------|------------------------------|
65-
| ALE/BattleZone-v5 | `"rgb"` | `1` | `0.00` |
63+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
64+
|--------------------------|-------------|--------------|------------------------------|
65+
| BattleZoneNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
66+
| ALE/BattleZone-v5 | `"rgb"` | `4` | `0.25` |
6667

6768
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BattleZoneNoFrameskip-v4`.
6869

docs/environments/beam_rider.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,10 @@ You score points for destroying enemies. For a more detailed documentation, see
5858
BeamRider has the following variants of the environment id which have the following differences in observation,
5959
the number of frame-skips and the repeat action probability.
6060

61-
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
62-
|------------------|-------------|--------------|------------------------------|
63-
| ALE/BeamRider-v5 | `"rgb"` | `1` | `0.00` |
61+
| Env-id | obs_type= | frameskip= | repeat_action_probability= |
62+
|-------------------------|-------------|--------------|------------------------------|
63+
| BeamRiderNoFrameskip-v4 | `"rgb"` | `1` | `0.00` |
64+
| ALE/BeamRider-v5 | `"rgb"` | `4` | `0.25` |
6465

6566
See the [version history page](https://ale.farama.org/environments/#version-history-and-naming-schemes) to implement previously implemented environments, e.g., `BeamRiderNoFrameskip-v4`.
6667

0 commit comments

Comments
 (0)