2023-07-14 22:50:55 +00:00
<!doctype html>
2024-10-08 10:03:58 +00:00
< html class = "no-js" lang = "en" data-content_root = "../" >
2023-07-14 22:50:55 +00:00
< 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/index.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/index.html" / >
2024-10-08 10:03:58 +00:00
< link rel = "shortcut icon" href = "../_static/favicon.png" / > <!-- Generated with Sphinx 7.4.7 and Furo 2023.08.19.dev1 -->
2023-07-14 22:50:55 +00:00
< title > Overview: module code - Gymnasium Documentation< / title >
2025-02-26 11:56:33 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css?v=8f2a1f02" / >
2024-10-08 10:03:58 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/styles/furo.css?v=3e7f4c72" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sg_gallery.css?v=61a4c737" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sg_gallery-binder.css?v=f4aeca0c" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sg_gallery-dataframe.css?v=2082cf3c" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/sg_gallery-rendered-html.css?v=1277b6f3" / >
2025-02-26 11:56:33 +00:00
< link rel = "stylesheet" type = "text/css" href = "../_static/styles/furo-extensions.css?v=82c8b628" / >
2023-07-14 22:50:55 +00:00
< style >
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
< / style > < / head >
< body >
< 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 >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/basic_usage/" > Basic Usage< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/train_agent/" > Training an Agent< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/create_custom_env/" > Create a Custom Environment< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/record_agent/" > Recording Agents< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/speed_up_env/" > Speeding Up Training< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/gym_compatibility/" > Compatibility with Gym< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../introduction/migration_guide/" > Migration Guide - v0.21 to v1.0.0< / a > < / li >
2023-07-14 22:50:55 +00:00
< / 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 >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../api/registry/" > Make and register< / a > < / li >
2023-07-14 22:50:55 +00:00
< 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 >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../api/wrappers/table/" > List of Wrappers< / a > < / li >
2023-07-14 22:50:55 +00:00
< 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 >
2024-10-08 10:03:58 +00:00
< 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 >
2023-07-14 22:50:55 +00:00
< / ul >
< / li >
2024-10-08 10:03:58 +00:00
< 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 >
2023-07-14 22:50:55 +00:00
< / 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 >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../environments/atari/" > Atari< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../environments/third_party_environments/" > External Environments< / a > < / li >
2023-07-14 22:50:55 +00:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2025-02-26 11:56:33 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/" > Gymnasium Basics Documentation Links< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-8" name = "toctree-checkbox-8" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-8" > < div class = "visually-hidden" > Toggle navigation of Gymnasium Basics Documentation Links< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/load_quadruped_model/" > Load custom quadruped robot environments< / a > < / li >
2023-07-14 22:50:55 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/handling_time_limits/" > Handling Time Limits< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/implementing_custom_wrappers/" > Implementing Custom Wrappers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/environment_creation/" > Make your own custom environment< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/gymnasium_basics/vector_envs_tutorial/" > Training A2C with Vector Envs and Domain Randomization< / a > < / li >
< / ul >
< / li >
2025-02-26 11:56:33 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../tutorials/training_agents/" > Training Agents links in the Gymnasium Documentation< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-9" name = "toctree-checkbox-9" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-9" > < div class = "visually-hidden" > Toggle navigation of Training Agents links in the Gymnasium Documentation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
2023-07-14 22:50:55 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/training_agents/reinforce_invpend_gym_v26/" > Training using REINFORCE for Mujoco< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/training_agents/blackjack_tutorial/" > Solving Blackjack with Q-Learning< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../tutorials/training_agents/FrozenLake_tuto/" > Frozenlake benchmark< / a > < / li >
< / ul >
< / li >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../tutorials/third-party-tutorials/" > Third-Party Tutorials< / a > < / li >
2023-07-14 22:50:55 +00:00
< / 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 >
2024-10-08 10:03:58 +00:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://arxiv.org/abs/2407.17032" > Paper< / a > < / li >
2023-07-14 22:50:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../gymnasium_release_notes/" > Gymnasium Release Notes< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../gym_release_notes/" > Gym Release Notes< / a > < / li >
< 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 > All modules for which code is available< / h1 >
< ul > < li > < a href = "gymnasium/core/" > gymnasium.core< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/envs/functional_jax_env/" > gymnasium.envs.functional_jax_env< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/envs/registration/" > gymnasium.envs.registration< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/experimental/functional/" > gymnasium.experimental.functional< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/spaces/box/" > gymnasium.spaces.box< / a > < / li >
< li > < a href = "gymnasium/spaces/dict/" > gymnasium.spaces.dict< / a > < / li >
< li > < a href = "gymnasium/spaces/discrete/" > gymnasium.spaces.discrete< / a > < / li >
< li > < a href = "gymnasium/spaces/graph/" > gymnasium.spaces.graph< / a > < / li >
< li > < a href = "gymnasium/spaces/multi_binary/" > gymnasium.spaces.multi_binary< / a > < / li >
< li > < a href = "gymnasium/spaces/multi_discrete/" > gymnasium.spaces.multi_discrete< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/spaces/oneof/" > gymnasium.spaces.oneof< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/spaces/sequence/" > gymnasium.spaces.sequence< / a > < / li >
< li > < a href = "gymnasium/spaces/space/" > gymnasium.spaces.space< / a > < / li >
< li > < a href = "gymnasium/spaces/text/" > gymnasium.spaces.text< / a > < / li >
< li > < a href = "gymnasium/spaces/tuple/" > gymnasium.spaces.tuple< / a > < / li >
< li > < a href = "gymnasium/spaces/utils/" > gymnasium.spaces.utils< / a > < / li >
< li > < a href = "gymnasium/utils/env_checker/" > gymnasium.utils.env_checker< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/utils/ezpickle/" > gymnasium.utils.ezpickle< / a > < / li >
< li > < a href = "gymnasium/utils/performance/" > gymnasium.utils.performance< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/utils/play/" > gymnasium.utils.play< / a > < / li >
< li > < a href = "gymnasium/utils/save_video/" > gymnasium.utils.save_video< / a > < / li >
< li > < a href = "gymnasium/utils/seeding/" > gymnasium.utils.seeding< / a > < / li >
< li > < a href = "gymnasium/utils/step_api_compatibility/" > gymnasium.utils.step_api_compatibility< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/vector/async_vector_env/" > gymnasium.vector.async_vector_env< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/vector/sync_vector_env/" > gymnasium.vector.sync_vector_env< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/vector/utils/misc/" > gymnasium.vector.utils.misc< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/vector/utils/shared_memory/" > gymnasium.vector.utils.shared_memory< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/vector/utils/space_utils/" > gymnasium.vector.utils.space_utils< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/vector/vector_env/" > gymnasium.vector.vector_env< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/wrappers/atari_preprocessing/" > gymnasium.wrappers.atari_preprocessing< / a > < / li >
< li > < a href = "gymnasium/wrappers/common/" > gymnasium.wrappers.common< / a > < / li >
< li > < a href = "gymnasium/wrappers/jax_to_numpy/" > gymnasium.wrappers.jax_to_numpy< / a > < / li >
< li > < a href = "gymnasium/wrappers/jax_to_torch/" > gymnasium.wrappers.jax_to_torch< / a > < / li >
< li > < a href = "gymnasium/wrappers/numpy_to_torch/" > gymnasium.wrappers.numpy_to_torch< / a > < / li >
< li > < a href = "gymnasium/wrappers/rendering/" > gymnasium.wrappers.rendering< / a > < / li >
< li > < a href = "gymnasium/wrappers/stateful_action/" > gymnasium.wrappers.stateful_action< / a > < / li >
< li > < a href = "gymnasium/wrappers/stateful_observation/" > gymnasium.wrappers.stateful_observation< / a > < / li >
< li > < a href = "gymnasium/wrappers/stateful_reward/" > gymnasium.wrappers.stateful_reward< / a > < / li >
< li > < a href = "gymnasium/wrappers/transform_action/" > gymnasium.wrappers.transform_action< / a > < / li >
2023-07-14 22:50:55 +00:00
< li > < a href = "gymnasium/wrappers/transform_observation/" > gymnasium.wrappers.transform_observation< / a > < / li >
< li > < a href = "gymnasium/wrappers/transform_reward/" > gymnasium.wrappers.transform_reward< / a > < / li >
2024-10-08 10:03:58 +00:00
< li > < a href = "gymnasium/wrappers/vector/common/" > gymnasium.wrappers.vector.common< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/dict_info_to_list/" > gymnasium.wrappers.vector.dict_info_to_list< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/jax_to_numpy/" > gymnasium.wrappers.vector.jax_to_numpy< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/jax_to_torch/" > gymnasium.wrappers.vector.jax_to_torch< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/numpy_to_torch/" > gymnasium.wrappers.vector.numpy_to_torch< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/stateful_observation/" > gymnasium.wrappers.vector.stateful_observation< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/stateful_reward/" > gymnasium.wrappers.vector.stateful_reward< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/vectorize_action/" > gymnasium.wrappers.vector.vectorize_action< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/vectorize_observation/" > gymnasium.wrappers.vector.vectorize_observation< / a > < / li >
< li > < a href = "gymnasium/wrappers/vector/vectorize_reward/" > gymnasium.wrappers.vector.vectorize_reward< / a > < / li >
2023-07-14 22:50:55 +00:00
< / ul >
< / article >
< / div >
< footer >
< div class = "related-pages" >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
2025-02-26 11:56:33 +00:00
Copyright © 2025 Farama Foundation
2023-07-14 22:50:55 +00:00
< / 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 >
2024-10-08 10:03:58 +00:00
< 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",
2023-07-14 22:50:55 +00:00
}
2024-10-08 10:03:58 +00:00
);
declineBtn.addEventListener("click", () => {
localStorage.setItem("acceptedCookieAlert", false);
boxElem.remove();
});
2023-07-14 22:50:55 +00:00
2024-10-08 10:03:58 +00:00
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();
});
2023-07-14 22:50:55 +00:00
2024-10-08 10:03:58 +00:00
containerElem.appendChild(declineBtn);
containerElem.appendChild(acceptBtn);
boxElem.appendChild(containerElem);
document.body.appendChild(boxElem);
} else if (localStorage.getItem("acceptedCookieAlert") === "true") {
enableGtag();
}
})()
2023-07-14 22:50:55 +00:00
< / script >
2025-02-26 11:56:33 +00:00
< script src = "../_static/documentation_options.js?v=25d39d6f" > < / script >
2024-10-08 10:03:58 +00:00
< script src = "../_static/doctools.js?v=9a2dae69" > < / script >
< script src = "../_static/sphinx_highlight.js?v=dc90522c" > < / script >
< script src = "../_static/scripts/furo.js?v=7660844c" > < / script >
2023-07-14 22:50:55 +00:00
< script >
2024-10-08 10:03:58 +00:00
const createProjectsList = (projects, displayImages) => {
const ulElem = Object.assign(document.createElement('ul'),
{
className:'farama-header-menu-list',
}
)
for (let project of projects) {
const liElem = document.createElement("li");
const aElem = Object.assign(document.createElement("a"),
{
href: project.link
}
);
liElem.appendChild(aElem);
if (displayImages) {
const imgElem = Object.assign(document.createElement("img"),
{
src: project.image ? imagesBasepath + project.image : imagesBasepath + "/farama_black.svg",
alt: `${project.name} logo`,
className: "farama-black-logo-invert"
}
);
aElem.appendChild(imgElem);
}
aElem.appendChild(document.createTextNode(project.name));
ulElem.appendChild(liElem);
}
return ulElem;
}
2023-07-14 22:50:55 +00:00
// 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 = {
2024-10-08 10:03:58 +00:00
"Core Projects": [],
"Mature Projects": {
"Documentation": [],
"Repositories": [],
},
"Incubating Projects": {
"Documentation": [],
"Repositories": [],
},
2023-07-14 22:50:55 +00:00
"Foundation": [
{
name: "About",
link: "https://farama.org/about"
},
{
name: "Standards",
link: "https://farama.org/project_standards",
},
{
name: "Donate",
link: "https://farama.org/donations"
}
]
}
2024-10-08 10:03:58 +00:00
// Categorize projects
2023-07-14 22:50:55 +00:00
Object.keys(jsonResponse).forEach(key => {
projectJson = jsonResponse[key];
if (projectJson.website !== null) {
projectJson.link = projectJson.website;
} else {
projectJson.link = projectJson.github;
2024-10-08 10:03:58 +00:00
}
if (projectJson.type === "core") {
sections["Core Projects"].push(projectJson)
} else if (projectJson.type == "mature") {
if (projectJson.website !== null) {
sections["Mature Projects"]["Documentation"].push(projectJson)
} else {
sections["Mature Projects"]["Repositories"].push(projectJson)
}
} else {
if (projectJson.website !== null) {
sections["Incubating Projects"]["Documentation"].push(projectJson)
} else {
sections["Incubating Projects"]["Repositories"].push(projectJson)
}
2023-07-14 22:50:55 +00:00
}
})
const menuContainer = document.querySelector(".farama-header-menu__body");
Object.keys(sections).forEach((key, i) => {
const sectionElem = Object.assign(
document.createElement('div'), {
className:'farama-header-menu__section',
}
)
sectionElem.appendChild(Object.assign(document.createElement('span'),
{
className:'farama-header-menu__section-title' ,
innerText: key
}
))
2024-10-08 10:03:58 +00:00
// is not a list
if (sections[key].constructor !== Array) {
const subSections = sections[key];
const subSectionContainerElem = Object.assign(
document.createElement('div'), {
className:'farama-header-menu__subsections-container',
style: 'display: flex'
}
)
Object.keys(subSections).forEach((subKey, i) => {
const subSectionElem = Object.assign(
document.createElement('div'), {
className:'farama-header-menu__subsection',
}
)
subSectionElem.appendChild(Object.assign(document.createElement('span'),
2023-07-14 22:50:55 +00:00
{
2024-10-08 10:03:58 +00:00
className:'farama-header-menu__subsection-title' ,
innerText: subKey
2023-07-14 22:50:55 +00:00
}
2024-10-08 10:03:58 +00:00
))
const ulElem = createProjectsList(subSections[subKey], key !== 'Foundation');
subSectionElem.appendChild(ulElem);
subSectionContainerElem.appendChild(subSectionElem);
})
sectionElem.appendChild(subSectionContainerElem);
} else {
const projects = sections[key];
const ulElem = createProjectsList(projects, true);
sectionElem.appendChild(ulElem);
2023-07-14 22:50:55 +00:00
}
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 >
