mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-20 05:52:03 +00:00
1244 lines
106 KiB
HTML
1244 lines
106 KiB
HTML
<!doctype html>
|
|
<html class="no-js" lang="en" data-content_root="../../../../">
|
|
<head><meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
<meta name="color-scheme" content="light dark">
|
|
<meta name="description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)">
|
|
<meta property="og:title" content="Gymnasium Documentation" />
|
|
<meta property="og:type" content="website" />
|
|
<meta property="og:description" content="A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)" />
|
|
<meta property="og:url" content="https://gymnasium.farama.org/_modules/gymnasium/wrappers/common.html" /><meta property="og:image" content="https://gymnasium.farama.org/_static/img/gymnasium-github.png" /><meta name="twitter:card" content="summary_large_image"><link rel="index" title="Index" href="../../../../genindex/" /><link rel="search" title="Search" href="../../../../search/" />
|
|
<link rel="canonical" href="https://gymnasium.farama.org/_modules/gymnasium/wrappers/common.html" />
|
|
|
|
<link rel="shortcut icon" href="../../../../_static/favicon.png"/><!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
|
|
<title>gymnasium.wrappers.common - 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 no-toc" for="__toc">
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
</label>
|
|
</div>
|
|
</header>-->
|
|
<aside class="sidebar-drawer">
|
|
<div class="sidebar-container">
|
|
|
|
<div class="sidebar-sticky"><a class="farama-sidebar__title" href="../../../../">
|
|
<img class="farama-header__logo only-light" src="../../../../_static/img/gymnasium_black.svg" alt="Light Logo"/>
|
|
<img class="farama-header__logo only-dark" src="../../../../_static/img/gymnasium_white.svg" alt="Dark Logo"/>
|
|
<span class="farama-header__title">Gymnasium Documentation</span>
|
|
</a><form class="sidebar-search-container" method="get" action="../../../../search/" role="search">
|
|
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
<input type="hidden" name="area" value="default">
|
|
</form>
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
<p class="caption" role="heading"><span class="caption-text">Introduction</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/basic_usage/">Basic Usage</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/train_agent/">Training an Agent</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/create_custom_env/">Create a Custom Environment</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/record_agent/">Recording Agents</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/speed_up_env/">Speeding Up Training</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/gym_compatibility/">Compatibility with Gym</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../introduction/migration_guide/">Migration Guide - v0.21 to v1.0.0</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">API</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../api/env/">Env</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../api/registry/">Make and register</a></li>
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../api/spaces/">Spaces</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Spaces</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/spaces/fundamental/">Fundamental Spaces</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/spaces/composite/">Composite Spaces</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/spaces/utils/">Spaces Utils</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../api/wrappers/">Wrappers</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Wrappers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/wrappers/table/">List of Wrappers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/wrappers/misc_wrappers/">Misc Wrappers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/wrappers/action_wrappers/">Action Wrappers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/wrappers/observation_wrappers/">Observation Wrappers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/wrappers/reward_wrappers/">Reward Wrappers</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../api/vector/">Vectorize</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Vectorize</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/vector/wrappers/">Wrappers</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/vector/async_vector_env/">AsyncVectorEnv</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/vector/sync_vector_env/">SyncVectorEnv</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../api/vector/utils/">Utility functions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../api/utils/">Utility functions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../../api/functional/">Functional Env</a></li>
|
|
</ul>
|
|
<p class="caption" role="heading"><span class="caption-text">Environments</span></p>
|
|
<ul>
|
|
<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</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</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/environment_creation/">Make your own custom environment</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/load_quadruped_model/">Load custom quadruped robot environments</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Training Agents</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../tutorials/training_agents/blackjack_q_learning/">Solving Blackjack with Tabular Q-Learning</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../tutorials/training_agents/frozenlake_q_learning/">Solving Frozenlake with Tabular Q-Learning</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../tutorials/training_agents/mujoco_reinforce/">Training using REINFORCE for Mujoco</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="../../../../tutorials/training_agents/vector_a2c/">Speeding up A2C Training with Vector Envs</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="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 no-toc" 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">
|
|
|
|
<h1>Source code for gymnasium.wrappers.common</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""A collection of common wrappers.</span>
|
|
|
|
<span class="sd">* ``TimeLimit`` - Provides a time limit on the number of steps for an environment before it truncates</span>
|
|
<span class="sd">* ``Autoreset`` - Auto-resets the environment</span>
|
|
<span class="sd">* ``PassiveEnvChecker`` - Passive environment checker that does not modify any environment data</span>
|
|
<span class="sd">* ``OrderEnforcing`` - Enforces the order of function calls to environments</span>
|
|
<span class="sd">* ``RecordEpisodeStatistics`` - Records the episode statistics</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
|
|
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">deque</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">copy</span><span class="w"> </span><span class="kn">import</span> <span class="n">deepcopy</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">SupportsFloat</span>
|
|
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">gymnasium</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">gym</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">gymnasium</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">gymnasium.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">RenderFrame</span><span class="p">,</span> <span class="n">WrapperObsType</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">gymnasium.error</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResetNeeded</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">gymnasium.utils.passive_env_checker</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
|
<span class="n">check_action_space</span><span class="p">,</span>
|
|
<span class="n">check_observation_space</span><span class="p">,</span>
|
|
<span class="n">env_render_passive_checker</span><span class="p">,</span>
|
|
<span class="n">env_reset_passive_checker</span><span class="p">,</span>
|
|
<span class="n">env_step_passive_checker</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
|
|
<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">gymnasium.envs.registration</span><span class="w"> </span><span class="kn">import</span> <span class="n">EnvSpec</span>
|
|
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="s2">"TimeLimit"</span><span class="p">,</span>
|
|
<span class="s2">"Autoreset"</span><span class="p">,</span>
|
|
<span class="s2">"PassiveEnvChecker"</span><span class="p">,</span>
|
|
<span class="s2">"OrderEnforcing"</span><span class="p">,</span>
|
|
<span class="s2">"RecordEpisodeStatistics"</span><span class="p">,</span>
|
|
<span class="p">]</span>
|
|
|
|
|
|
<div class="viewcode-block" id="TimeLimit">
|
|
<a class="viewcode-back" href="../../../../api/wrappers/misc_wrappers/#gymnasium.wrappers.TimeLimit">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">TimeLimit</span><span class="p">(</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span> <span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Limits the number of steps for an environment through truncating the environment if a maximum number of timesteps is exceeded.</span>
|
|
|
|
<span class="sd"> If a truncation is not defined inside the environment itself, this is the only place that the truncation signal is issued.</span>
|
|
<span class="sd"> Critically, this is different from the `terminated` signal that originates from the underlying environment as part of the MDP.</span>
|
|
<span class="sd"> No vector wrapper exists.</span>
|
|
|
|
<span class="sd"> Example using the TimeLimit wrapper:</span>
|
|
<span class="sd"> >>> from gymnasium.wrappers import TimeLimit</span>
|
|
<span class="sd"> >>> from gymnasium.envs.classic_control import CartPoleEnv</span>
|
|
|
|
<span class="sd"> >>> spec = gym.spec("CartPole-v1")</span>
|
|
<span class="sd"> >>> spec.max_episode_steps</span>
|
|
<span class="sd"> 500</span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1")</span>
|
|
<span class="sd"> >>> env # TimeLimit is included within the environment stack</span>
|
|
<span class="sd"> <TimeLimit<OrderEnforcing<PassiveEnvChecker<CartPoleEnv<CartPole-v1>>>>></span>
|
|
<span class="sd"> >>> env.spec # doctest: +ELLIPSIS</span>
|
|
<span class="sd"> EnvSpec(id='CartPole-v1', ..., max_episode_steps=500, ...)</span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1", max_episode_steps=3)</span>
|
|
<span class="sd"> >>> env.spec # doctest: +ELLIPSIS</span>
|
|
<span class="sd"> EnvSpec(id='CartPole-v1', ..., max_episode_steps=3, ...)</span>
|
|
<span class="sd"> >>> env = TimeLimit(CartPoleEnv(), max_episode_steps=10)</span>
|
|
<span class="sd"> >>> env</span>
|
|
<span class="sd"> <TimeLimit<CartPoleEnv instance>></span>
|
|
|
|
<span class="sd"> Example of `TimeLimit` determining the episode step</span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1", max_episode_steps=3)</span>
|
|
<span class="sd"> >>> _ = env.reset(seed=123)</span>
|
|
<span class="sd"> >>> _ = env.action_space.seed(123)</span>
|
|
<span class="sd"> >>> _, _, terminated, truncated, _ = env.step(env.action_space.sample())</span>
|
|
<span class="sd"> >>> terminated, truncated</span>
|
|
<span class="sd"> (False, False)</span>
|
|
<span class="sd"> >>> _, _, terminated, truncated, _ = env.step(env.action_space.sample())</span>
|
|
<span class="sd"> >>> terminated, truncated</span>
|
|
<span class="sd"> (False, False)</span>
|
|
<span class="sd"> >>> _, _, terminated, truncated, _ = env.step(env.action_space.sample())</span>
|
|
<span class="sd"> >>> terminated, truncated</span>
|
|
<span class="sd"> (False, True)</span>
|
|
|
|
<span class="sd"> Change logs:</span>
|
|
<span class="sd"> * v0.10.6 - Initially added</span>
|
|
<span class="sd"> * v0.25.0 - With the step API update, the termination and truncation signal is returned separately.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">env</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">,</span>
|
|
<span class="n">max_episode_steps</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Initializes the :class:`TimeLimit` wrapper with an environment and the number of steps after which truncation will occur.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> env: The environment to apply the wrapper</span>
|
|
<span class="sd"> max_episode_steps: the environment step after which the episode is truncated (``elapsed >= max_episode_steps``)</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">assert</span> <span class="p">(</span>
|
|
<span class="nb">isinstance</span><span class="p">(</span><span class="n">max_episode_steps</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">and</span> <span class="n">max_episode_steps</span> <span class="o">></span> <span class="mi">0</span>
|
|
<span class="p">),</span> <span class="sa">f</span><span class="s2">"Expect the `max_episode_steps` to be positive, actually: </span><span class="si">{</span><span class="n">max_episode_steps</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">max_episode_steps</span><span class="o">=</span><span class="n">max_episode_steps</span>
|
|
<span class="p">)</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_max_episode_steps</span> <span class="o">=</span> <span class="n">max_episode_steps</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_elapsed_steps</span> <span class="o">=</span> <span class="kc">None</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="n">ActType</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Steps through the environment and if the number of steps elapsed exceeds ``max_episode_steps`` then truncate.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> action: The environment step action</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> The environment step ``(observation, reward, terminated, truncated, info)`` with `truncated=True`</span>
|
|
<span class="sd"> if the number of steps elapsed >= max episode steps</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="n">observation</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_elapsed_steps</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_elapsed_steps</span> <span class="o">>=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_max_episode_steps</span><span class="p">:</span>
|
|
<span class="n">truncated</span> <span class="o">=</span> <span class="kc">True</span>
|
|
|
|
<span class="k">return</span> <span class="n">observation</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Resets the environment with :param:`**kwargs` and sets the number of steps elapsed to zero.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> seed: Seed for the environment</span>
|
|
<span class="sd"> options: Options for the environment</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> The reset environment</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_elapsed_steps</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EnvSpec</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Modifies the environment spec to include the `max_episode_steps=self._max_episode_steps`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span>
|
|
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">spec</span>
|
|
<span class="k">if</span> <span class="n">env_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">env_spec</span><span class="p">)</span>
|
|
<span class="n">env_spec</span><span class="o">.</span><span class="n">max_episode_steps</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_max_episode_steps</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"An exception occurred (</span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">) while copying the environment spec=</span><span class="si">{</span><span class="n">env_spec</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="o">=</span> <span class="n">env_spec</span>
|
|
<span class="k">return</span> <span class="n">env_spec</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="Autoreset">
|
|
<a class="viewcode-back" href="../../../../api/wrappers/misc_wrappers/#gymnasium.wrappers.Autoreset">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">Autoreset</span><span class="p">(</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span> <span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""The wrapped environment is automatically reset when a terminated or truncated state is reached.</span>
|
|
|
|
<span class="sd"> This follows the vector autoreset api where on the step after an episode terminates or truncated then the environment is reset.</span>
|
|
|
|
<span class="sd"> Change logs:</span>
|
|
<span class="sd"> * v0.24.0 - Initially added as `AutoResetWrapper`</span>
|
|
<span class="sd"> * v1.0.0 - renamed to `Autoreset` and autoreset order was changed to reset on the step after the environment terminates or truncates. As a result, `"final_observation"` and `"final_info"` is removed.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A class for providing an automatic reset functionality for gymnasium environments when calling :meth:`self.step`.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> env (gym.Env): The environment to apply the wrapper</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">WrapperObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Resets the environment and sets autoreset to False preventing."""</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="n">ActType</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Steps through the environment with action and resets the environment if a terminated or truncated signal is encountered.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> action: The action to take</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> The autoreset environment :meth:`step`</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span><span class="p">:</span>
|
|
<span class="n">obs</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
|
<span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">False</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">autoreset</span> <span class="o">=</span> <span class="n">terminated</span> <span class="ow">or</span> <span class="n">truncated</span>
|
|
<span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="PassiveEnvChecker">
|
|
<a class="viewcode-back" href="../../../../api/wrappers/misc_wrappers/#gymnasium.wrappers.PassiveEnvChecker">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">PassiveEnvChecker</span><span class="p">(</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span> <span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A passive wrapper that surrounds the ``step``, ``reset`` and ``render`` functions to check they follow Gymnasium's API.</span>
|
|
|
|
<span class="sd"> This wrapper is automatically applied during make and can be disabled with `disable_env_checker`.</span>
|
|
<span class="sd"> No vector version of the wrapper exists.</span>
|
|
|
|
<span class="sd"> Example:</span>
|
|
<span class="sd"> >>> import gymnasium as gym</span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1")</span>
|
|
<span class="sd"> >>> env</span>
|
|
<span class="sd"> <TimeLimit<OrderEnforcing<PassiveEnvChecker<CartPoleEnv<CartPole-v1>>>>></span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1", disable_env_checker=True)</span>
|
|
<span class="sd"> >>> env</span>
|
|
<span class="sd"> <TimeLimit<OrderEnforcing<CartPoleEnv<CartPole-v1>>>></span>
|
|
|
|
<span class="sd"> Change logs:</span>
|
|
<span class="sd"> * v0.24.1 - Initially added however broken in several ways</span>
|
|
<span class="sd"> * v0.25.0 - Bugs was all fixed</span>
|
|
<span class="sd"> * v0.29.0 - Removed warnings for infinite bounds for Box observation and action spaces and inregular bound shapes</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">]):</span>
|
|
<span class="w"> </span><span class="sd">"""Initialises the wrapper with the environments, run the observation and action space tests."""</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="nb">str</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="n">__base__</span><span class="p">)</span> <span class="o">==</span> <span class="s2">"<class 'gym.core.Env'>"</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="s2">"Gym is incompatible with Gymnasium, please update the environment class to `gymnasium.Env`. "</span>
|
|
<span class="s2">"See https://gymnasium.farama.org/introduction/create_custom_env/ for more info."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"The environment must inherit from the gymnasium.Env class, actual class: </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">env</span><span class="p">)</span><span class="si">}</span><span class="s2">. "</span>
|
|
<span class="s2">"See https://gymnasium.farama.org/introduction/create_custom_env/ for more info."</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="s2">"action_space"</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span>
|
|
<span class="s2">"The environment must specify an action space. https://gymnasium.farama.org/introduction/create_custom_env/"</span>
|
|
<span class="p">)</span>
|
|
<span class="n">check_action_space</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">action_space</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="s2">"observation_space"</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span>
|
|
<span class="s2">"The environment must specify an observation space. https://gymnasium.farama.org/introduction/create_custom_env/"</span>
|
|
<span class="p">)</span>
|
|
<span class="n">check_observation_space</span><span class="p">(</span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_reset</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_step</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_render</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">close_called</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="n">ActType</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Steps through the environment that on the first call will run the `passive_env_step_check`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">checked_step</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_step</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="n">env_step_passive_checker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">,</span> <span class="n">action</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Resets the environment that on the first call will run the `passive_env_reset_check`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">checked_reset</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_reset</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="n">env_reset_passive_checker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">RenderFrame</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">RenderFrame</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Renders the environment that on the first call will run the `passive_env_render_check`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">checked_render</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checked_render</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="n">env_render_passive_checker</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">render</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EnvSpec</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Modifies the environment spec to such that `disable_env_checker=False`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span>
|
|
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">spec</span>
|
|
<span class="k">if</span> <span class="n">env_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">env_spec</span><span class="p">)</span>
|
|
<span class="n">env_spec</span><span class="o">.</span><span class="n">disable_env_checker</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"An exception occurred (</span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">) while copying the environment spec=</span><span class="si">{</span><span class="n">env_spec</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="o">=</span> <span class="n">env_spec</span>
|
|
<span class="k">return</span> <span class="n">env_spec</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Warns if calling close on a closed environment fails."""</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">close_called</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">close_called</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
|
|
<span class="s2">"Calling `env.close()` on the closed environment should be allowed, but it raised the following exception."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">raise</span> <span class="n">e</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="OrderEnforcing">
|
|
<a class="viewcode-back" href="../../../../api/wrappers/misc_wrappers/#gymnasium.wrappers.OrderEnforcing">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">OrderEnforcing</span><span class="p">(</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span> <span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Will produce an error if ``step`` or ``render`` is called before ``reset``.</span>
|
|
|
|
<span class="sd"> No vector version of the wrapper exists.</span>
|
|
|
|
<span class="sd"> Example:</span>
|
|
<span class="sd"> >>> import gymnasium as gym</span>
|
|
<span class="sd"> >>> from gymnasium.wrappers import OrderEnforcing</span>
|
|
<span class="sd"> >>> env = gym.make("CartPole-v1", render_mode="human")</span>
|
|
<span class="sd"> >>> env = OrderEnforcing(env)</span>
|
|
<span class="sd"> >>> env.step(0)</span>
|
|
<span class="sd"> Traceback (most recent call last):</span>
|
|
<span class="sd"> ...</span>
|
|
<span class="sd"> gymnasium.error.ResetNeeded: Cannot call env.step() before calling env.reset()</span>
|
|
<span class="sd"> >>> env.render()</span>
|
|
<span class="sd"> Traceback (most recent call last):</span>
|
|
<span class="sd"> ...</span>
|
|
<span class="sd"> gymnasium.error.ResetNeeded: Cannot call `env.render()` before calling `env.reset()`, if this is an intended action, set `disable_render_order_enforcing=True` on the OrderEnforcer wrapper.</span>
|
|
<span class="sd"> >>> _ = env.reset()</span>
|
|
<span class="sd"> >>> env.render()</span>
|
|
<span class="sd"> >>> _ = env.step(0)</span>
|
|
<span class="sd"> >>> env.close()</span>
|
|
|
|
<span class="sd"> Change logs:</span>
|
|
<span class="sd"> * v0.22.0 - Initially added</span>
|
|
<span class="sd"> * v0.24.0 - Added order enforcing for the render function</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">env</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span>
|
|
<span class="n">disable_render_order_enforcing</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A wrapper that will produce an error if :meth:`step` is called before an initial :meth:`reset`.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> env: The environment to wrap</span>
|
|
<span class="sd"> disable_render_order_enforcing: If to disable render order enforcing</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">disable_render_order_enforcing</span><span class="o">=</span><span class="n">disable_render_order_enforcing</span>
|
|
<span class="p">)</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_has_reset</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_disable_render_order_enforcing</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="n">disable_render_order_enforcing</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="n">ActType</span><span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""Steps through the environment."""</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_reset</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">ResetNeeded</span><span class="p">(</span><span class="s2">"Cannot call env.step() before calling env.reset()"</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Resets the environment with `kwargs`."""</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_has_reset</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">render</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">RenderFrame</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="n">RenderFrame</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Renders the environment with `kwargs`."""</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_disable_render_order_enforcing</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_reset</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">ResetNeeded</span><span class="p">(</span>
|
|
<span class="s2">"Cannot call `env.render()` before calling `env.reset()`, if this is an intended action, "</span>
|
|
<span class="s2">"set `disable_render_order_enforcing=True` on the OrderEnforcer wrapper."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">render</span><span class="p">()</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">has_reset</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Returns if the environment has been reset before."""</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_has_reset</span>
|
|
|
|
<span class="nd">@property</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">spec</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">EnvSpec</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""Modifies the environment spec to add the `order_enforce=True`."""</span>
|
|
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span>
|
|
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env</span><span class="o">.</span><span class="n">spec</span>
|
|
<span class="k">if</span> <span class="n">env_spec</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">env_spec</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">env_spec</span><span class="p">)</span>
|
|
<span class="n">env_spec</span><span class="o">.</span><span class="n">order_enforce</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"An exception occurred (</span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">) while copying the environment spec=</span><span class="si">{</span><span class="n">env_spec</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="kc">None</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_cached_spec</span> <span class="o">=</span> <span class="n">env_spec</span>
|
|
<span class="k">return</span> <span class="n">env_spec</span></div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="RecordEpisodeStatistics">
|
|
<a class="viewcode-back" href="../../../../api/wrappers/misc_wrappers/#gymnasium.wrappers.RecordEpisodeStatistics">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">RecordEpisodeStatistics</span><span class="p">(</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">,</span> <span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span> <span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""This wrapper will keep track of cumulative rewards and episode lengths.</span>
|
|
|
|
<span class="sd"> At the end of an episode, the statistics of the episode will be added to ``info``</span>
|
|
<span class="sd"> using the key ``episode``. If using a vectorized environment also the key</span>
|
|
<span class="sd"> ``_episode`` is used which indicates whether the env at the respective index has</span>
|
|
<span class="sd"> the episode statistics.</span>
|
|
<span class="sd"> A vector version of the wrapper exists, :class:`gymnasium.wrappers.vector.RecordEpisodeStatistics`.</span>
|
|
|
|
<span class="sd"> After the completion of an episode, ``info`` will look like this::</span>
|
|
|
|
<span class="sd"> >>> info = {</span>
|
|
<span class="sd"> ... "episode": {</span>
|
|
<span class="sd"> ... "r": "<cumulative reward>",</span>
|
|
<span class="sd"> ... "l": "<episode length>",</span>
|
|
<span class="sd"> ... "t": "<elapsed time since beginning of episode>"</span>
|
|
<span class="sd"> ... },</span>
|
|
<span class="sd"> ... }</span>
|
|
|
|
<span class="sd"> For a vectorized environments the output will be in the form of::</span>
|
|
|
|
<span class="sd"> >>> infos = {</span>
|
|
<span class="sd"> ... "episode": {</span>
|
|
<span class="sd"> ... "r": "<array of cumulative reward>",</span>
|
|
<span class="sd"> ... "l": "<array of episode length>",</span>
|
|
<span class="sd"> ... "t": "<array of elapsed time since beginning of episode>"</span>
|
|
<span class="sd"> ... },</span>
|
|
<span class="sd"> ... "_episode": "<boolean array of length num-envs>"</span>
|
|
<span class="sd"> ... }</span>
|
|
|
|
<span class="sd"> Moreover, the most recent rewards and episode lengths are stored in buffers that can be accessed via</span>
|
|
<span class="sd"> :attr:`wrapped_env.return_queue` and :attr:`wrapped_env.length_queue` respectively.</span>
|
|
|
|
<span class="sd"> Attributes:</span>
|
|
<span class="sd"> * time_queue: The time length of the last ``deque_size``-many episodes</span>
|
|
<span class="sd"> * return_queue: The cumulative rewards of the last ``deque_size``-many episodes</span>
|
|
<span class="sd"> * length_queue: The lengths of the last ``deque_size``-many episodes</span>
|
|
|
|
<span class="sd"> Change logs:</span>
|
|
<span class="sd"> * v0.15.4 - Initially added</span>
|
|
<span class="sd"> * v1.0.0 - Removed vector environment support (see :class:`gymnasium.wrappers.vector.RecordEpisodeStatistics`) and add attribute ``time_queue``</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span>
|
|
<span class="n">env</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">Env</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">ActType</span><span class="p">],</span>
|
|
<span class="n">buffer_length</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span><span class="p">,</span>
|
|
<span class="n">stats_key</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"episode"</span><span class="p">,</span>
|
|
<span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""This wrapper will keep track of cumulative rewards and episode lengths.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> env (Env): The environment to apply the wrapper</span>
|
|
<span class="sd"> buffer_length: The size of the buffers :attr:`return_queue`, :attr:`length_queue` and :attr:`time_queue`</span>
|
|
<span class="sd"> stats_key: The info key for the episode statistics</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">RecordConstructorArgs</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
|
<span class="n">gym</span><span class="o">.</span><span class="n">Wrapper</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_stats_key</span> <span class="o">=</span> <span class="n">stats_key</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_count</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_start_time</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_returns</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">0.0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_lengths</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">time_queue</span><span class="p">:</span> <span class="n">deque</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="n">deque</span><span class="p">(</span><span class="n">maxlen</span><span class="o">=</span><span class="n">buffer_length</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">return_queue</span><span class="p">:</span> <span class="n">deque</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="n">deque</span><span class="p">(</span><span class="n">maxlen</span><span class="o">=</span><span class="n">buffer_length</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">length_queue</span><span class="p">:</span> <span class="n">deque</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="n">deque</span><span class="p">(</span><span class="n">maxlen</span><span class="o">=</span><span class="n">buffer_length</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">step</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">:</span> <span class="n">ActType</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">bool</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Steps through the environment, recording the episode statistics."""</span>
|
|
<span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">action</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_returns</span> <span class="o">+=</span> <span class="n">reward</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_lengths</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
|
|
<span class="k">if</span> <span class="n">terminated</span> <span class="ow">or</span> <span class="n">truncated</span><span class="p">:</span>
|
|
<span class="k">assert</span> <span class="bp">self</span><span class="o">.</span><span class="n">_stats_key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">info</span>
|
|
|
|
<span class="n">episode_time_length</span> <span class="o">=</span> <span class="nb">round</span><span class="p">(</span>
|
|
<span class="n">time</span><span class="o">.</span><span class="n">perf_counter</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">episode_start_time</span><span class="p">,</span> <span class="mi">6</span>
|
|
<span class="p">)</span>
|
|
<span class="n">info</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_stats_key</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="s2">"r"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">episode_returns</span><span class="p">,</span>
|
|
<span class="s2">"l"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">episode_lengths</span><span class="p">,</span>
|
|
<span class="s2">"t"</span><span class="p">:</span> <span class="n">episode_time_length</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">time_queue</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">episode_time_length</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">return_queue</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">episode_returns</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">length_queue</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">episode_lengths</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_count</span> <span class="o">+=</span> <span class="mi">1</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">perf_counter</span><span class="p">()</span>
|
|
|
|
<span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reset</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">tuple</span><span class="p">[</span><span class="n">ObsType</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""Resets the environment using seed and options and resets the episode rewards and lengths."""</span>
|
|
<span class="n">obs</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="n">seed</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="n">options</span><span class="p">)</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">perf_counter</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_returns</span> <span class="o">=</span> <span class="mf">0.0</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">episode_lengths</span> <span class="o">=</span> <span class="mi">0</span>
|
|
|
|
<span class="k">return</span> <span class="n">obs</span><span class="p">,</span> <span class="n">info</span></div>
|
|
|
|
</pre></div>
|
|
</article>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
</div>
|
|
<div class="bottom-of-page">
|
|
<div class="left-details">
|
|
<div class="copyright">
|
|
Copyright © 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 no-toc">
|
|
|
|
|
|
|
|
</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=151cd43d"></script>
|
|
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../../../../_static/scripts/furo.js?v=7660844c"></script>
|
|
|
|
<script>
|
|
|
|
const createProjectsList = (projects, displayImages) => {
|
|
const ulElem = Object.assign(document.createElement('ul'),
|
|
{
|
|
className:'farama-header-menu-list',
|
|
}
|
|
)
|
|
for (let project of projects) {
|
|
const liElem = document.createElement("li");
|
|
const aElem = Object.assign(document.createElement("a"),
|
|
{
|
|
href: project.link
|
|
}
|
|
);
|
|
liElem.appendChild(aElem);
|
|
if (displayImages) {
|
|
const imgElem = Object.assign(document.createElement("img"),
|
|
{
|
|
src: project.image ? imagesBasepath + project.image : imagesBasepath + "/farama_black.svg",
|
|
alt: `${project.name} logo`,
|
|
className: "farama-black-logo-invert"
|
|
}
|
|
);
|
|
aElem.appendChild(imgElem);
|
|
}
|
|
aElem.appendChild(document.createTextNode(project.name));
|
|
ulElem.appendChild(liElem);
|
|
}
|
|
return ulElem;
|
|
}
|
|
|
|
// Create menu with Farama projects by using the API at farama.org/api/projects.json
|
|
const createCORSRequest = (method, url) => {
|
|
let xhr = new XMLHttpRequest();
|
|
xhr.responseType = 'json';
|
|
|
|
if ("withCredentials" in xhr) {
|
|
xhr.open(method, url, true);
|
|
} else if (typeof XDomainRequest != "undefined") {
|
|
// IE8 & IE9
|
|
xhr = new XDomainRequest();
|
|
xhr.open(method, url);
|
|
} else {
|
|
// CORS not supported.
|
|
xhr = null;
|
|
}
|
|
return xhr;
|
|
};
|
|
|
|
const url = 'https://farama.org/api/projects.json';
|
|
const imagesBasepath = "https://farama.org/assets/images"
|
|
const method = 'GET';
|
|
let xhr = createCORSRequest(method, url);
|
|
|
|
xhr.onload = () => {
|
|
const jsonResponse = xhr.response;
|
|
const sections = {
|
|
"Core Projects": [],
|
|
"Mature Projects": {
|
|
"Documentation": [],
|
|
"Repositories": [],
|
|
},
|
|
"Incubating Projects": {
|
|
"Documentation": [],
|
|
"Repositories": [],
|
|
},
|
|
"Foundation": [
|
|
{
|
|
name: "About",
|
|
link: "https://farama.org/about"
|
|
},
|
|
{
|
|
name: "Standards",
|
|
link: "https://farama.org/project_standards",
|
|
},
|
|
{
|
|
name: "Donate",
|
|
link: "https://farama.org/donations"
|
|
}
|
|
]
|
|
}
|
|
|
|
// Categorize projects
|
|
Object.keys(jsonResponse).forEach(key => {
|
|
projectJson = jsonResponse[key];
|
|
if (projectJson.website !== null) {
|
|
projectJson.link = projectJson.website;
|
|
} else {
|
|
projectJson.link = projectJson.github;
|
|
}
|
|
if (projectJson.type === "core") {
|
|
sections["Core Projects"].push(projectJson)
|
|
} else if (projectJson.type == "mature") {
|
|
if (projectJson.website !== null) {
|
|
sections["Mature Projects"]["Documentation"].push(projectJson)
|
|
} else {
|
|
sections["Mature Projects"]["Repositories"].push(projectJson)
|
|
}
|
|
} else {
|
|
if (projectJson.website !== null) {
|
|
sections["Incubating Projects"]["Documentation"].push(projectJson)
|
|
} else {
|
|
sections["Incubating Projects"]["Repositories"].push(projectJson)
|
|
}
|
|
}
|
|
})
|
|
|
|
const menuContainer = document.querySelector(".farama-header-menu__body");
|
|
|
|
Object.keys(sections).forEach((key, i) => {
|
|
const sectionElem = Object.assign(
|
|
document.createElement('div'), {
|
|
className:'farama-header-menu__section',
|
|
}
|
|
)
|
|
sectionElem.appendChild(Object.assign(document.createElement('span'),
|
|
{
|
|
className:'farama-header-menu__section-title' ,
|
|
innerText: key
|
|
}
|
|
))
|
|
// is not a list
|
|
if (sections[key].constructor !== Array) {
|
|
const subSections = sections[key];
|
|
const subSectionContainerElem = Object.assign(
|
|
document.createElement('div'), {
|
|
className:'farama-header-menu__subsections-container',
|
|
style: 'display: flex'
|
|
}
|
|
)
|
|
Object.keys(subSections).forEach((subKey, i) => {
|
|
const subSectionElem = Object.assign(
|
|
document.createElement('div'), {
|
|
className:'farama-header-menu__subsection',
|
|
}
|
|
)
|
|
subSectionElem.appendChild(Object.assign(document.createElement('span'),
|
|
{
|
|
className:'farama-header-menu__subsection-title' ,
|
|
innerText: subKey
|
|
}
|
|
))
|
|
const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
|
|
subSectionElem.appendChild(ulElem);
|
|
subSectionContainerElem.appendChild(subSectionElem);
|
|
})
|
|
sectionElem.appendChild(subSectionContainerElem);
|
|
} else {
|
|
const projects = sections[key];
|
|
const ulElem = createProjectsList(projects, true);
|
|
sectionElem.appendChild(ulElem);
|
|
}
|
|
menuContainer.appendChild(sectionElem)
|
|
});
|
|
}
|
|
|
|
xhr.onerror = function() {
|
|
console.error("Unable to load projects");
|
|
};
|
|
|
|
xhr.send();
|
|
</script>
|
|
|
|
|
|
<script>
|
|
const versioningConfig = {
|
|
githubUser: 'Farama-Foundation',
|
|
githubRepo: 'Gymnasium',
|
|
};
|
|
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
|
if (response.status === 200) {
|
|
response.text().then(text => {
|
|
const container = document.createElement("div");
|
|
container.innerHTML = text;
|
|
document.querySelector("body").appendChild(container);
|
|
// innerHtml doenst evaluate scripts, we need to add them dynamically
|
|
Array.from(container.querySelectorAll("script")).forEach(oldScript => {
|
|
const newScript = document.createElement("script");
|
|
Array.from(oldScript.attributes).forEach(attr => newScript.setAttribute(attr.name, attr.value));
|
|
newScript.appendChild(document.createTextNode(oldScript.innerHTML));
|
|
oldScript.parentNode.replaceChild(newScript, oldScript);
|
|
});
|
|
});
|
|
} else {
|
|
console.warn("Unable to load versioning menu", response);
|
|
}
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |