Documentation update (Farama-Foundation#909)

TimSchneider42 · Feb 5, 2024 · 0b2cd17 · 0b2cd17
1 parent 136d1e1
commit 0b2cd17
Show file tree

Hide file tree

Showing 145 changed files with 278 additions and 386 deletions.
diff --git a/docs/_scripts/atari-docs.json b/docs/_scripts/atari-docs.json
diff --git a/docs/_scripts/gen_atari_table.py b/docs/_scripts/gen_atari_table.py
@@ -9,6 +9,11 @@
 import gymnasium
 
 
+# Necessary for v1.0.0 without ale-py gymnasium support
+# from shimmy import registration
+# registration._register_atari_envs()
+
+
 # # Generate the list of all atari games on atari.md
 for rom_id in sorted(ALL_ATARI_GAMES):
     print(f"atari/{rom_id}")
@@ -51,7 +56,7 @@ def shortened_repr(values):
 for rom_id in tqdm(ALL_ATARI_GAMES):
     env_name = rom_utils.rom_id_to_name(rom_id)
 
-    env = gymnasium.make(f"ALE/{env_name}-v5")
+    env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped
 
     available_difficulties = env.ale.getAvailableDifficulties()
     default_difficulty = env.ale.cloneState().getDifficulty()
@@ -83,7 +88,7 @@ def shortened_repr(values):
 for rom_id in tqdm(ALL_ATARI_GAMES):
     env_name = rom_utils.rom_id_to_name(rom_id)
 
-    env = gymnasium.make(f"ALE/{env_name}-v5")
+    env = gymnasium.make(f"ALE/{env_name}-v5").unwrapped
     if rom_id in atari_data:
         env_data = atari_data[rom_id]
 
@@ -211,6 +216,7 @@ def shortened_repr(values):
 See variants section for the type of observation used by each environment id by default.
 
 {reward_description}
+
 ## Variants
 
 {env_name} has the following variants of the environment id which have the following differences in observation,
@@ -230,7 +236,7 @@ def shortened_repr(values):
 
 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.
+* v5: Stickiness was added back and stochastic frame-skipping was removed. The environments are now in the "ALE" namespace.
 * v4: Stickiness of actions was removed
 * v0: Initial versions release
 """

diff --git a/docs/_scripts/gen_gifs.py b/docs/_scripts/gen_gifs.py
@@ -17,9 +17,6 @@
     "FrozenLake8x8",
     "LunarLanderContinuous",
     "BipedalWalkerHardcore",
-    "CartPoleJax",
-    "PendulumJax",
-    "Jax-Blackjack",
 ]
 for env_spec in gym.registry.values():
     if env_spec.name in exclude_env_names:

diff --git a/docs/_static/videos/box2d/bipedal_walker.gif b/docs/_static/videos/box2d/bipedal_walker.gif
diff --git a/docs/_static/videos/box2d/car_racing.gif b/docs/_static/videos/box2d/car_racing.gif
diff --git a/docs/_static/videos/box2d/lunar_lander.gif b/docs/_static/videos/box2d/lunar_lander.gif
diff --git a/docs/_static/videos/classic_control/acrobot.gif b/docs/_static/videos/classic_control/acrobot.gif
diff --git a/docs/_static/videos/classic_control/cart_pole.gif b/docs/_static/videos/classic_control/cart_pole.gif
diff --git a/docs/_static/videos/classic_control/mountain_car.gif b/docs/_static/videos/classic_control/mountain_car.gif
diff --git a/docs/_static/videos/classic_control/mountain_car_continuous.gif b/docs/_static/videos/classic_control/mountain_car_continuous.gif
diff --git a/docs/_static/videos/classic_control/pendulum.gif b/docs/_static/videos/classic_control/pendulum.gif
diff --git a/docs/_static/videos/mujoco/ant.gif b/docs/_static/videos/mujoco/ant.gif
diff --git a/docs/_static/videos/mujoco/half_cheetah.gif b/docs/_static/videos/mujoco/half_cheetah.gif
diff --git a/docs/_static/videos/mujoco/hopper.gif b/docs/_static/videos/mujoco/hopper.gif
diff --git a/docs/_static/videos/mujoco/humanoid.gif b/docs/_static/videos/mujoco/humanoid.gif
diff --git a/docs/_static/videos/mujoco/humanoid_standup.gif b/docs/_static/videos/mujoco/humanoid_standup.gif
diff --git a/docs/_static/videos/mujoco/inverted_double_pendulum.gif b/docs/_static/videos/mujoco/inverted_double_pendulum.gif
diff --git a/docs/_static/videos/mujoco/inverted_pendulum.gif b/docs/_static/videos/mujoco/inverted_pendulum.gif
diff --git a/docs/_static/videos/mujoco/pusher.gif b/docs/_static/videos/mujoco/pusher.gif
diff --git a/docs/_static/videos/mujoco/reacher.gif b/docs/_static/videos/mujoco/reacher.gif
diff --git a/docs/_static/videos/mujoco/swimmer.gif b/docs/_static/videos/mujoco/swimmer.gif
diff --git a/docs/_static/videos/mujoco/walker2d.gif b/docs/_static/videos/mujoco/walker2d.gif
diff --git a/docs/_static/videos/toy_text/blackjack.gif b/docs/_static/videos/toy_text/blackjack.gif
diff --git a/docs/_static/videos/toy_text/cliff_walking.gif b/docs/_static/videos/toy_text/cliff_walking.gif
diff --git a/docs/_static/videos/toy_text/frozen_lake.gif b/docs/_static/videos/toy_text/frozen_lake.gif
diff --git a/docs/_static/videos/toy_text/taxi.gif b/docs/_static/videos/toy_text/taxi.gif
diff --git a/docs/api/wrappers.md b/docs/api/wrappers.md
@@ -12,7 +12,6 @@ wrappers/misc_wrappers
 wrappers/action_wrappers
 wrappers/observation_wrappers
 wrappers/reward_wrappers
-wrappers/vector_wrappers
 ```
 
 ```{eval-rst}

diff --git a/docs/environments/atari/adventure.md b/docs/environments/atari/adventure.md
@@ -50,6 +50,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Adventure has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/air_raid.md b/docs/environments/atari/air_raid.md
@@ -45,6 +45,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 AirRaid has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/alien.md b/docs/environments/atari/alien.md
@@ -49,11 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught
-by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a
-table of scores corresponding to the different achievements, consult [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).
+## Rewards
+You score points by destroying eggs, killing aliens, using pulsars, and collecting special prizes. When you are caught by an alien, you will lose one of your lives. The number of lives you have depends on the game flavor. For a table of scores corresponding to the different achievements, consult the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=815).
 
 ## Variants
 

diff --git a/docs/environments/atari/amidar.md b/docs/environments/atari/amidar.md
@@ -48,10 +48,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).
+## Rewards
+You score points by traversing new parts of the grid. Coloring an entire box in the maze or catching chickens gives extra points. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=817).
 
 ## Variants
 

diff --git a/docs/environments/atari/assault.md b/docs/environments/atari/assault.md
@@ -21,7 +21,7 @@ For more Assault variants with different observation and action spaces, see the
 
 ## Description
 
-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.
+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.
 
 For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=827)
 
@@ -48,6 +48,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Assault has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/asterix.md b/docs/environments/atari/asterix.md
@@ -47,9 +47,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-A table of scores awarded for collecting the different objects is provided on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325).
+## Rewards
+A table of scores awarded for collecting the different objects is provided on the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=3325).
 
 ## Variants
 

diff --git a/docs/environments/atari/asteroids.md b/docs/environments/atari/asteroids.md
@@ -49,11 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score
-for destroying it.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).
+## Rewards
+You score points for destroying asteroids, satellites and UFOs. The smaller the asteroid, the more points you score for destroying it. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=828&itemTypeID=HTMLMANUAL).
 
 ## Variants
 

diff --git a/docs/environments/atari/atlantis.md b/docs/environments/atari/atlantis.md
@@ -21,7 +21,7 @@ For more Atlantis variants with different observation and action spaces, see the
 
 ## Description
 
-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.
+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.
 
 For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835)
 
@@ -46,11 +46,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points for destroying enemies, keeping installations protected during attack waves. You score more points
-if you manage to destroy your enemies with one of the outer defense posts.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
+## Rewards
+You score points for destroying enemies, keeping installations protected during attack waves. You score more points if you manage to destroy your enemies with one of the outer defense posts. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=835).
 
 ## Variants
 

diff --git a/docs/environments/atari/atlantis2.md b/docs/environments/atari/atlantis2.md
@@ -45,6 +45,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Atlantis2 has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/backgammon.md b/docs/environments/atari/backgammon.md
@@ -46,6 +46,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Backgammon has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/bank_heist.md b/docs/environments/atari/bank_heist.md
@@ -21,7 +21,7 @@ For more BankHeist variants with different observation and action spaces, see th
 
 ## Description
 
-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.
+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.
 
 For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008)
 
@@ -49,11 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city,
-you will score extra points.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).
+## Rewards
+You score points for robbing banks and destroying police cars. If you rob nine or more banks, and then leave the city, you will score extra points. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=1008).
 
 ## Variants
 

diff --git a/docs/environments/atari/basic_math.md b/docs/environments/atari/basic_math.md
@@ -21,8 +21,7 @@ For more BasicMath variants with different observation and action spaces, see th
 
 ## Description
 
-You must solve basic math problems using a joystick
-to scroll to the correct numeric answer.
+You must solve basic math problems using a joystick to scroll to the correct numeric answer.
 
 For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareLabelID=14)
 
@@ -48,6 +47,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 BasicMath has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/battle_zone.md b/docs/environments/atari/battle_zone.md
@@ -49,10 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You receive points for destroying enemies.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).
+## Rewards
+You receive points for destroying enemies. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=859&itemTypeID=HTMLMANUAL).
 
 ## Variants
 

diff --git a/docs/environments/atari/beam_rider.md b/docs/environments/atari/beam_rider.md
@@ -47,10 +47,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points for destroying enemies.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).
+## Rewards
+You score points for destroying enemies. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=860&itemTypeID=MANUAL).
 
 ## Variants
 

diff --git a/docs/environments/atari/berzerk.md b/docs/environments/atari/berzerk.md
@@ -21,7 +21,7 @@ For more Berzerk variants with different observation and action spaces, see the
 
 ## Description
 
-You are stuck in a maze with evil robots. You must destroy them and avoid touching the walls of the maze, as this will kill you. You may be awarded extra lives after scoring a sufficient number of points, depending on the game mode.You may also be chased by an undefeatable enemy, Evil Otto, that you must avoid. Evil Otto does not appear in the default mode.
+You are stuck in a maze with evil robots. You must destroy them and avoid touching the walls of the maze, as this will kill you. You may be awarded extra lives after scoring a sufficient number of points, depending on the game mode. You may also be chased by an undefeatable enemy, Evil Otto, that you must avoid. Evil Otto does not appear in the default mode.
 
 For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=866)
 
@@ -49,10 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points for destroying robots.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).
+## Rewards
+You score points for destroying robots. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SystemID=2600&SoftwareID=866&itemTypeID=HTMLMANUAL).
 
 ## Variants
 

diff --git a/docs/environments/atari/blackjack.md b/docs/environments/atari/blackjack.md
@@ -47,6 +47,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Blackjack has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/bowling.md b/docs/environments/atari/bowling.md
@@ -46,12 +46,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open"
-frame. Moreover, the points you score for one frame may depend on following frames.
-You can score up to 300 points in one game (if you manage to do 12 strikes).
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).
+## Rewards
+You receive points for knocking down pins. The exact score depends on whether you manage a "strike", "spare" or "open" frame. Moreover, the points you score for one frame may depend on following frames. You can score up to 300 points in one game (if you manage to do 12 strikes). For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=879).
 
 ## Variants
 

diff --git a/docs/environments/atari/boxing.md b/docs/environments/atari/boxing.md
@@ -49,10 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by landing punches.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).
+## Rewards
+You score points by landing punches. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=882).
 
 ## Variants
 

diff --git a/docs/environments/atari/breakout.md b/docs/environments/atari/breakout.md
@@ -46,10 +46,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick.
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).
+## Rewards
+You score points by destroying bricks in the wall. The reward for destroying a brick depends on the color of the brick. For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=889).
 
 ## Variants
 

diff --git a/docs/environments/atari/carnival.md b/docs/environments/atari/carnival.md
@@ -46,11 +46,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign.
-You will score extra points if it shows a plus sign!
-For a more detailed documentation, see [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).
+## Rewards
+You score points by destroying targets. Points (or bullets) may be subtracted if you hit the target when it shows a minus sign. You will score extra points if it shows a plus sign! For a more detailed documentation, see the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=908).
 
 ## Variants
 

diff --git a/docs/environments/atari/casino.md b/docs/environments/atari/casino.md
@@ -47,6 +47,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 See variants section for the type of observation used by each environment id by default.
 
 
+
 ## Variants
 
 Casino has the following variants of the environment id which have the following differences in observation,

diff --git a/docs/environments/atari/centipede.md b/docs/environments/atari/centipede.md
@@ -49,11 +49,8 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
 
 See variants section for the type of observation used by each environment id by default.
 
-### Rewards
-
-You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round
-(i.e. after you have lost a wand) for mushrooms that were not destroyed.
-Detailed documentation can be found on [the AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).
+## Rewards
+You score points by hitting centipedes, scorpions, fleas and spiders. Additional points are awarded after every round (i.e. after you have lost a wand) for mushrooms that were not destroyed. Detailed documentation can be found on the [AtariAge page](https://atariage.com/manual_html_page.php?SoftwareID=911).
 
 ## Variants
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,6 +50,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
		See variants section for the type of observation used by each environment id by default.



		## Variants

		Adventure has the following variants of the environment id which have the following differences in observation,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -45,6 +45,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
		See variants section for the type of observation used by each environment id by default.



		## Variants

		AirRaid has the following variants of the environment id which have the following differences in observation,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -46,6 +46,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
		See variants section for the type of observation used by each environment id by default.



		## Variants

		Backgammon has the following variants of the environment id which have the following differences in observation,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -47,6 +47,7 @@ Atari environments have three possible observation types: `"rgb"`, `"grayscale"`
		See variants section for the type of observation used by each environment id by default.



		## Variants

		Blackjack has the following variants of the environment id which have the following differences in observation,
Expand Down