mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-19 21:42:02 +00:00
1829 lines
85 KiB
HTML
1829 lines
85 KiB
HTML
<!doctype html>
|
||
<html class="no-js" lang="en" data-content_root="../../">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark">
|
||
<meta name="description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)">
|
||
<meta property="og:title" content="Gymnasium Documentation" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)" />
|
||
<meta property="og:url" content="https://gymnasium.farama.org/environments/atari.html" /><meta property="og:image" content="https://gymnasium.farama.org/_static/img/gymnasium-github.png" /><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Adventure" href="adventure/" /><link rel="prev" title="Walker2D" href="../mujoco/walker2d/" />
|
||
<link rel="canonical" href="https://gymnasium.farama.org/environments/atari.html" />
|
||
|
||
<link rel="shortcut icon" href="../../_static/favicon.png"/><!-- Generated with Sphinx 7.3.7 and Furo 2023.08.19.dev1 -->
|
||
<title>Atari - Gymnasium Documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=3e7f4c72" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css?v=61a4c737" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css?v=f4aeca0c" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css?v=2082cf3c" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css?v=1277b6f3" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=49cbaffd" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
<header class="farama-header" aria-label="Farama header">
|
||
<div class="farama-header__container">
|
||
<div class="farama-header__left--mobile">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||
<defs></defs>
|
||
<line x1="0.5" y1="4" x2="23.5" y2="4"></line>
|
||
<line x1="0.232" y1="12" x2="23.5" y2="12"></line>
|
||
<line x1="0.232" y1="20" x2="23.5" y2="20"></line>
|
||
</svg>
|
||
</label>
|
||
</div>
|
||
<div class="farama-header__left farama-header__center--mobile">
|
||
<a href="../../">
|
||
<img class="farama-header__logo only-light" src="../../_static/img/gymnasium_black.svg" alt="Light Logo"/>
|
||
<img class="farama-header__logo only-dark" src="../../_static/img/gymnasium_white.svg" alt="Dark Logo"/>
|
||
<span class="farama-header__title">Gymnasium Documentation</span>
|
||
</a>
|
||
</div>
|
||
<div class="farama-header__right">
|
||
<div class="farama-header-menu">
|
||
<button class="farama-header-menu__btn" aria-label="Open Farama Menu" aria-expanded="false" aria-haspopup="true" aria-controls="farama-menu">
|
||
<img class="farama-black-logo-invert" src="../../_static/img/farama-logo-header.svg">
|
||
<svg viewBox="0 0 24 24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
|
||
<polyline style="stroke-linecap: round; stroke-linejoin: round; fill: none; stroke-width: 2px;" points="1 7 12 18 23 7"></polyline>
|
||
</svg>
|
||
</button>
|
||
<div class="farama-header-menu-container farama-hidden" aria-hidden="true" id="farama-menu">
|
||
<div class="farama-header-menu__header">
|
||
<a href="https://farama.org">
|
||
<img class="farama-header-menu__logo farama-white-logo-invert" src="../../_static/img/farama_solid_white.svg" alt="Farama Foundation logo">
|
||
<span>Farama Foundation</span>
|
||
</a>
|
||
<div class="farama-header-menu-header__right">
|
||
<button id="farama-close-menu">
|
||
<svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="icon-close">
|
||
<line x1="3" y1="21" x2="21" y2="3"></line>
|
||
<line x1="3" y1="3" x2="21" y2="21"></line>
|
||
</svg>
|
||
</button>
|
||
</div>
|
||
</div>
|
||
<div class="farama-header-menu__body">
|
||
<!-- Response from farama.org/api/projects.json -->
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
<div class="page">
|
||
<!--<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="../../"><div class="brand">Gymnasium Documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>-->
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="farama-sidebar__title" href="../../">
|
||
<img class="farama-header__logo only-light" src="../../_static/img/gymnasium_black.svg" alt="Light Logo"/>
|
||
<img class="farama-header__logo only-dark" src="../../_static/img/gymnasium_white.svg" alt="Dark Logo"/>
|
||
<span class="farama-header__title">Gymnasium Documentation</span>
|
||
</a><form class="sidebar-search-container" method="get" action="../../search/" role="search">
|
||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/basic_usage/">Basic Usage</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/train_agent/">Training an Agent</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/create_custom_env/">Create a Custom Environment</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/record_agent/">Recording Agents</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/speed_up_env/">Speeding Up Training</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/gym_compatibility/">Compatibility with Gym</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../introduction/migration_guide/">Migration Guide - v0.21 to v1.0.0</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../api/env/">Env</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../api/registry/">Make and register</a></li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../api/spaces/">Spaces</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Spaces</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/spaces/fundamental/">Fundamental Spaces</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/spaces/composite/">Composite Spaces</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/spaces/utils/">Spaces Utils</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../api/wrappers/">Wrappers</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Wrappers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/wrappers/table/">List of Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/wrappers/misc_wrappers/">Misc Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/wrappers/action_wrappers/">Action Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/wrappers/observation_wrappers/">Observation Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/wrappers/reward_wrappers/">Reward Wrappers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../api/vector/">Vectorize</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Vectorize</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/vector/wrappers/">Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/vector/async_vector_env/">AsyncVectorEnv</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/vector/sync_vector_env/">SyncVectorEnv</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../api/vector/utils/">Utility functions</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../api/utils/">Utility functions</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../api/functional/">Functional Env</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../classic_control/">Classic Control</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Classic Control</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../classic_control/acrobot/">Acrobot</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../classic_control/cart_pole/">Cart Pole</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../classic_control/mountain_car_continuous/">Mountain Car Continuous</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../classic_control/mountain_car/">Mountain Car</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../classic_control/pendulum/">Pendulum</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../box2d/">Box2D</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Box2D</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../box2d/bipedal_walker/">Bipedal Walker</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../box2d/car_racing/">Car Racing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../box2d/lunar_lander/">Lunar Lander</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../toy_text/">Toy Text</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Toy Text</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../toy_text/blackjack/">Blackjack</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../toy_text/taxi/">Taxi</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../toy_text/cliff_walking/">Cliff Walking</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../toy_text/frozen_lake/">Frozen Lake</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../mujoco/">MuJoCo</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of MuJoCo</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/ant/">Ant</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/half_cheetah/">Half Cheetah</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/hopper/">Hopper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/humanoid/">Humanoid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/humanoid_standup/">Humanoid Standup</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/inverted_double_pendulum/">Inverted Double Pendulum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/inverted_pendulum/">Inverted Pendulum</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/pusher/">Pusher</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/reacher/">Reacher</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/swimmer/">Swimmer</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../mujoco/walker2d/">Walker2D</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Atari</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Atari</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="adventure/">Adventure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="air_raid/">AirRaid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="alien/">Alien</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="amidar/">Amidar</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="assault/">Assault</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="asterix/">Asterix</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="asteroids/">Asteroids</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="atlantis/">Atlantis</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="atlantis2/">Atlantis2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="backgammon/">Backgammon</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="bank_heist/">BankHeist</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="basic_math/">BasicMath</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="battle_zone/">BattleZone</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="beam_rider/">BeamRider</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="berzerk/">Berzerk</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="blackjack/">Blackjack</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="bowling/">Bowling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="boxing/">Boxing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="breakout/">Breakout</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="carnival/">Carnival</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="casino/">Casino</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="centipede/">Centipede</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="chopper_command/">ChopperCommand</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="crazy_climber/">CrazyClimber</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="crossbow/">Crossbow</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="darkchambers/">Darkchambers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="defender/">Defender</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="demon_attack/">DemonAttack</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="donkey_kong/">DonkeyKong</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="double_dunk/">DoubleDunk</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="earthworld/">Earthworld</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="elevator_action/">ElevatorAction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="enduro/">Enduro</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="entombed/">Entombed</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="et/">Et</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="fishing_derby/">FishingDerby</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="flag_capture/">FlagCapture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="freeway/">Freeway</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="frogger/">Frogger</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="frostbite/">Frostbite</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="galaxian/">Galaxian</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="gopher/">Gopher</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="gravitar/">Gravitar</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="hangman/">Hangman</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="haunted_house/">HauntedHouse</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="hero/">Hero</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="human_cannonball/">HumanCannonball</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="ice_hockey/">IceHockey</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="jamesbond/">Jamesbond</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="journey_escape/">JourneyEscape</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kaboom/">Kaboom</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kangaroo/">Kangaroo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="keystone_kapers/">KeystoneKapers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="king_kong/">KingKong</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="klax/">Klax</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="koolaid/">Koolaid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="krull/">Krull</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kung_fu_master/">KungFuMaster</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="laser_gates/">LaserGates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="lost_luggage/">LostLuggage</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mario_bros/">MarioBros</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="miniature_golf/">MiniatureGolf</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="montezuma_revenge/">MontezumaRevenge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="mr_do/">MrDo</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="ms_pacman/">MsPacman</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="name_this_game/">NameThisGame</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="othello/">Othello</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pacman/">Pacman</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="phoenix/">Phoenix</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pitfall/">Pitfall</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pitfall2/">Pitfall2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pong/">Pong</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="pooyan/">Pooyan</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="private_eye/">PrivateEye</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="qbert/">Qbert</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="riverraid/">Riverraid</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="road_runner/">RoadRunner</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="robotank/">Robotank</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="seaquest/">Seaquest</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="sir_lancelot/">SirLancelot</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="skiing/">Skiing</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="solaris/">Solaris</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="space_invaders/">SpaceInvaders</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="space_war/">SpaceWar</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="star_gunner/">StarGunner</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="superman/">Superman</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="surround/">Surround</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tennis/">Tennis</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tetris/">Tetris</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tic_tac_toe_3d/">TicTacToe3D</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="time_pilot/">TimePilot</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="trondead/">Trondead</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="turmoil/">Turmoil</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="tutankham/">Tutankham</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="up_n_down/">UpNDown</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="venture/">Venture</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="video_checkers/">VideoCheckers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="video_chess/">VideoChess</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="video_cube/">VideoCube</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="video_pinball/">VideoPinball</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="wizard_of_wor/">WizardOfWor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="word_zapper/">WordZapper</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="yars_revenge/">YarsRevenge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="zaxxon/">Zaxxon</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../third_party_environments/">External Environments</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||
<ul>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Gymnasium Basics</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/load_quadruped_model/">Load custom quadruped robot environments</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of Training Agents</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/FrozenLake_tuto/">Frozenlake benchmark</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/third-party-tutorials/">Third-Party Tutorials</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://www.comet.com/docs/v2/integrations/ml-frameworks/gymnasium/?utm_source=gymnasium&utm_medium=partner&utm_campaign=partner_gymnasium_2023&utm_content=docs_gymnasium">Comet Tutorial</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../gymnasium_release_notes/">Gymnasium Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../gym_release_notes/">Gym Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main-container">
|
||
|
||
|
||
|
||
|
||
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container"><div class="edit-this-page">
|
||
<a class="muted-link" href="https://github.com/Farama-Foundation/Gymnasium/edit/main/docs/environments/atari.md" title="Edit this page">
|
||
<svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
|
||
<line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
|
||
</svg>
|
||
<span class="visually-hidden">Edit this page</span>
|
||
</a>
|
||
</div><div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle" title="Toggle color theme">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto">
|
||
<use href="#svg-sun-half"></use>
|
||
</svg>
|
||
<svg class="theme-icon-when-dark">
|
||
<use href="#svg-moon"></use>
|
||
</svg>
|
||
<svg class="theme-icon-when-light">
|
||
<use href="#svg-sun"></use>
|
||
</svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg>
|
||
<use href="#svg-toc"></use>
|
||
</svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
|
||
<section class="tex2jax_ignore mathjax_ignore" id="atari">
|
||
<h1>Atari<a class="headerlink" href="#atari" title="Link to this heading">¶</a></h1>
|
||
<p>A set of Atari 2600 environments simulated through <a class="reference external" href="https://github.com/stella-emu/stella">Stella</a> and the <a class="reference external" href="https://github.com/mgbellemare/Arcade-Learning-Environment">Arcade Learning Environment</a>.</p>
|
||
<div class="toctree-wrapper compound">
|
||
</div>
|
||
|
||
<div class="env-grid">
|
||
|
||
<a href="adventure">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/adventure.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Adventure</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="air_raid">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/air_raid.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Air Raid</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="alien">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/alien.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Alien</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="amidar">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/amidar.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Amidar</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="assault">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/assault.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Assault</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="asterix">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/asterix.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Asterix</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="asteroids">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/asteroids.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Asteroids</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
<a href="atlantis">
|
||
<div class="env-grid__cell">
|
||
<div class="cell__image-container">
|
||
<img src="/_static/videos/atari/atlantis.gif">
|
||
</div>
|
||
<div class="cell__title">
|
||
<span>Atlantis</span>
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
</div>
|
||
|
||
<a href="./complete_list">
|
||
<button class="more-btn">
|
||
See More Environments
|
||
</button>
|
||
</a>
|
||
|
||
<p>Atari environments are simulated via the Arcade Learning Environment (ALE) <a class="reference internal" href="#1"><span class="xref myst">[1]</span></a> through the Stella emulator.</p>
|
||
<section id="autorom-installing-the-roms">
|
||
<h2>AutoROM (installing the ROMs)<a class="headerlink" href="#autorom-installing-the-roms" title="Link to this heading">¶</a></h2>
|
||
<p>ALE-py doesn’t include the atari ROMs (<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">gymnasium[atari]</span></code>) which are necessary to make any of the atari environments.
|
||
To install the atari ROM, use <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">gymnasium[accept-rom-license]</span></code> which will install AutoROM and download the ROMs, install them in the default location.
|
||
In doing so, you agree to own a license to these Atari 2600 ROMs and agree to not distribution these ROMS.</p>
|
||
<p>It is possible to install the ROMs in an alternative location, <a class="reference external" href="https://github.com/Farama-Foundation/AutoROM">AutoROM</a> has more information.</p>
|
||
</section>
|
||
<section id="action-space">
|
||
<h2>Action Space<a class="headerlink" href="#action-space" title="Link to this heading">¶</a></h2>
|
||
<p>Each environment will use a sub-set of the full action space listed below:</p>
|
||
<div class="table-wrapper colwidths-auto docutils container">
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Value</p></th>
|
||
<th class="head"><p>Meaning</p></th>
|
||
<th class="head"><p>Value</p></th>
|
||
<th class="head"><p>Meaning</p></th>
|
||
<th class="head"><p>Value</p></th>
|
||
<th class="head"><p>Meaning</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">NOOP</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">FIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">2</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UP</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">3</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">RIGHT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">LEFT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">5</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWN</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">6</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UPRIGHT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">7</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UPLEFT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">8</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWNRIGHT</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">9</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWNLEFT</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">10</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UPFIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">11</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">RIGHTFIRE</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">12</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">LEFTFIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">13</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWNFIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">14</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UPRIGHTFIRE</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">15</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">UPLEFTFIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">16</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWNRIGHTFIRE</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">17</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">DOWNLEFTFIRE</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p>By default, most environments use a smaller subset of the legal actions excluding any actions that don’t have an effect in the game.
|
||
If users are interested in using all possible actions, pass the keyword argument <code class="docutils literal notranslate"><span class="pre">full_action_space=True</span></code> to <code class="docutils literal notranslate"><span class="pre">gymnasium.make</span></code>.</p>
|
||
</section>
|
||
<section id="observation-space">
|
||
<h2>Observation Space<a class="headerlink" href="#observation-space" title="Link to this heading">¶</a></h2>
|
||
<p>The Atari environments observation can be</p>
|
||
<ol class="arabic simple">
|
||
<li><p>The RGB image that is displayed to a human player using <code class="docutils literal notranslate"><span class="pre">obs_type="rgb"</span></code> with observation space <code class="docutils literal notranslate"><span class="pre">Box(0,</span> <span class="pre">255,</span> <span class="pre">(210,</span> <span class="pre">160,</span> <span class="pre">3),</span> <span class="pre">np.uint8)</span></code></p></li>
|
||
<li><p>The grayscale version of the RGB image using <code class="docutils literal notranslate"><span class="pre">obs_type="grayscale"</span></code> with observation space <code class="docutils literal notranslate"><span class="pre">Box(0,</span> <span class="pre">255,</span> <span class="pre">(210,</span> <span class="pre">160),</span> <span class="pre">np.uint8)</span></code></p></li>
|
||
<li><p>The RAM state (128 bytes) from the console using <code class="docutils literal notranslate"><span class="pre">obs_type="ram"</span></code> with observation space <code class="docutils literal notranslate"><span class="pre">Box(0,</span> <span class="pre">255,</span> <span class="pre">(128),</span> <span class="pre">np.uint8)</span></code></p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="rewards">
|
||
<h2>Rewards<a class="headerlink" href="#rewards" title="Link to this heading">¶</a></h2>
|
||
<p>The exact reward dynamics depend on the environment and are usually documented in the game’s manual. You can
|
||
find these manuals on <a class="reference external" href="https://atariage.com/">AtariAge</a>.</p>
|
||
</section>
|
||
<section id="stochasticity">
|
||
<h2>Stochasticity<a class="headerlink" href="#stochasticity" title="Link to this heading">¶</a></h2>
|
||
<p>As the Atari games are entirely deterministic, agents could achieve
|
||
state-of-the-art performance by simply memorizing an optimal sequence of actions while completely ignoring observations from the environment.</p>
|
||
<p>To avoid this, there are several methods to avoid this.</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Sticky actions: Instead of always simulating the action passed to the environment, there is a small
|
||
probability that the previously executed action is used instead. In the v0 and v5 environments, the probability of
|
||
repeating an action is <code class="docutils literal notranslate"><span class="pre">25%</span></code> while in v4 environments, the probability is <code class="docutils literal notranslate"><span class="pre">0%</span></code>. Users can specify the repeat action
|
||
probability using <code class="docutils literal notranslate"><span class="pre">repeat_action_probability</span></code> to <code class="docutils literal notranslate"><span class="pre">make</span></code>.</p></li>
|
||
<li><p>Frameskipping: On each environment step, the action can be repeated for a random number of frames. This behavior
|
||
may be altered by setting the keyword argument <code class="docutils literal notranslate"><span class="pre">frameskip</span></code> to either a positive integer or
|
||
a tuple of two positive integers. If <code class="docutils literal notranslate"><span class="pre">frameskip</span></code> is an integer, frame skipping is deterministic, and in each step the action is
|
||
repeated <code class="docutils literal notranslate"><span class="pre">frameskip</span></code> many times. Otherwise, if <code class="docutils literal notranslate"><span class="pre">frameskip</span></code> is a tuple, the number of skipped frames is chosen uniformly at
|
||
random between <code class="docutils literal notranslate"><span class="pre">frameskip[0]</span></code> (inclusive) and <code class="docutils literal notranslate"><span class="pre">frameskip[1]</span></code> (exclusive) in each environment step.</p></li>
|
||
</ol>
|
||
</section>
|
||
<section id="common-arguments">
|
||
<h2>Common Arguments<a class="headerlink" href="#common-arguments" title="Link to this heading">¶</a></h2>
|
||
<p>When initializing Atari environments via <code class="docutils literal notranslate"><span class="pre">gymnasium.make</span></code>, you may pass some additional arguments. These work for any
|
||
Atari environment.</p>
|
||
<ul class="simple">
|
||
<li><p><strong>mode</strong>: <code class="docutils literal notranslate"><span class="pre">int</span></code>. Game mode, see <a class="reference internal" href="#2"><span class="xref myst">[2]</span></a>. Legal values depend on the environment and are listed in the table above.</p></li>
|
||
<li><p><strong>difficulty</strong>: <code class="docutils literal notranslate"><span class="pre">int</span></code>. The difficulty of the game, see <a class="reference internal" href="#2"><span class="xref myst">[2]</span></a>. Legal values depend on the environment and are listed in
|
||
the table above. Together with <code class="docutils literal notranslate"><span class="pre">mode</span></code>, this determines the “flavor” of the game.</p></li>
|
||
<li><p><strong>obs_type</strong>: <code class="docutils literal notranslate"><span class="pre">str</span></code>. This argument determines what observations are returned by the environment. Its values are:</p>
|
||
<ul>
|
||
<li><p>“ram”: The 128 Bytes of RAM are returned</p></li>
|
||
<li><p>“rgb”: An RGB rendering of the game is returned</p></li>
|
||
<li><p>“grayscale”: A grayscale rendering is returned</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><strong>frameskip</strong>: <code class="docutils literal notranslate"><span class="pre">int</span></code> or a tuple of two <code class="docutils literal notranslate"><span class="pre">int</span></code>s. This argument controls stochastic frame skipping, as described in the section on stochasticity.</p></li>
|
||
<li><p><strong>repeat_action_probability</strong>: <code class="docutils literal notranslate"><span class="pre">float</span></code>. The probability that an action is repeated, also called “sticky actions”, as described in the section on stochasticity.</p></li>
|
||
<li><p><strong>full_action_space</strong>: <code class="docutils literal notranslate"><span class="pre">bool</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the action space consists of all legal actions on the console. Otherwise, the
|
||
action space will be reduced to a subset.</p></li>
|
||
<li><p><strong>render_mode</strong>: <code class="docutils literal notranslate"><span class="pre">str</span></code>. Specifies the rendering mode. Its values are:</p>
|
||
<ul>
|
||
<li><p>human: Display the screen and enable game sounds. This will lock emulation to the ROMs specified FPS</p></li>
|
||
<li><p>rgb_array: Returns the current environment RGB frame of the environment.</p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
<section id="version-history-and-naming-schemes">
|
||
<h2>Version History and Naming Schemes<a class="headerlink" href="#version-history-and-naming-schemes" title="Link to this heading">¶</a></h2>
|
||
<p>All Atari games are available in three versions. They differ in the default settings of the arguments above.
|
||
The differences are listed in the following table:</p>
|
||
<div class="table-wrapper colwidths-auto docutils container">
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Version</p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">frameskip=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">repeat_action_probability=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">full_action_space=</span></code></p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>v0</p></td>
|
||
<td><p>Varies with the suffix (see below).</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>v4</p></td>
|
||
<td><p>Varies with the suffix (see below).</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>v5</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">False</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>Version v5 follows the best practices outlined in <a class="reference internal" href="#2"><span class="xref myst">[2]</span></a>. Thus, it is recommended to transition to v5 and
|
||
customize the environment using the arguments above, if necessary.</p>
|
||
</div></blockquote>
|
||
<p>For each Atari game, several different configurations are registered in Gymnasium. The naming schemes are analogous for
|
||
v0 and v4. Let us take a look at all variations of Amidar-v0 that are registered with gymnasium:</p>
|
||
<div class="table-wrapper colwidths-auto docutils container">
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Name</p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">obs_type=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">frameskip=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">repeat_action_probability=</span></code></p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>Amidar-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"rgb"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">(2,</span> <span class="pre">5,)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AmidarDeterministic-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"rgb"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>AmidarNoframeskip-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"rgb"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Amidar-ram-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"ram"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">(2,</span> <span class="pre">5,)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Amidar-ramDeterministic-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"ram"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.0</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Amidar-ramNoframeskip-v0</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"ram"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">1</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<p>Things change in v5: The suffixes “Deterministic” and “NoFrameskip” are no longer available. Instead, you must specify the
|
||
environment configuration via arguments passed to <code class="docutils literal notranslate"><span class="pre">gymnasium.make</span></code>. Moreover, the v5 environments
|
||
are in the “ALE” namespace. The suffix “-ram” is still available. Thus, we get the following table:</p>
|
||
<div class="table-wrapper colwidths-auto docutils container">
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Name</p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">obs_type=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">frameskip=</span></code></p></th>
|
||
<th class="head"><p><code class="docutils literal notranslate"><span class="pre">repeat_action_probability=</span></code></p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>ALE/Amidar-v5</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"rgb"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>ALE/Amidar-ram-v5</p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">"ram"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">4</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">0.25</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
<section id="flavors">
|
||
<h2>Flavors<a class="headerlink" href="#flavors" title="Link to this heading">¶</a></h2>
|
||
<p>Some games allow the user to set a difficulty level and a game mode. Different modes/difficulties may have different
|
||
game dynamics and (if a reduced action space is used) different action spaces. We follow the convention of <a class="reference internal" href="#2"><span class="xref myst">[2]</span></a> and
|
||
refer to the combination of difficulty level and game mode as a flavor of a game. The following table shows
|
||
the available modes and difficulty levels for different Atari games:</p>
|
||
<div class="table-wrapper colwidths-auto docutils container">
|
||
<table class="docutils align-default">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Environment</p></th>
|
||
<th class="head"><p>Possible Modes</p></th>
|
||
<th class="head"><p>Default Mode</p></th>
|
||
<th class="head"><p>Possible Difficulties</p></th>
|
||
<th class="head"><p>Default Difficulty</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>Adventure</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>AirRaid</p></td>
|
||
<td><p>[1, …, 8]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Alien</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Amidar</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Assault</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Asterix</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Asteroids</p></td>
|
||
<td><p>[0, …, 31, 128]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Atlantis</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Atlantis2</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Backgammon</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>BankHeist</p></td>
|
||
<td><p>[0, 4, 8, 12, 16, 20, 24, 28]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>BasicMath</p></td>
|
||
<td><p>[5, 6, 7, 8]</p></td>
|
||
<td><p>5</p></td>
|
||
<td><p>[0, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>BattleZone</p></td>
|
||
<td><p>[1, 2, 3]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>BeamRider</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Berzerk</p></td>
|
||
<td><p>[1, …, 9, 16, 17, 18]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Blackjack</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Bowling</p></td>
|
||
<td><p>[0, 2, 4]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Boxing</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Breakout</p></td>
|
||
<td><p>[0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Carnival</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Casino</p></td>
|
||
<td><p>[0, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Centipede</p></td>
|
||
<td><p>[22, 86]</p></td>
|
||
<td><p>22</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>ChopperCommand</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>CrazyClimber</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Crossbow</p></td>
|
||
<td><p>[0, 2, 4, 6]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Darkchambers</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Defender</p></td>
|
||
<td><p>[1, …, 9, 16]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>DemonAttack</p></td>
|
||
<td><p>[1, 3, 5, 7]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>DonkeyKong</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>DoubleDunk</p></td>
|
||
<td><p>[0, …, 15]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Earthworld</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>ElevatorAction</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Enduro</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Entombed</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Et</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>FishingDerby</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>FlagCapture</p></td>
|
||
<td><p>[8, 9, 10]</p></td>
|
||
<td><p>8</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Freeway</p></td>
|
||
<td><p>[0, …, 7]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Frogger</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Frostbite</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Galaxian</p></td>
|
||
<td><p>[1, …, 9]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Gopher</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Gravitar</p></td>
|
||
<td><p>[0, 1, 2, 3, 4]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Hangman</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>HauntedHouse</p></td>
|
||
<td><p>[0, …, 8]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Hero</p></td>
|
||
<td><p>[0, 1, 2, 3, 4]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>HumanCannonball</p></td>
|
||
<td><p>[0, …, 7]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>IceHockey</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Jamesbond</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>JourneyEscape</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Kaboom</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Kangaroo</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>KeystoneKapers</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>KingKong</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Klax</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Koolaid</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Krull</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>KungFuMaster</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>LaserGates</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>LostLuggage</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>MarioBros</p></td>
|
||
<td><p>[0, 2, 4, 6]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>MiniatureGolf</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>MontezumaRevenge</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>MrDo</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>MsPacman</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>NameThisGame</p></td>
|
||
<td><p>[8, 24, 40]</p></td>
|
||
<td><p>8</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Othello</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Pacman</p></td>
|
||
<td><p>[0, …, 7]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Phoenix</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Pitfall</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Pitfall2</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Pong</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Pooyan</p></td>
|
||
<td><p>[10, 30, 50, 70]</p></td>
|
||
<td><p>10</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>PrivateEye</p></td>
|
||
<td><p>[0, 1, 2, 3, 4]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Qbert</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Riverraid</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>RoadRunner</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Robotank</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Seaquest</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>SirLancelot</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Skiing</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Solaris</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>SpaceInvaders</p></td>
|
||
<td><p>[0, …, 15]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>SpaceWar</p></td>
|
||
<td><p>[6, …, 17]</p></td>
|
||
<td><p>6</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>StarGunner</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Superman</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Surround</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Tennis</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Tetris</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>TicTacToe3D</p></td>
|
||
<td><p>[0, …, 8]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>TimePilot</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Trondead</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>Turmoil</p></td>
|
||
<td><p>[0, …, 8]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Tutankham</p></td>
|
||
<td><p>[0, 4, 8, 12]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>UpNDown</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Venture</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>VideoCheckers</p></td>
|
||
<td><p>[1, …, 9, 11, …, 19]</p></td>
|
||
<td><p>1</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>VideoChess</p></td>
|
||
<td><p>[0, 1, 2, 3, 4]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>VideoCube</p></td>
|
||
<td><p>[0, 1, 2, 100, 101, 102, …, 5000, 5001, 5002]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>VideoPinball</p></td>
|
||
<td><p>[0, 2]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>WizardOfWor</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>WordZapper</p></td>
|
||
<td><p>[0, …, 23]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1, 2, 3]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>YarsRevenge</p></td>
|
||
<td><p>[0, 32, 64, 96]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0, 1]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>Zaxxon</p></td>
|
||
<td><p>[0, 8, 16, 24]</p></td>
|
||
<td><p>0</p></td>
|
||
<td><p>[0]</p></td>
|
||
<td><p>0</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
<section id="references">
|
||
<h2>References<a class="headerlink" href="#references" title="Link to this heading">¶</a></h2>
|
||
<p id="id1"><a id="1">[1]</a>
|
||
MG Bellemare, Y Naddaf, J Veness, and M Bowling.
|
||
“The arcade learning environment: An evaluation platform for general agents.”
|
||
Journal of Artificial Intelligence Research (2012).</p>
|
||
<p id="id2"><a id="2">[2]</a>
|
||
Machado et al.
|
||
“Revisiting the Arcade Learning Environment: Evaluation Protocols
|
||
and Open Problems for General Agents”
|
||
Journal of Artificial Intelligence Research (2018)
|
||
URL: https://jair.org/index.php/jair/article/view/11182</p>
|
||
</section>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
|
||
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2023 Farama Foundation
|
||
</div>
|
||
<!--
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
-->
|
||
</div>
|
||
<div class="right-details">
|
||
<div class="icons">
|
||
<a class="muted-link" href="https://github.com/Farama-Foundation/Gymnasium/"
|
||
aria-label="On GitHub">
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
|
||
<path fill-rule="evenodd"
|
||
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">
|
||
</path>
|
||
</svg>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
On this page
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Atari</a><ul>
|
||
<li><a class="reference internal" href="#autorom-installing-the-roms">AutoROM (installing the ROMs)</a></li>
|
||
<li><a class="reference internal" href="#action-space">Action Space</a></li>
|
||
<li><a class="reference internal" href="#observation-space">Observation Space</a></li>
|
||
<li><a class="reference internal" href="#rewards">Rewards</a></li>
|
||
<li><a class="reference internal" href="#stochasticity">Stochasticity</a></li>
|
||
<li><a class="reference internal" href="#common-arguments">Common Arguments</a></li>
|
||
<li><a class="reference internal" href="#version-history-and-naming-schemes">Version History and Naming Schemes</a></li>
|
||
<li><a class="reference internal" href="#flavors">Flavors</a></li>
|
||
<li><a class="reference internal" href="#references">References</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<script>
|
||
const toggleMenu = () => {
|
||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||
menuBtn.setAttribute("aria-expanded", "false");
|
||
menuContainer.setAttribute("aria-hidden", "true");
|
||
} else {
|
||
menuBtn.setAttribute("aria-expanded", "true");
|
||
menuContainer.setAttribute("aria-hidden", "false");
|
||
}
|
||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||
}
|
||
|
||
document.querySelector(".farama-header-menu__btn").addEventListener("click", toggleMenu);
|
||
document.getElementById("farama-close-menu").addEventListener("click", toggleMenu);
|
||
</script>
|
||
|
||
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-6H9C8TWXZ8"></script>
|
||
<script>
|
||
const enableGtag = () => {
|
||
window.dataLayer = window.dataLayer || [];
|
||
function gtag(){dataLayer.push(arguments);}
|
||
gtag('js', new Date());
|
||
gtag('config', 'G-6H9C8TWXZ8');
|
||
}
|
||
(() => {
|
||
if (!localStorage.getItem("acceptedCookieAlert")) {
|
||
const boxElem = document.createElement("div");
|
||
boxElem.classList.add("cookie-alert");
|
||
const containerElem = document.createElement("div");
|
||
containerElem.classList.add("cookie-alert__container");
|
||
const textElem = document.createElement("p");
|
||
textElem.innerHTML = `This page uses <a href="https://analytics.google.com/">
|
||
Google Analytics</a> to collect statistics.`;
|
||
containerElem.appendChild(textElem);
|
||
|
||
const declineBtn = Object.assign(document.createElement("button"),
|
||
{
|
||
innerText: "Deny",
|
||
className: "farama-btn cookie-alert__button",
|
||
id: "cookie-alert__decline",
|
||
}
|
||
);
|
||
declineBtn.addEventListener("click", () => {
|
||
localStorage.setItem("acceptedCookieAlert", false);
|
||
boxElem.remove();
|
||
});
|
||
|
||
const acceptBtn = Object.assign(document.createElement("button"),
|
||
{
|
||
innerText: "Allow",
|
||
className: "farama-btn cookie-alert__button",
|
||
id: "cookie-alert__accept",
|
||
}
|
||
);
|
||
acceptBtn.addEventListener("click", () => {
|
||
localStorage.setItem("acceptedCookieAlert", true);
|
||
boxElem.remove();
|
||
enableGtag();
|
||
});
|
||
|
||
containerElem.appendChild(declineBtn);
|
||
containerElem.appendChild(acceptBtn);
|
||
boxElem.appendChild(containerElem);
|
||
document.body.appendChild(boxElem);
|
||
} else if (localStorage.getItem("acceptedCookieAlert") === "true") {
|
||
enableGtag();
|
||
}
|
||
})()
|
||
</script>
|
||
|
||
<script src="../../_static/documentation_options.js?v=ed34540e"></script>
|
||
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../../_static/scripts/furo.js?v=7660844c"></script>
|
||
|
||
<script>
|
||
|
||
const createProjectsList = (projects, displayImages) => {
|
||
const ulElem = Object.assign(document.createElement('ul'),
|
||
{
|
||
className:'farama-header-menu-list',
|
||
}
|
||
)
|
||
for (let project of projects) {
|
||
const liElem = document.createElement("li");
|
||
const aElem = Object.assign(document.createElement("a"),
|
||
{
|
||
href: project.link
|
||
}
|
||
);
|
||
liElem.appendChild(aElem);
|
||
if (displayImages) {
|
||
const imgElem = Object.assign(document.createElement("img"),
|
||
{
|
||
src: project.image ? imagesBasepath + project.image : imagesBasepath + "/farama_black.svg",
|
||
alt: `${project.name} logo`,
|
||
className: "farama-black-logo-invert"
|
||
}
|
||
);
|
||
aElem.appendChild(imgElem);
|
||
}
|
||
aElem.appendChild(document.createTextNode(project.name));
|
||
ulElem.appendChild(liElem);
|
||
}
|
||
return ulElem;
|
||
}
|
||
|
||
// Create menu with Farama projects by using the API at farama.org/api/projects.json
|
||
const createCORSRequest = (method, url) => {
|
||
let xhr = new XMLHttpRequest();
|
||
xhr.responseType = 'json';
|
||
|
||
if ("withCredentials" in xhr) {
|
||
xhr.open(method, url, true);
|
||
} else if (typeof XDomainRequest != "undefined") {
|
||
// IE8 & IE9
|
||
xhr = new XDomainRequest();
|
||
xhr.open(method, url);
|
||
} else {
|
||
// CORS not supported.
|
||
xhr = null;
|
||
}
|
||
return xhr;
|
||
};
|
||
|
||
const url = 'https://farama.org/api/projects.json';
|
||
const imagesBasepath = "https://farama.org/assets/images"
|
||
const method = 'GET';
|
||
let xhr = createCORSRequest(method, url);
|
||
|
||
xhr.onload = () => {
|
||
const jsonResponse = xhr.response;
|
||
const sections = {
|
||
"Core Projects": [],
|
||
"Mature Projects": {
|
||
"Documentation": [],
|
||
"Repositories": [],
|
||
},
|
||
"Incubating Projects": {
|
||
"Documentation": [],
|
||
"Repositories": [],
|
||
},
|
||
"Foundation": [
|
||
{
|
||
name: "About",
|
||
link: "https://farama.org/about"
|
||
},
|
||
{
|
||
name: "Standards",
|
||
link: "https://farama.org/project_standards",
|
||
},
|
||
{
|
||
name: "Donate",
|
||
link: "https://farama.org/donations"
|
||
}
|
||
]
|
||
}
|
||
|
||
// Categorize projects
|
||
Object.keys(jsonResponse).forEach(key => {
|
||
projectJson = jsonResponse[key];
|
||
if (projectJson.website !== null) {
|
||
projectJson.link = projectJson.website;
|
||
} else {
|
||
projectJson.link = projectJson.github;
|
||
}
|
||
if (projectJson.type === "core") {
|
||
sections["Core Projects"].push(projectJson)
|
||
} else if (projectJson.type == "mature") {
|
||
if (projectJson.website !== null) {
|
||
sections["Mature Projects"]["Documentation"].push(projectJson)
|
||
} else {
|
||
sections["Mature Projects"]["Repositories"].push(projectJson)
|
||
}
|
||
} else {
|
||
if (projectJson.website !== null) {
|
||
sections["Incubating Projects"]["Documentation"].push(projectJson)
|
||
} else {
|
||
sections["Incubating Projects"]["Repositories"].push(projectJson)
|
||
}
|
||
}
|
||
})
|
||
|
||
const menuContainer = document.querySelector(".farama-header-menu__body");
|
||
|
||
Object.keys(sections).forEach((key, i) => {
|
||
const sectionElem = Object.assign(
|
||
document.createElement('div'), {
|
||
className:'farama-header-menu__section',
|
||
}
|
||
)
|
||
sectionElem.appendChild(Object.assign(document.createElement('span'),
|
||
{
|
||
className:'farama-header-menu__section-title' ,
|
||
innerText: key
|
||
}
|
||
))
|
||
// is not a list
|
||
if (sections[key].constructor !== Array) {
|
||
const subSections = sections[key];
|
||
const subSectionContainerElem = Object.assign(
|
||
document.createElement('div'), {
|
||
className:'farama-header-menu__subsections-container',
|
||
style: 'display: flex'
|
||
}
|
||
)
|
||
Object.keys(subSections).forEach((subKey, i) => {
|
||
const subSectionElem = Object.assign(
|
||
document.createElement('div'), {
|
||
className:'farama-header-menu__subsection',
|
||
}
|
||
)
|
||
subSectionElem.appendChild(Object.assign(document.createElement('span'),
|
||
{
|
||
className:'farama-header-menu__subsection-title' ,
|
||
innerText: subKey
|
||
}
|
||
))
|
||
const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
|
||
subSectionElem.appendChild(ulElem);
|
||
subSectionContainerElem.appendChild(subSectionElem);
|
||
})
|
||
sectionElem.appendChild(subSectionContainerElem);
|
||
} else {
|
||
const projects = sections[key];
|
||
const ulElem = createProjectsList(projects, true);
|
||
sectionElem.appendChild(ulElem);
|
||
}
|
||
menuContainer.appendChild(sectionElem)
|
||
});
|
||
}
|
||
|
||
xhr.onerror = function() {
|
||
console.error("Unable to load projects");
|
||
};
|
||
|
||
xhr.send();
|
||
</script>
|
||
|
||
|
||
<script>
|
||
const versioningConfig = {
|
||
githubUser: 'Farama-Foundation',
|
||
githubRepo: 'Gymnasium',
|
||
};
|
||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||
if (response.status === 200) {
|
||
response.text().then(text => {
|
||
const container = document.createElement("div");
|
||
container.innerHTML = text;
|
||
document.querySelector("body").appendChild(container);
|
||
// innerHtml doenst evaluate scripts, we need to add them dynamically
|
||
Array.from(container.querySelectorAll("script")).forEach(oldScript => {
|
||
const newScript = document.createElement("script");
|
||
Array.from(oldScript.attributes).forEach(attr => newScript.setAttribute(attr.name, attr.value));
|
||
newScript.appendChild(document.createTextNode(oldScript.innerHTML));
|
||
oldScript.parentNode.replaceChild(newScript, oldScript);
|
||
});
|
||
});
|
||
} else {
|
||
console.warn("Unable to load versioning menu", response);
|
||
}
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |