Gymnasium/api/spaces/index.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/api/spaces.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="Fundamental Spaces" href="fundamental/" /><link rel="prev" title="Make and register" href="../registry/" />
        <link rel="canonical" href="https://gymnasium.farama.org/api/spaces.html" />

    <link rel="shortcut icon" href="../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
        <title>Spaces - Gymnasium Documentation</title>
      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
    <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=82c8b628" />
    
    
<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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../env/">Env</a></li>
<li class="toctree-l1"><a class="reference internal" href="../registry/">Make and register</a></li>
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Spaces</a><input checked="" 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="fundamental/">Fundamental Spaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="composite/">Composite Spaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/">Spaces Utils</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../wrappers/table/">List of Wrappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../wrappers/misc_wrappers/">Misc Wrappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../wrappers/action_wrappers/">Action Wrappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../wrappers/observation_wrappers/">Observation Wrappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../wrappers/reward_wrappers/">Reward Wrappers</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../vector/wrappers/">Wrappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vector/async_vector_env/">AsyncVectorEnv</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vector/sync_vector_env/">SyncVectorEnv</a></li>
<li class="toctree-l2"><a class="reference internal" href="../vector/utils/">Utility functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../utils/">Utility functions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../functional/">Functional Env</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
<ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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="../../environments/classic_control/acrobot/">Acrobot</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/cart_pole/">Cart Pole</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/mountain_car_continuous/">Mountain Car Continuous</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/mountain_car/">Mountain Car</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/pendulum/">Pendulum</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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="../../environments/box2d/bipedal_walker/">Bipedal Walker</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/box2d/car_racing/">Car Racing</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/box2d/lunar_lander/">Lunar Lander</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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="../../environments/toy_text/blackjack/">Blackjack</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/taxi/">Taxi</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/cliff_walking/">Cliff Walking</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/frozen_lake/">Frozen Lake</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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="../../environments/mujoco/ant/">Ant</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/half_cheetah/">Half Cheetah</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/hopper/">Hopper</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/humanoid/">Humanoid</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/humanoid_standup/">Humanoid Standup</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/inverted_double_pendulum/">Inverted Double Pendulum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/inverted_pendulum/">Inverted Pendulum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/pusher/">Pusher</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/reacher/">Reacher</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/swimmer/">Swimmer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/walker2d/">Walker2D</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../environments/atari/">Atari</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../environments/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 Documentation Links</a><input 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 Gymnasium Basics Documentation Links</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 links in the Gymnasium Documentation</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 Training Agents links in the Gymnasium Documentation</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>
</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 external" href="https://arxiv.org/abs/2407.17032">Paper</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/api/spaces.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="spaces">
<h1>Spaces<a class="headerlink" href="#spaces" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
</div>
<p id="module-gymnasium.spaces">This module implements various spaces.</p>
<p>Spaces describe mathematical sets and are used in Gym to specify valid actions and observations.
Every Gym environment must have the attributes <code class="docutils literal notranslate"><span class="pre">action_space</span></code> and <code class="docutils literal notranslate"><span class="pre">observation_space</span></code>.
If, for instance, three possible actions (0,1,2) can be performed in your environment and observations
are vectors in the two-dimensional unit cube, the environment code may contain the following two lines:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">action_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,))</span>
</pre></div>
</div>
<p>All spaces inherit from the <a class="reference internal" href="#gymnasium.spaces.Space" title="gymnasium.spaces.Space"><code class="xref py py-class docutils literal notranslate"><span class="pre">Space</span></code></a> superclass.</p>
<dl class="py class">
<dt class="sig sig-object py" id="gymnasium.spaces.Space">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.spaces.</span></span><span class="sig-name descname"><span class="pre">Space</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">npt.DTypeLike</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">np.random.Generator</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space" title="Link to this definition">¶</a></dt>
<dd><p>Superclass that is used to define observation and action spaces.</p>
<p>Spaces are crucially used in Gym to define the format of valid actions and observations.
They serve various purposes:</p>
<ul class="simple">
<li><p>They clearly define how to interact with environments, i.e. they specify what actions need to look like
and what observations will look like</p></li>
<li><p>They allow us to work with highly structured data (e.g. in the form of elements of <a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a> spaces)
and painlessly transform them into flat arrays that can be used in learning code</p></li>
<li><p>They provide a method to sample random elements. This is especially useful for exploration and debugging.</p></li>
</ul>
<p>Different spaces can be combined hierarchically via container spaces (<a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> and <a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>) to build a
more expressive space</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Custom observation &amp; action spaces can inherit from the <code class="docutils literal notranslate"><span class="pre">Space</span></code>
class. However, most use-cases should be covered by the existing space
classes (e.g. <a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code></a>, <a class="reference internal" href="fundamental/#gymnasium.spaces.Discrete" title="gymnasium.spaces.Discrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">Discrete</span></code></a>, etc…), and container classes (<a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> &amp;
<a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>). Note that parametrized probability distributions (through the
<a class="reference internal" href="#gymnasium.spaces.Space.sample" title="gymnasium.spaces.Space.sample"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Space.sample()</span></code></a> method), and batching functions (in <code class="xref py py-class docutils literal notranslate"><span class="pre">gym.vector.VectorEnv</span></code>), are
only well-defined for instances of spaces provided in gym by default.
Moreover, some implementations of Reinforcement Learning algorithms might
not handle custom spaces properly. Use custom spaces with care.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>shape</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><em>Sequence</em></a><em>[</em><em>int</em><em>]</em><em>]</em>) – If elements of the space are numpy arrays, this should specify their shape.</p></li>
<li><p><strong>dtype</strong> (<em>Optional</em><em>[</em><em>Type</em><em> | </em><em>str</em><em>]</em>) – If elements of the space are numpy arrays, this should specify their dtype.</p></li>
<li><p><strong>seed</strong> – Optionally, you can use this argument to seed the RNG that is used to sample from the space</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<section id="attributes">
<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2>
<dl class="py property">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.shape">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">shape</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#gymnasium.spaces.Space.shape" title="Link to this definition">¶</a></dt>
<dd><p>Return the shape of the space as an immutable property.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.dtype">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">dtype</span></span><a class="headerlink" href="#gymnasium.spaces.Space.dtype" title="Link to this definition">¶</a></dt>
<dd><p>Return the data type of this space.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.is_np_flattenable">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">is_np_flattenable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#gymnasium.spaces.Space.is_np_flattenable" title="Link to this definition">¶</a></dt>
<dd><p>Checks whether this space can be flattened to a <a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">gymnasium.spaces.Box</span></code></a>.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.np_random">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">np_random</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Generator</span></em><a class="headerlink" href="#gymnasium.spaces.Space.np_random" title="Link to this definition">¶</a></dt>
<dd><p>Lazily seed the PRNG since this is expensive and only needed if sampling from this space.</p>
<p>As <a class="reference internal" href="#gymnasium.spaces.Space.seed" title="gymnasium.spaces.Space.seed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seed()</span></code></a> is not guaranteed to set the <cite>_np_random</cite> for particular seeds. We add a
check after <a class="reference internal" href="#gymnasium.spaces.Space.seed" title="gymnasium.spaces.Space.seed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seed()</span></code></a> to set a new random number generator.</p>
</dd></dl>

</section>
<section id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶</a></h2>
<p>Each space implements the following functions:</p>
<dl class="py method">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.sample">
<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mask</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">probability</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T_cov</span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.sample" title="Link to this definition">¶</a></dt>
<dd><p>Randomly sample an element of this space.</p>
<p>Can be uniform or non-uniform sampling based on boundedness of space.</p>
<p>The binary mask and the probability mask can’t be used at the same time.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mask</strong> – A mask used for random sampling, expected <code class="docutils literal notranslate"><span class="pre">dtype=np.int8</span></code> and see sample implementation for expected shape.</p></li>
<li><p><strong>probability</strong> – A probability mask used for sampling according to the given probability distribution, expected <code class="docutils literal notranslate"><span class="pre">dtype=np.float64</span></code> and see sample implementation for expected shape.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>A sampled actions from the space</strong></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.contains">
<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.contains"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.contains" title="Link to this definition">¶</a></dt>
<dd><p>Return boolean specifying if x is a valid member of this space, equivalent to <code class="docutils literal notranslate"><span class="pre">sample</span> <span class="pre">in</span> <span class="pre">space</span></code>.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.seed">
<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">seed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.seed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.seed" title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>seed</strong> – The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.to_jsonable">
<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">to_jsonable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">T_cov</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.to_jsonable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.to_jsonable" title="Link to this definition">¶</a></dt>
<dd><p>Convert a batch of samples from this space to a JSONable data type.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="gymnasium.spaces.Space.from_jsonable">
<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">from_jsonable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T_cov</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.from_jsonable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.from_jsonable" title="Link to this definition">¶</a></dt>
<dd><p>Convert a JSONable data type to a batch of samples from this space.</p>
</dd></dl>

</section>
<section id="fundamental-spaces">
<h2>Fundamental Spaces<a class="headerlink" href="#fundamental-spaces" title="Link to this heading">¶</a></h2>
<p>Gymnasium has a number of fundamental spaces that are used as building boxes for more complex spaces.</p>
<ul class="simple">
<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code></a> - Supports continuous (and discrete) vectors or matrices, used for vector observations, images, etc</p></li>
<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Discrete" title="gymnasium.spaces.Discrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">Discrete</span></code></a> - Supports a single discrete number of values with an optional start for the values</p></li>
<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.MultiBinary" title="gymnasium.spaces.MultiBinary"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultiBinary</span></code></a> - Supports single or matrices of binary values, used for holding down a button or if an agent has an object</p></li>
<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.MultiDiscrete" title="gymnasium.spaces.MultiDiscrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultiDiscrete</span></code></a> - Supports multiple discrete values with multiple axes, used for controller actions</p></li>
<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Text" title="gymnasium.spaces.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a> - Supports strings, used for passing agent messages, mission details, etc</p></li>
</ul>
</section>
<section id="composite-spaces">
<h2>Composite Spaces<a class="headerlink" href="#composite-spaces" title="Link to this heading">¶</a></h2>
<p>Often environment spaces require joining fundamental spaces together for vectorised environments, separate agents or readability of the space.</p>
<ul class="simple">
<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a> - Supports a dictionary of keys and subspaces, used for a fixed number of unordered spaces</p></li>
<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> - Supports a tuple of subspaces, used for multiple for a fixed number of ordered spaces</p></li>
<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a> - Supports a variable number of instances of a single subspace, used for entities spaces or selecting a variable number of actions</p></li>
<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Graph" title="gymnasium.spaces.Graph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Graph</span></code></a> - Supports graph based actions or observations with discrete or continuous nodes and edge values</p></li>
<li><p><a class="reference internal" href="composite/#gymnasium.spaces.OneOf" title="gymnasium.spaces.OneOf"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneOf</span></code></a> - Supports optional action spaces such that an action can be one of N possible subspaces</p></li>
</ul>
</section>
<section id="utility-functions">
<h2>Utility functions<a class="headerlink" href="#utility-functions" title="Link to this heading">¶</a></h2>
<p>Gymnasium contains a number of helpful utility functions for flattening and unflattening spaces.
This can be important for passing information to neural networks.</p>
<ul class="simple">
<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatdim" title="gymnasium.spaces.utils.flatdim"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatdim</span></code></a> - The number of dimensions the flattened space will contain</p></li>
<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten_space" title="gymnasium.spaces.utils.flatten_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten_space</span></code></a> - Flattens a space for which the <code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flattened</span></code> space instances will contain</p></li>
<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten" title="gymnasium.spaces.utils.flatten"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten</span></code></a> - Flattens an instance of a space that is contained within the flattened version of the space</p></li>
<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.unflatten" title="gymnasium.spaces.utils.unflatten"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.unflatten</span></code></a> - The reverse of the <a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten_space" title="gymnasium.spaces.utils.flatten_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten_space</span></code></a> function</p></li>
</ul>
</section>
<section id="vector-utility-functions">
<h2>Vector Utility functions<a class="headerlink" href="#vector-utility-functions" title="Link to this heading">¶</a></h2>
<p>When vectorizing environments, it is necessary to modify the observation and action spaces for new batched spaces sizes.
Therefore, Gymnasium provides a number of additional functions used when using a space with a Vector environment.</p>
<ul class="simple">
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.batch_space" title="gymnasium.vector.utils.batch_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.batch_space</span></code></a> - Transforms a space into the equivalent space for <code class="docutils literal notranslate"><span class="pre">n</span></code> users</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.concatenate" title="gymnasium.vector.utils.concatenate"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.concatenate</span></code></a> - Concatenates a space’s samples into a pre-generated space</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.iterate" title="gymnasium.vector.utils.iterate"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.iterate</span></code></a> - Iterate over the batched space’s samples</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.create_empty_array" title="gymnasium.vector.utils.create_empty_array"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.create_empty_array</span></code></a> - Creates an empty sample for an space (generally used with <code class="docutils literal notranslate"><span class="pre">concatenate</span></code>)</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.create_shared_memory" title="gymnasium.vector.utils.create_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.create_shared_memory</span></code></a> - Creates a shared memory for asynchronous (multiprocessing) environment</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.read_from_shared_memory" title="gymnasium.vector.utils.read_from_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.read_from_shared_memory</span></code></a> - Reads a shared memory for asynchronous (multiprocessing) environment</p></li>
<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.write_to_shared_memory" title="gymnasium.vector.utils.write_to_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.write_to_shared_memory</span></code></a> - Write to a shared memory for asynchronous (multiprocessing) environment</p></li>
</ul>
</section>
</section>

          </article>
        </div>
        <footer>
          
          <div class="related-pages">
            <a class="next-page" href="fundamental/">
              <div class="page-info">
                <div class="context">
                  <span>Next</span>
                </div>
                <div class="title">Fundamental Spaces</div>
              </div>
              <svg class="furo-related-icon">
                <use href="#svg-arrow-right"></use>
              </svg>
            </a>
            <a class="prev-page" href="../registry/">
              <svg class="furo-related-icon">
                <use href="#svg-arrow-right"></use>
              </svg>
              <div class="page-info">
                <div class="context">
                  <span>Previous</span>
                </div>
                
                <div class="title">Make and register</div>
                
              </div>
            </a>
          </div>
          <div class="bottom-of-page">
            <div class="left-details">
              <div class="copyright">
                Copyright &#169; 2025 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="#">Spaces</a><ul>
<li><a class="reference internal" href="#gymnasium.spaces.Space"><code class="docutils literal notranslate"><span class="pre">Space</span></code></a></li>
<li><a class="reference internal" href="#attributes">Attributes</a><ul>
<li><a class="reference internal" href="#gymnasium.spaces.Space.shape"><code class="docutils literal notranslate"><span class="pre">Space.shape</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.dtype"><code class="docutils literal notranslate"><span class="pre">Space.dtype</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.is_np_flattenable"><code class="docutils literal notranslate"><span class="pre">Space.is_np_flattenable</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.np_random"><code class="docutils literal notranslate"><span class="pre">Space.np_random</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#methods">Methods</a><ul>
<li><a class="reference internal" href="#gymnasium.spaces.Space.sample"><code class="docutils literal notranslate"><span class="pre">Space.sample()</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.contains"><code class="docutils literal notranslate"><span class="pre">Space.contains()</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.seed"><code class="docutils literal notranslate"><span class="pre">Space.seed()</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.to_jsonable"><code class="docutils literal notranslate"><span class="pre">Space.to_jsonable()</span></code></a></li>
<li><a class="reference internal" href="#gymnasium.spaces.Space.from_jsonable"><code class="docutils literal notranslate"><span class="pre">Space.from_jsonable()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#fundamental-spaces">Fundamental Spaces</a></li>
<li><a class="reference internal" href="#composite-spaces">Composite Spaces</a></li>
<li><a class="reference internal" href="#utility-functions">Utility functions</a></li>
<li><a class="reference internal" href="#vector-utility-functions">Vector Utility functions</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=25d39d6f"></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>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
    <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<!doctype html>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<html class="no-js" lang="en" data-content_root="../../">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								  <head><meta charset="utf-8"/>
 								    <meta name="viewport" content="width=device-width,initial-scale=1"/>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@60b7058a68cdb3127e07ac084872440b399f227c 🚀

											
										
										
											2022-10-15 15:13:56 +00:00
+								    <meta name="color-scheme" content="light dark">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b6b0975c91a82e53c14691d445e17f35ada121c 🚀

											
										
										
											2022-10-16 13:56:17 +00:00
+								    <meta name="description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@60b7058a68cdb3127e07ac084872440b399f227c 🚀

											
										
										
											2022-10-15 15:13:56 +00:00
+								    <meta property="og:title" content="Gymnasium Documentation" />
 								    <meta property="og:type" content="website" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b6b0975c91a82e53c14691d445e17f35ada121c 🚀

											
										
										
											2022-10-16 13:56:17 +00:00
+								    <meta property="og:description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								    <meta property="og:url" content="https://gymnasium.farama.org/api/spaces.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" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<link rel="index" title="Index" href="../../genindex/" /><link rel="search" title="Search" href="../../search/" /><link rel="next" title="Fundamental Spaces" href="fundamental/" /><link rel="prev" title="Make and register" href="../registry/" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								        <link rel="canonical" href="https://gymnasium.farama.org/api/spaces.html" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								    <link rel="shortcut icon" href="../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								        <title>Spaces - Gymnasium Documentation</title>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								      <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								    <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" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								    <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=82c8b628" />
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
 								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								    <header class="farama-header" aria-label="Farama header">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								      <div class="farama-header__container">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								        <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">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@62732993b85493819943079dba74ac785fc4b58c 🚀

											
										
										
											2022-10-08 23:42:10 +00:00
+								          <a href="../../">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								              <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"/>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								            <span class="farama-header__title">Gymnasium Documentation</span>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								          </a>
 								        </div>
 								        <div class="farama-header__right">
 								          <div class="farama-header-menu">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								            <button class="farama-header-menu__btn" aria-label="Open Farama Menu" aria-expanded="false" aria-haspopup="true" aria-controls="farama-menu">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              <img class="farama-black-logo-invert" src="../../_static/img/farama-logo-header.svg">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								              <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								              </svg>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								            </button>
 								            <div class="farama-header-menu-container farama-hidden" aria-hidden="true" id="farama-menu">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@60b7058a68cdb3127e07ac084872440b399f227c 🚀

											
										
										
											2022-10-15 15:13:56 +00:00
+								              <div class="farama-header-menu__header">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f6489c38b3b0f493c0c873ff8f338d06fe7d74fc 🚀

											
										
										
											2022-10-05 17:10:20 +00:00
+								                <a href="https://farama.org">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								                  <img class="farama-header-menu__logo farama-white-logo-invert" src="../../_static/img/farama_solid_white.svg" alt="Farama Foundation logo">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@4a6eb49e23a2034a9447aec5ef13da4f084e4ea6 🚀

											
										
										
											2022-10-18 09:10:33 +00:00
+								                  <span>Farama Foundation</span>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f6489c38b3b0f493c0c873ff8f338d06fe7d74fc 🚀

											
										
										
											2022-10-05 17:10:20 +00:00
+								                </a>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								                <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								              </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@60b7058a68cdb3127e07ac084872440b399f227c 🚀

											
										
										
											2022-10-15 15:13:56 +00:00
+								              <div class="farama-header-menu__body">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								                <!-- Response from farama.org/api/projects.json -->
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								              </div>
 								            </div>
 								          </div>
 								        </div>
 								      </div>
 								    </header>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
 								    <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">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								  <!--<header class="mobile-header">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								    <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								  </header>-->
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								  <aside class="sidebar-drawer">
 								    <div class="sidebar-container">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								      <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">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								  <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								<p class="caption" role="heading"><span class="caption-text">API</span></p>
 								<ul class="current">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<li class="toctree-l1"><a class="reference internal" href="../env/">Env</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1"><a class="reference internal" href="../registry/">Make and register</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Spaces</a><input checked="" 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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="fundamental/">Fundamental Spaces</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="composite/">Composite Spaces</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="utils/">Spaces Utils</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../wrappers/table/">List of Wrappers</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../wrappers/misc_wrappers/">Misc Wrappers</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../wrappers/action_wrappers/">Action Wrappers</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../wrappers/observation_wrappers/">Observation Wrappers</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../wrappers/reward_wrappers/">Reward Wrappers</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../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="../vector/wrappers/">Wrappers</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../vector/async_vector_env/">AsyncVectorEnv</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../vector/sync_vector_env/">SyncVectorEnv</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../vector/utils/">Utility functions</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1"><a class="reference internal" href="../utils/">Utility functions</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="../functional/">Functional Env</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
 								<ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/acrobot/">Acrobot</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/cart_pole/">Cart Pole</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/mountain_car_continuous/">Mountain Car Continuous</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/mountain_car/">Mountain Car</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/classic_control/pendulum/">Pendulum</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/box2d/bipedal_walker/">Bipedal Walker</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/box2d/car_racing/">Car Racing</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/box2d/lunar_lander/">Lunar Lander</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/blackjack/">Blackjack</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/taxi/">Taxi</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/cliff_walking/">Cliff Walking</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/toy_text/frozen_lake/">Frozen Lake</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../environments/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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/ant/">Ant</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/half_cheetah/">Half Cheetah</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/hopper/">Hopper</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/humanoid/">Humanoid</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/humanoid_standup/">Humanoid Standup</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/inverted_double_pendulum/">Inverted Double Pendulum</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/inverted_pendulum/">Inverted Pendulum</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/pusher/">Pusher</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cad6746ca6536b7b53ce96abbe0a604f48bc111d 🚀

											
										
										
											2022-10-27 14:56:52 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/reacher/">Reacher</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/swimmer/">Swimmer</a></li>
 								<li class="toctree-l2"><a class="reference internal" href="../../environments/mujoco/walker2d/">Walker2D</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1"><a class="reference internal" href="../../environments/atari/">Atari</a></li>
 								<li class="toctree-l1"><a class="reference internal" href="../../environments/third_party_environments/">External Environments</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
 								<ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics Documentation Links</a><input 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 Gymnasium Basics Documentation Links</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/load_quadruped_model/">Load custom quadruped robot environments</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents links in the Gymnasium Documentation</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 Training Agents links in the Gymnasium Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/FrozenLake_tuto/">Frozenlake benchmark</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1"><a class="reference internal" href="../../tutorials/third-party-tutorials/">Third-Party Tutorials</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								<p class="caption" role="heading"><span class="caption-text">Development</span></p>
 								<ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li class="toctree-l1"><a class="reference external" href="https://arxiv.org/abs/2407.17032">Paper</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@cab0fbb13d8f3c29c098939144fcbb183bede7f2 🚀

											
										
										
											2023-03-25 12:03:43 +00:00
+								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@71485eccde286468a710767d96a8309ab93ab811 🚀

											
										
										
											2022-10-25 11:10:26 +00:00
+								<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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								</div>
 								</div>
 								      </div>
 								    </div>
 								  </aside>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								  <div class="main-container">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@62732993b85493819943079dba74ac785fc4b58c 🚀

											
										
										
											2022-10-08 23:42:10 +00:00
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
 								    <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								          <div class="content-icon-container"><div class="edit-this-page">
 								  <a class="muted-link" href="https://github.com/Farama-Foundation/Gymnasium/edit/main/docs/api/spaces.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">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								          </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								          <article role="main">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								            <section class="tex2jax_ignore mathjax_ignore" id="spaces">
 								<h1>Spaces<a class="headerlink" href="#spaces" title="Link to this heading">¶</a></h1>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<div class="toctree-wrapper compound">
 								</div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<p id="module-gymnasium.spaces">This module implements various spaces.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								<p>Spaces describe mathematical sets and are used in Gym to specify valid actions and observations.
 								Every Gym environment must have the attributes <code class="docutils literal notranslate"><span class="pre">action_space</span></code> and <code class="docutils literal notranslate"><span class="pre">observation_space</span></code>.
 								If, for instance, three possible actions (0,1,2) can be performed in your environment and observations
 								are vectors in the two-dimensional unit cube, the environment code may contain the following two lines:</p>
 								<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">action_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
 								<span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,))</span>
 								</pre></div>
 								</div>
 								<p>All spaces inherit from the <a class="reference internal" href="#gymnasium.spaces.Space" title="gymnasium.spaces.Space"><code class="xref py py-class docutils literal notranslate"><span class="pre">Space</span></code></a> superclass.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dl class="py class">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.spaces.</span></span><span class="sig-name descname"><span class="pre">Space</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dtype</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">npt.DTypeLike</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">np.random.Generator</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dd><p>Superclass that is used to define observation and action spaces.</p>
 								<p>Spaces are crucially used in Gym to define the format of valid actions and observations.
 								They serve various purposes:</p>
 								<ul class="simple">
 								<li><p>They clearly define how to interact with environments, i.e. they specify what actions need to look like
 								and what observations will look like</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><p>They allow us to work with highly structured data (e.g. in the form of elements of <a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a> spaces)
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								and painlessly transform them into flat arrays that can be used in learning code</p></li>
 								<li><p>They provide a method to sample random elements. This is especially useful for exploration and debugging.</p></li>
 								</ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<p>Different spaces can be combined hierarchically via container spaces (<a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> and <a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>) to build a
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								more expressive space</p>
 								<div class="admonition warning">
 								<p class="admonition-title">Warning</p>
 								<p>Custom observation &amp; action spaces can inherit from the <code class="docutils literal notranslate"><span class="pre">Space</span></code>
 								class. However, most use-cases should be covered by the existing space
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								classes (e.g. <a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code></a>, <a class="reference internal" href="fundamental/#gymnasium.spaces.Discrete" title="gymnasium.spaces.Discrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">Discrete</span></code></a>, etc…), and container classes (<a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> &amp;
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>). Note that parametrized probability distributions (through the
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<a class="reference internal" href="#gymnasium.spaces.Space.sample" title="gymnasium.spaces.Space.sample"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Space.sample()</span></code></a> method), and batching functions (in <code class="xref py py-class docutils literal notranslate"><span class="pre">gym.vector.VectorEnv</span></code>), are
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								only well-defined for instances of spaces provided in gym by default.
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								Moreover, some implementations of Reinforcement Learning algorithms might
 								not handle custom spaces properly. Use custom spaces with care.</p>
 								</div>
 								<dl class="field-list simple">
 								<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 								<dd class="field-odd"><ul class="simple">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><p><strong>shape</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><em>Sequence</em></a><em>[</em><em>int</em><em>]</em><em>]</em>) – If elements of the space are numpy arrays, this should specify their shape.</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<li><p><strong>dtype</strong> (<em>Optional</em><em>[</em><em>Type</em><em> | </em><em>str</em><em>]</em>) – If elements of the space are numpy arrays, this should specify their dtype.</p></li>
 								<li><p><strong>seed</strong> – Optionally, you can use this argument to seed the RNG that is used to sample from the space</p></li>
 								</ul>
 								</dd>
 								</dl>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<section id="attributes">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<h2>Attributes<a class="headerlink" href="#attributes" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<dl class="py property">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dt class="sig sig-object py" id="gymnasium.spaces.Space.shape">
 								<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">shape</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#gymnasium.spaces.Space.shape" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<dd><p>Return the shape of the space as an immutable property.</p>
 								</dd></dl>
 								<dl class="py property">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								<dt class="sig sig-object py" id="gymnasium.spaces.Space.dtype">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">dtype</span></span><a class="headerlink" href="#gymnasium.spaces.Space.dtype" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<dd><p>Return the data type of this space.</p>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								<dl class="py property">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dt class="sig sig-object py" id="gymnasium.spaces.Space.is_np_flattenable">
 								<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">is_np_flattenable</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#gymnasium.spaces.Space.is_np_flattenable" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								<dd><p>Checks whether this space can be flattened to a <a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">gymnasium.spaces.Box</span></code></a>.</p>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py property">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.np_random">
 								<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">np_random</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Generator</span></em><a class="headerlink" href="#gymnasium.spaces.Space.np_random" title="Link to this definition">¶</a></dt>
 								<dd><p>Lazily seed the PRNG since this is expensive and only needed if sampling from this space.</p>
 								<p>As <a class="reference internal" href="#gymnasium.spaces.Space.seed" title="gymnasium.spaces.Space.seed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seed()</span></code></a> is not guaranteed to set the <cite>_np_random</cite> for particular seeds. We add a
 								check after <a class="reference internal" href="#gymnasium.spaces.Space.seed" title="gymnasium.spaces.Space.seed"><code class="xref py py-meth docutils literal notranslate"><span class="pre">seed()</span></code></a> to set a new random number generator.</p>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</section>
 								<section id="methods">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<h2>Methods<a class="headerlink" href="#methods" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<p>Each space implements the following functions:</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py method">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.sample">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mask</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">probability</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">T_cov</span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.sample"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.sample" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dd><p>Randomly sample an element of this space.</p>
 								<p>Can be uniform or non-uniform sampling based on boundedness of space.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								<p>The binary mask and the probability mask can’t be used at the same time.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dl class="field-list simple">
 								<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								<dd class="field-odd"><ul class="simple">
 								<li><p><strong>mask</strong> – A mask used for random sampling, expected <code class="docutils literal notranslate"><span class="pre">dtype=np.int8</span></code> and see sample implementation for expected shape.</p></li>
 								<li><p><strong>probability</strong> – A probability mask used for sampling according to the given probability distribution, expected <code class="docutils literal notranslate"><span class="pre">dtype=np.float64</span></code> and see sample implementation for expected shape.</p></li>
 								</ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</dd>
 								<dt class="field-even">Returns<span class="colon">:</span></dt>
 								<dd class="field-even"><p><strong>A sampled actions from the space</strong></p>
 								</dd>
 								</dl>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py method">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.contains">
 								<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.contains"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.contains" title="Link to this definition">¶</a></dt>
 								<dd><p>Return boolean specifying if x is a valid member of this space, equivalent to <code class="docutils literal notranslate"><span class="pre">sample</span> <span class="pre">in</span> <span class="pre">space</span></code>.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py method">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.seed">
 								<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">seed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.seed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.seed" title="Link to this definition">¶</a></dt>
 								<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
 								<dl class="field-list simple">
 								<dt class="field-odd">Parameters<span class="colon">:</span></dt>
 								<dd class="field-odd"><p><strong>seed</strong> – The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
 								</dd>
 								<dt class="field-even">Returns<span class="colon">:</span></dt>
 								<dd class="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
 								</dd>
 								</dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py method">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.to_jsonable">
 								<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">to_jsonable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">T_cov</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.to_jsonable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.to_jsonable" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dd><p>Convert a batch of samples from this space to a JSONable data type.</p>
 								</dd></dl>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<dl class="py method">
 								<dt class="sig sig-object py" id="gymnasium.spaces.Space.from_jsonable">
 								<span class="sig-prename descclassname"><span class="pre">Space.</span></span><span class="sig-name descname"><span class="pre">from_jsonable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sample_n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">T_cov</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../_modules/gymnasium/spaces/space/#Space.from_jsonable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#gymnasium.spaces.Space.from_jsonable" title="Link to this definition">¶</a></dt>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<dd><p>Convert a JSONable data type to a batch of samples from this space.</p>
 								</dd></dl>
 								</section>
 								<section id="fundamental-spaces">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<h2>Fundamental Spaces<a class="headerlink" href="#fundamental-spaces" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<p>Gymnasium has a number of fundamental spaces that are used as building boxes for more complex spaces.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<ul class="simple">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Box" title="gymnasium.spaces.Box"><code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code></a> - Supports continuous (and discrete) vectors or matrices, used for vector observations, images, etc</p></li>
 								<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Discrete" title="gymnasium.spaces.Discrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">Discrete</span></code></a> - Supports a single discrete number of values with an optional start for the values</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.MultiBinary" title="gymnasium.spaces.MultiBinary"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultiBinary</span></code></a> - Supports single or matrices of binary values, used for holding down a button or if an agent has an object</p></li>
 								<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.MultiDiscrete" title="gymnasium.spaces.MultiDiscrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultiDiscrete</span></code></a> - Supports multiple discrete values with multiple axes, used for controller actions</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><p><a class="reference internal" href="fundamental/#gymnasium.spaces.Text" title="gymnasium.spaces.Text"><code class="xref py py-class docutils literal notranslate"><span class="pre">Text</span></code></a> - Supports strings, used for passing agent messages, mission details, etc</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								</section>
 								<section id="composite-spaces">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<h2>Composite Spaces<a class="headerlink" href="#composite-spaces" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<p>Often environment spaces require joining fundamental spaces together for vectorised environments, separate agents or readability of the space.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<ul class="simple">
 								<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Dict" title="gymnasium.spaces.Dict"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a> - Supports a dictionary of keys and subspaces, used for a fixed number of unordered spaces</p></li>
 								<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> - Supports a tuple of subspaces, used for multiple for a fixed number of ordered spaces</p></li>
 								<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Sequence" title="gymnasium.spaces.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a> - Supports a variable number of instances of a single subspace, used for entities spaces or selecting a variable number of actions</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><p><a class="reference internal" href="composite/#gymnasium.spaces.Graph" title="gymnasium.spaces.Graph"><code class="xref py py-class docutils literal notranslate"><span class="pre">Graph</span></code></a> - Supports graph based actions or observations with discrete or continuous nodes and edge values</p></li>
 								<li><p><a class="reference internal" href="composite/#gymnasium.spaces.OneOf" title="gymnasium.spaces.OneOf"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneOf</span></code></a> - Supports optional action spaces such that an action can be one of N possible subspaces</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								</section>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<section id="utility-functions">
 								<h2>Utility functions<a class="headerlink" href="#utility-functions" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<p>Gymnasium contains a number of helpful utility functions for flattening and unflattening spaces.
 								This can be important for passing information to neural networks.</p>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<ul class="simple">
 								<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatdim" title="gymnasium.spaces.utils.flatdim"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatdim</span></code></a> - The number of dimensions the flattened space will contain</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten_space" title="gymnasium.spaces.utils.flatten_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten_space</span></code></a> - Flattens a space for which the <code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flattened</span></code> space instances will contain</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten" title="gymnasium.spaces.utils.flatten"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten</span></code></a> - Flattens an instance of a space that is contained within the flattened version of the space</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><p><a class="reference internal" href="utils/#gymnasium.spaces.utils.unflatten" title="gymnasium.spaces.utils.unflatten"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.unflatten</span></code></a> - The reverse of the <a class="reference internal" href="utils/#gymnasium.spaces.utils.flatten_space" title="gymnasium.spaces.utils.flatten_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">utils.flatten_space</span></code></a> function</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								</section>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<section id="vector-utility-functions">
 								<h2>Vector Utility functions<a class="headerlink" href="#vector-utility-functions" title="Link to this heading">¶</a></h2>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<p>When vectorizing environments, it is necessary to modify the observation and action spaces for new batched spaces sizes.
 								Therefore, Gymnasium provides a number of additional functions used when using a space with a Vector environment.</p>
 								<ul class="simple">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.batch_space" title="gymnasium.vector.utils.batch_space"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.batch_space</span></code></a> - Transforms a space into the equivalent space for <code class="docutils literal notranslate"><span class="pre">n</span></code> users</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.concatenate" title="gymnasium.vector.utils.concatenate"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.concatenate</span></code></a> - Concatenates a space’s samples into a pre-generated space</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.iterate" title="gymnasium.vector.utils.iterate"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.iterate</span></code></a> - Iterate over the batched space’s samples</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.create_empty_array" title="gymnasium.vector.utils.create_empty_array"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.create_empty_array</span></code></a> - Creates an empty sample for an space (generally used with <code class="docutils literal notranslate"><span class="pre">concatenate</span></code>)</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.create_shared_memory" title="gymnasium.vector.utils.create_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.create_shared_memory</span></code></a> - Creates a shared memory for asynchronous (multiprocessing) environment</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.read_from_shared_memory" title="gymnasium.vector.utils.read_from_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.read_from_shared_memory</span></code></a> - Reads a shared memory for asynchronous (multiprocessing) environment</p></li>
 								<li><p><a class="reference internal" href="../vector/utils/#gymnasium.vector.utils.write_to_shared_memory" title="gymnasium.vector.utils.write_to_shared_memory"><code class="xref py py-class docutils literal notranslate"><span class="pre">vector.utils.write_to_shared_memory</span></code></a> - Write to a shared memory for asynchronous (multiprocessing) environment</p></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</section>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</section>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								          </article>
 								        </div>
 								        <footer>
 								          <div class="related-pages">
 								            <a class="next-page" href="fundamental/">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								              <div class="page-info">
 								                <div class="context">
 								                  <span>Next</span>
 								                </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								                <div class="title">Fundamental Spaces</div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								              </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              <svg class="furo-related-icon">
 								                <use href="#svg-arrow-right"></use>
 								              </svg>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								            </a>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								            <a class="prev-page" href="../registry/">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              <svg class="furo-related-icon">
 								                <use href="#svg-arrow-right"></use>
 								              </svg>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								              <div class="page-info">
 								                <div class="context">
 								                  <span>Previous</span>
 								                </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								                <div class="title">Make and register</div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
 								              </div>
 								            </a>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								          </div>
 								          <div class="bottom-of-page">
 								            <div class="left-details">
 								              <div class="copyright">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								                Copyright &#169; 2025 Farama Foundation
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              </div>
 								              <!--
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								            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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@60b7058a68cdb3127e07ac084872440b399f227c 🚀

											
										
										
											2022-10-15 15:13:56 +00:00
+								            -->
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								            </div>
 								            <div class="right-details">
 								              <div class="icons">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								                <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								              </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								            </div>
 								          </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
 								        </footer>
 								      </div>
 								      <aside class="toc-drawer">
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
 								        <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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								<li><a class="reference internal" href="#">Spaces</a><ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@43c3118854b0d6131e450be723105c829a78c535 🚀

											
										
										
											2022-09-25 14:44:48 +00:00
+								<li><a class="reference internal" href="#gymnasium.spaces.Space"><code class="docutils literal notranslate"><span class="pre">Space</span></code></a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								<li><a class="reference internal" href="#attributes">Attributes</a><ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><a class="reference internal" href="#gymnasium.spaces.Space.shape"><code class="docutils literal notranslate"><span class="pre">Space.shape</span></code></a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								<li><a class="reference internal" href="#gymnasium.spaces.Space.dtype"><code class="docutils literal notranslate"><span class="pre">Space.dtype</span></code></a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><a class="reference internal" href="#gymnasium.spaces.Space.is_np_flattenable"><code class="docutils literal notranslate"><span class="pre">Space.is_np_flattenable</span></code></a></li>
 								<li><a class="reference internal" href="#gymnasium.spaces.Space.np_random"><code class="docutils literal notranslate"><span class="pre">Space.np_random</span></code></a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2a7ebc4271e50556368fda0b98480944e80c4d0c 🚀

											
										
										
											2022-10-12 15:02:09 +00:00
+								</ul>
 								</li>
 								<li><a class="reference internal" href="#methods">Methods</a><ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><a class="reference internal" href="#gymnasium.spaces.Space.sample"><code class="docutils literal notranslate"><span class="pre">Space.sample()</span></code></a></li>
 								<li><a class="reference internal" href="#gymnasium.spaces.Space.contains"><code class="docutils literal notranslate"><span class="pre">Space.contains()</span></code></a></li>
 								<li><a class="reference internal" href="#gymnasium.spaces.Space.seed"><code class="docutils literal notranslate"><span class="pre">Space.seed()</span></code></a></li>
 								<li><a class="reference internal" href="#gymnasium.spaces.Space.to_jsonable"><code class="docutils literal notranslate"><span class="pre">Space.to_jsonable()</span></code></a></li>
 								<li><a class="reference internal" href="#gymnasium.spaces.Space.from_jsonable"><code class="docutils literal notranslate"><span class="pre">Space.from_jsonable()</span></code></a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								</ul>
 								</li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@2f8002f2bd7d5dae5d19b37f75b7fd4ab083b0ff 🚀

											
										
										
											2022-09-16 13:02:04 +00:00
+								<li><a class="reference internal" href="#fundamental-spaces">Fundamental Spaces</a></li>
 								<li><a class="reference internal" href="#composite-spaces">Composite Spaces</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								<li><a class="reference internal" href="#utility-functions">Utility functions</a></li>
 								<li><a class="reference internal" href="#vector-utility-functions">Vector Utility functions</a></li>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</ul>
 								</li>
 								</ul>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								            </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								          </div>
 								        </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
 								      </aside>
 								    </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								  </div>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								</div>
 								    <script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								      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")) {
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								          menuBtn.setAttribute("aria-expanded", "false");
 								          menuContainer.setAttribute("aria-hidden", "true");
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								        } else {
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								          menuBtn.setAttribute("aria-expanded", "true");
 								          menuContainer.setAttribute("aria-hidden", "false");
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								        }
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
+								        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>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								    <script async src="https://www.googletagmanager.com/gtag/js?id=G-6H9C8TWXZ8"></script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@e68593c8f30796fdaf6bd1cd0ebec35653294d1d 🚀

											
										
										
											2022-10-13 10:54:57 +00:00
+								      <script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								        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();
 								            }
 								        })()
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@e68593c8f30796fdaf6bd1cd0ebec35653294d1d 🚀

											
										
										
											2022-10-13 10:54:57 +00:00
+								      </script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@f0fd69d7f21c0dbb6d3b25def2d1af5921a16130 🚀

											
										
										
											2022-10-03 15:02:45 +00:00
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@9ff8bf45dd765fae4cadec57873c69345e61e28e 🚀

											
										
										
											2025-02-26 11:56:33 +00:00
+								    <script src="../../_static/documentation_options.js?v=25d39d6f"></script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								    <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>window.MathJax = {"options": {"processHtmlClass": "tex2jax_process|mathjax_process|math|output_area"}}</script>
 								    <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@08dacf2f7be78d2e1737fa3f3c227f491dd98f8b 🚀

											
										
										
											2022-10-21 15:39:00 +00:00
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								    <script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
 								      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;
 								      }
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@7ddce8c807945f3cba5e3453a1b8e3f086743b96 🚀

											
										
										
											2023-07-14 22:50:55 +00:00
+								      // Create menu with Farama projects by using the API at farama.org/api/projects.json
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								      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 = {
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								          "Core Projects": [],
 								          "Mature Projects": {
 								            "Documentation": [],
 								            "Repositories": [],
 								          },
 								          "Incubating Projects": {
 								            "Documentation": [],
 								            "Repositories": [],
 								          },
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								          "Foundation": [
 								            {
 								              name: "About",
 								              link: "https://farama.org/about"
 								            },
 								            {
 								              name: "Standards",
 								              link: "https://farama.org/project_standards",
 								            },
 								            {
 								              name: "Donate",
 								              link: "https://farama.org/donations"
 								            }
 								          ]
 								        }
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
 								        // Categorize projects
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								        Object.keys(jsonResponse).forEach(key => {
 								          projectJson = jsonResponse[key];
 								          if (projectJson.website !== null) {
 								            projectJson.link = projectJson.website;
 								          } else {
 								            projectJson.link = projectJson.github;
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								          }
 								          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)
 								            }
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								          }
 								        })
 								        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
 								            }
 								          ))
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								          // 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'),
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								                {
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								                  className:'farama-header-menu__subsection-title' ,
 								                  innerText: subKey
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								                }
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@196625488fc3fafef74cd97ace58ef625a41ad8c 🚀

											
										
										
											2024-10-08 10:03:58 +00:00
+								              ))
 								              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);
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@898b747dcc6cb3a15758ec57c0eb0192318552ab 🚀

											
										
										
											2022-12-12 13:31:00 +00:00
+								          }
 								          menuContainer.appendChild(sectionElem)
 								        });
 								      }
 								      xhr.onerror = function() {
 								        console.error("Unable to load projects");
 								      };
 								      xhr.send();
 								    </script>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@71485eccde286468a710767d96a8309ab93ab811 🚀

											
										
										
											2022-10-25 11:10:26 +00:00
+								    <script>
 								      const versioningConfig = {
 								        githubUser: 'Farama-Foundation',
 								        githubRepo: 'Gymnasium',
 								      };
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789f03ca02ba3894084cdcee687134423 🚀

											
										
										
											2023-01-20 14:42:12 +00:00
+								      fetch('/main/_static/versioning/versioning_menu.html').then(response => {
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@71485eccde286468a710767d96a8309ab93ab811 🚀

											
										
										
											2022-10-25 11:10:26 +00:00
+								        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);
 								        }
 								      });
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@8c167b868dd386ac1eb4bbe2fb25da3da174c75d 🚀

											
										
										
											2023-03-24 17:29:47 +00:00
+								    </script>
 								    </body>
-												Deploying to gh-pages from @ Farama-Foundation/Gymnasium@91769fc86225f6b7d6c625b5fba14b936bc7dd45 🚀

											
										
										
											2022-09-13 19:29:14 +00:00
+								</html>