2022-09-13 19:29:14 +00:00
<!doctype html>
< html class = "no-js" lang = "en" >
< head > < meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width,initial-scale=1" / >
2022-10-15 15:13:56 +00:00
< meta name = "color-scheme" content = "light dark" >
2022-10-16 13:56:17 +00:00
< meta name = "description" content = "A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)" >
2022-10-15 15:13:56 +00:00
< meta property = "og:title" content = "Gymnasium Documentation" / >
< meta property = "og:type" content = "website" / >
2022-10-16 13:56:17 +00:00
< meta property = "og:description" content = "A standard API for reinforcement learning and a diverse set of reference environments (formerly Gym)" / >
< meta property = "og:url" content = "https://gymnasium.farama.org/api/vector.html" / > < meta property = "og:image" content = "https://gymnasium.farama.org/_static/img/gymnasium-github.png" / > < meta name = "twitter:card" content = "summary_large_image" > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
2022-10-12 15:02:09 +00:00
< link rel = "index" title = "Index" href = "../../genindex/" / > < link rel = "search" title = "Search" href = "../../search/" / > < link rel = "next" title = "Utils" href = "../utils/" / > < link rel = "prev" title = "Reward Wrappers" href = "../wrappers/reward_wrappers/" / >
2022-09-13 19:29:14 +00:00
< link rel = "canonical" href = "https://gymnasium.farama.org/api/vector.html" / >
2022-10-16 13:56:17 +00:00
< link rel = "shortcut icon" href = "../../_static/favicon.png" / > < meta name = "generator" content = "sphinx-5.3.0, furo 2022.09.15.dev1" / >
2022-09-13 19:29:14 +00:00
< title > Vector - Gymnasium Documentation< / title >
< link rel = "stylesheet" type = "text/css" href = "../../_static/pygments.css" / >
2022-09-16 13:02:04 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../_static/styles/furo.css?digest=9ec31e2665bf879c1d47d93a8ec4893870ee1e45" / >
2022-10-19 14:22:38 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../_static/styles/furo-extensions.css?digest=a614025deca43086db03c234d5a3a2047a0241ae" / >
2022-09-13 19:29:14 +00:00
< style >
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
< / style > < / head >
< body >
2022-10-03 15:02:45 +00:00
< header class = "farama-header" >
< div class = "farama-header__container" >
< div class = "farama-header__left" >
2022-10-08 23:42:10 +00:00
< a href = "../../" >
2022-10-03 15:02:45 +00:00
< img class = "farama-header__logo only-light" src = "../../_static/img/gymnasium_black.svg" alt = "Light Logo" / >
< img class = "farama-header__logo only-dark" src = "../../_static/img/gymnasium_white.svg" alt = "Dark Logo" / >
< h1 class = "farama-header__title" > Gymnasium Documentation< / h1 >
< / a >
< / div >
< div class = "farama-header__right" >
< div class = "farama-header-menu" >
< div class = "farama-header-menu__btn" >
< span class = "farama-header-menu__btn-name" >
2022-10-18 09:10:33 +00:00
Farama Foundation
2022-10-03 15:02:45 +00:00
< / span >
< svg viewBox = "0 0 32 32" xmlns = "http://www.w3.org/2000/svg" xmlns:bx = "https://boxy-svg.com" >
< defs > < / defs >
< path d = "M 3 4.677 C 3 3.751 3.659 3 4.474 3 L 27.526 3 C 28.341 3 29 3.751 29 4.677 C 29 5.603 28.341 6.354 27.526 6.354 L 4.474 6.354 C 3.659 6.354 3 5.603 3 4.677 Z" bx:origin = "0.622825 3.875593" > < / path >
< path d = "M 3 16 C 3 15.074 3.659 14.323 4.474 14.323 L 27.526 14.323 C 28.341 14.323 29 15.074 29 16 C 29 16.926 28.341 17.677 27.526 17.677 L 4.474 17.677 C 3.659 17.677 3 16.926 3 16 Z" bx:origin = "0.622825 0.5" > < / path >
< path d = "M 3 27.323 C 3 26.397 3.659 25.646 4.474 25.646 L 27.526 25.646 C 28.341 25.646 29 26.397 29 27.323 C 29 28.249 28.341 29 27.526 29 L 4.474 29 C 3.659 29 3 28.249 3 27.323 Z" bx:origin = "0.622825 -2.875591" > < / path >
< / svg >
< / div >
2022-10-15 15:13:56 +00:00
< div class = "farama-header-menu-container" >
< div class = "farama-header-menu__header" >
2022-10-05 17:10:20 +00:00
< a href = "https://farama.org" >
2022-10-18 09:10:33 +00:00
< img class = "farama-header-menu__logo" src = "../../_static/img/farama_solid_white.svg" alt = "Farama Foundation" >
< span > Farama Foundation< / span >
2022-10-05 17:10:20 +00:00
< / a >
2022-10-03 15:02:45 +00:00
< 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 >
2022-10-15 15:13:56 +00:00
< div class = "farama-header-menu__body" >
< div class = "farama-header-menu__section" style = "padding-left: 24px;" >
< span class = "farama-header-menu__section-title" > Documentation< / span >
< ul class = "farama-header-menu-list" >
< li >
< a href = "https://gymnasium.farama.org" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/gymnasium-white.svg" >
2022-10-15 15:13:56 +00:00
Gymnasium
< / a >
< / li >
< li >
< a href = "https://pettingzoo.farama.org" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/pettingzoo-white.svg" >
2022-10-15 15:13:56 +00:00
PettingZoo
< / a >
< / li >
< li >
< a href = "https://minigrid.farama.org" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/minigrid-white.svg" >
2022-10-15 15:13:56 +00:00
MiniGrid
< / a >
< / li >
2022-10-21 15:39:00 +00:00
< li >
< a href = "https://robotics.farama.org" >
< img src = "../../_static/img/gymrobotics-white.svg" >
Gymnasium-Robotics
< / a >
< / li >
2022-10-15 15:13:56 +00:00
< / ul >
< / div >
< div class = "farama-header-menu__section" style = "padding-left: 24px;" >
< span class = "farama-header-menu__section-title" > Mature Projects< / span >
< ul class = "farama-header-menu-list" >
< li >
< a href = "https://github.com/Farama-Foundation/SuperSuit" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/supersuit-white.svg" >
2022-10-15 15:13:56 +00:00
SuperSuit
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/tinyscaler" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/tinyscaler-white.svg" >
2022-10-15 15:13:56 +00:00
Tinyscaler
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/AutoROM" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/autorom-white.svg" >
2022-10-15 15:13:56 +00:00
AutoROM
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/Jumpy" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/jumpy-white.svg" >
2022-10-15 15:13:56 +00:00
JumPy
< / a >
< / li >
< / ul >
< / div >
< div class = "farama-header-menu__section" style = "padding-left: 24px;" >
< span class = "farama-header-menu__section-title" > Incubating Projects< / span >
< ul class = "farama-header-menu-list" >
< li >
< a href = "https://github.com/Farama-Foundation/MAgent2" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/MAgent2-white.svg" >
2022-10-15 15:13:56 +00:00
MAgent2
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/procgen2" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/procgen2-white.svg" >
2022-10-15 15:13:56 +00:00
Procgen2
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/MiniWorld" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/miniworld-white.svg" >
2022-10-15 15:13:56 +00:00
Miniworld
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/D4RL" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/d4rl-white.svg" >
2022-10-15 15:13:56 +00:00
D4RL
< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/Kabuki" >
2022-10-16 13:56:17 +00:00
< img src = "../../_static/img/kabuki-white.svg" >
2022-10-15 15:13:56 +00:00
Kabuki
< / a >
< / li >
< / ul >
< / div >
< div class = "farama-header-menu__section" style = "padding-left: 24px;" >
< span class = "farama-header-menu__section-title" > Foundation< / span >
< ul class = "farama-header-menu-list" >
< li >
< a href = "https://farama.org/about" >
About
< / a >
< / li >
< li >
< a href = "https://farama.org/project_standards" >
Standards
< / a >
< / li >
< li >
< a href = "https://farama.org/donations" >
2022-10-16 13:56:17 +00:00
Donate
2022-10-15 15:13:56 +00:00
< / a >
< / li >
< / ul >
< / div >
2022-10-03 15:02:45 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< / header >
< div class = "farama-header-menu__overlay" > < / div >
2022-09-13 19:29:14 +00:00
< script >
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
< / script >
< svg xmlns = "http://www.w3.org/2000/svg" style = "display: none;" >
< symbol id = "svg-toc" viewBox = "0 0 24 24" >
< title > Contents< / title >
< svg stroke = "currentColor" fill = "currentColor" stroke-width = "0" viewBox = "0 0 1024 1024" >
< path d = "M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z" / >
< / svg >
< / symbol >
< symbol id = "svg-menu" viewBox = "0 0 24 24" >
< title > Menu< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
< line x1 = "3" y1 = "12" x2 = "21" y2 = "12" > < / line >
< line x1 = "3" y1 = "6" x2 = "21" y2 = "6" > < / line >
< line x1 = "3" y1 = "18" x2 = "21" y2 = "18" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-arrow-right" viewBox = "0 0 24 24" >
< title > Expand< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
< polyline points = "9 18 15 12 9 6" > < / polyline >
< / svg >
< / symbol >
< symbol id = "svg-sun" viewBox = "0 0 24 24" >
< title > Light mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
< circle cx = "12" cy = "12" r = "5" > < / circle >
< line x1 = "12" y1 = "1" x2 = "12" y2 = "3" > < / line >
< line x1 = "12" y1 = "21" x2 = "12" y2 = "23" > < / line >
< line x1 = "4.22" y1 = "4.22" x2 = "5.64" y2 = "5.64" > < / line >
< line x1 = "18.36" y1 = "18.36" x2 = "19.78" y2 = "19.78" > < / line >
< line x1 = "1" y1 = "12" x2 = "3" y2 = "12" > < / line >
< line x1 = "21" y1 = "12" x2 = "23" y2 = "12" > < / line >
< line x1 = "4.22" y1 = "19.78" x2 = "5.64" y2 = "18.36" > < / line >
< line x1 = "18.36" y1 = "5.64" x2 = "19.78" y2 = "4.22" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-moon" viewBox = "0 0 24 24" >
< title > Dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< path d = "M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" / >
< / svg >
< / symbol >
< symbol id = "svg-sun-half" viewBox = "0 0 24 24" >
< title > Auto light/dark mode< / title >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" fill = "none" stroke = "currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< circle cx = "12" cy = "12" r = "9" / >
< path d = "M13 12h5" / >
< path d = "M13 15h4" / >
< path d = "M13 18h1" / >
< path d = "M13 9h4" / >
< path d = "M13 6h1" / >
< / svg >
< / symbol >
< / svg >
< input type = "checkbox" class = "sidebar-toggle" name = "__navigation" id = "__navigation" >
< input type = "checkbox" class = "sidebar-toggle" name = "__toc" id = "__toc" >
< label class = "overlay sidebar-overlay" for = "__navigation" >
< div class = "visually-hidden" > Hide navigation sidebar< / div >
< / label >
< label class = "overlay toc-overlay" for = "__toc" >
< div class = "visually-hidden" > Hide table of contents sidebar< / div >
< / label >
< div class = "page" >
< header class = "mobile-header" >
< div class = "header-left" >
< label class = "nav-overlay-icon" for = "__navigation" >
< div class = "visually-hidden" > Toggle site navigation sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-menu" > < / use > < / svg > < / i >
< / label >
< / div >
< div class = "header-center" >
< a href = "../../" > < div class = "brand" > Gymnasium Documentation< / div > < / a >
< / div >
< div class = "header-right" >
< div class = "theme-toggle-container theme-toggle-header" >
< button class = "theme-toggle" >
< div class = "visually-hidden" > Toggle Light / Dark / Auto color theme< / div >
< svg class = "theme-icon-when-auto" > < use href = "#svg-sun-half" > < / use > < / svg >
< svg class = "theme-icon-when-dark" > < use href = "#svg-moon" > < / use > < / svg >
< svg class = "theme-icon-when-light" > < use href = "#svg-sun" > < / use > < / svg >
< / button >
< / div >
< label class = "toc-overlay-icon toc-header-icon" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< / header >
< aside class = "sidebar-drawer" >
< div class = "sidebar-container" >
2022-10-03 15:02:45 +00:00
< div class = "sidebar-sticky" > < form class = "sidebar-search-container" method = "get" action = "../../search/" role = "search" >
2022-09-13 19:29:14 +00:00
< 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 = "../../content/basic_usage/" > Basic Usage< / a > < / li >
2022-10-12 15:02:33 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../content/gym_compatibility/" > Compatibility with Gym< / a > < / li >
2022-10-24 21:46:22 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../content/migration-guide/" > v21 to v26 Migration Guide< / a > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > API< / span > < / p >
< ul class = "current" >
2022-10-12 15:02:09 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../env/" > Env< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../registry/" > Registry< / a > < / li >
2022-09-16 13:02:04 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../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 child pages in navigation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../spaces/fundamental/" > Fundamental Spaces< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../spaces/composite/" > Composite Spaces< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../spaces/utils/" > Spaces Utils< / a > < / li >
2022-10-12 15:02:09 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../spaces/vector_utils/" > Spaces Vector Utils< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../wrappers/" > Wrappers< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-2" name = "toctree-checkbox-2" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-2" > < div class = "visually-hidden" > Toggle child pages in navigation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "../wrappers/misc_wrappers/" > Misc Wrappers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../wrappers/action_wrappers/" > Action Wrappers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../wrappers/observation_wrappers/" > Observation Wrappers< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../wrappers/reward_wrappers/" > Reward Wrappers< / a > < / li >
2022-09-16 13:02:04 +00:00
< / ul >
< / li >
2022-09-13 19:29:14 +00:00
< li class = "toctree-l1 current current-page" > < a class = "current reference internal" href = "#" > Vector< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../utils/" > Utils< / a > < / li >
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Environments< / span > < / p >
< ul >
2022-10-27 14:56:52 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/classic_control/" > Classic Control< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-3" name = "toctree-checkbox-3" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-3" > < div class = "visually-hidden" > Toggle child pages in navigation< / 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 >
2022-10-12 15:02:09 +00:00
< / ul >
< / li >
2022-10-27 14:56:52 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/box2d/" > Box2D< / 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 child pages in navigation< / 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 >
2022-10-12 15:02:09 +00:00
< / ul >
< / li >
2022-10-27 14:56:52 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/toy_text/" > Toy Text< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-5" name = "toctree-checkbox-5" role = "switch" type = "checkbox" / > < label for = "toctree-checkbox-5" > < div class = "visually-hidden" > Toggle child pages in navigation< / 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 >
2022-10-12 15:02:09 +00:00
< / ul >
< / li >
2022-10-27 14:56:52 +00:00
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/mujoco/" > MuJoCo< / 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 child pages in navigation< / 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_standup/" > Humanoid Standup< / 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/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/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/pusher/" > Pusher< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/mujoco/walker2d/" > Walker2D< / a > < / li >
2022-10-12 15:02:09 +00:00
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/atari/" > Atari< / 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 child pages in navigation< / div > < i class = "icon" > < svg > < use href = "#svg-arrow-right" > < / use > < / svg > < / i > < / label > < ul >
2022-09-13 19:29:14 +00:00
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/adventure/" > Adventure< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/air_raid/" > Air Raid< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/alien/" > Alien< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/amidar/" > Amidar< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/assault/" > Assault< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/asterix/" > Asterix< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/asteroids/" > Asteroids< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/atlantis/" > Atlantis< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/bank_heist/" > Bank Heist< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/battle_zone/" > Battle Zone< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/beam_rider/" > Beam Rider< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/berzerk/" > Berzerk< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/bowling/" > Bowling< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/boxing/" > Boxing< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/breakout/" > Breakout< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/carnival/" > Carnival< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/centipede/" > Centipede< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/chopper_command/" > Chopper Command< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/crazy_climber/" > Crazy Climber< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/defender/" > Defender< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/demon_attack/" > Demon Attack< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/double_dunk/" > Double Dunk< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/elevator_action/" > Elevator Action< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/enduro/" > Enduro< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/fishing_derby/" > FishingDerby< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/freeway/" > Freeway< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/frostbite/" > Frostbite< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/gopher/" > Gopher< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/gravitar/" > Gravitar< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/hero/" > Hero< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/ice_hockey/" > IceHockey< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/jamesbond/" > Jamesbond< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/journey_escape/" > JourneyEscape< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/kangaroo/" > Kangaroo< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/krull/" > Krull< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/kung_fu_master/" > Kung Fu Master< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/montezuma_revenge/" > Montezuma Revenge< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/ms_pacman/" > Ms Pacman< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/name_this_game/" > Name This Game< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/phoenix/" > Phoenix< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/pitfall/" > Pitfall< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/pong/" > Pong< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/pooyan/" > Pooyan< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/private_eye/" > PrivateEye< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/qbert/" > Qbert< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/riverraid/" > Riverraid< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/road_runner/" > Road Runner< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/robotank/" > Robot Tank< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/seaquest/" > Seaquest< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/skiing/" > Skiings< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/solaris/" > Solaris< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/space_invaders/" > SpaceInvaders< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/star_gunner/" > StarGunner< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/tennis/" > Tennis< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/time_pilot/" > TimePilot< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/tutankham/" > Tutankham< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/up_n_down/" > Up n’ < / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/venture/" > Venture< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/video_pinball/" > Video Pinball< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/wizard_of_wor/" > Wizard of Wor< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "../../environments/atari/zaxxon/" > Zaxxon< / a > < / li >
< / ul >
< / li >
2022-10-10 15:25:54 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../environments/third_party_environments/" > Third-Party Environments< / a > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Tutorials< / span > < / p >
< ul >
2022-10-23 10:45:24 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../tutorials/blackjack_tutorial/" > Solving Blackjack with Q-Learning< / a > < / li >
2022-10-21 15:39:00 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../tutorials/environment_creation/" > Make your own custom environment< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../tutorials/handling_time_limits/" > Handling Time Limits< / a > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Development< / span > < / p >
< ul >
2022-09-16 13:02:04 +00:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/Farama-Foundation/Gymnasium" > Github< / a > < / li >
2022-10-25 11:10:26 +00:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md" > Contribute to the Docs< / a > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / div >
< / div >
< / div >
< / div >
< / aside >
< 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" >
2022-10-03 15:02:45 +00:00
2022-10-08 23:42:10 +00:00
< div class = "edit-this-page" >
< a class = "muted-link" href = "https://github.com/Farama-Foundation/Gymnasium/edit/main/docs/api/vector.md" title = "Edit this page" >
2022-10-03 15:02:45 +00:00
< svg aria-hidden = "true" viewBox = "0 0 24 24" stroke-width = "1.5" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" >
< path stroke = "none" d = "M0 0h24v24H0z" fill = "none" / >
< path d = "M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" / >
< line x1 = "13.5" y1 = "6.5" x2 = "17.5" y2 = "10.5" / >
< / svg >
< span class = "visually-hidden" > Edit this page< / span >
< / a >
< / div > < div class = "theme-toggle-container theme-toggle-content" >
2022-09-13 19:29:14 +00:00
< 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-content-icon" for = "__toc" >
< div class = "visually-hidden" > Toggle table of contents sidebar< / div >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
< / div >
< article role = "main" >
2022-10-03 15:02:45 +00:00
2022-09-13 19:29:14 +00:00
< section id = "vector" >
< h1 > Vector< a class = "headerlink" href = "#vector" title = "Permalink to this heading" > #< / a > < / h1 >
2022-10-12 15:02:09 +00:00
< section id = "gymnasium-vector-vectorenv" >
< h2 > Gymnasium.vector.VectorEnv< a class = "headerlink" href = "#gymnasium-vector-vectorenv" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "gymnasium.vector.VectorEnv" >
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.vector.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > VectorEnv< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > num_envs< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > int< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > observation_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > action_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.VectorEnv" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Base class for vectorized environments to run multiple independent copies of the same environment in parallel.< / p >
< p > Vector environments can provide a linear speed-up in the steps taken per second through sampling multiple
sub-environments at the same time. To prevent terminated environments waiting until all sub-environments have
terminated or truncated, the vector environments autoreset sub-environments after they terminate or truncated.
As a result, the final step’ ’
Therefore, the observation and info for the final step of a sub-environment is stored in the info parameter,
using < cite > “final_observation”< / cite > and < cite > “final_info”< / cite > respectively. See < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.step" title = "gymnasium.vector.VectorEnv.step" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > step()< / span > < / code > < / a > for more information.< / p >
< p > The vector environments batch < cite > observations< / cite > , < cite > rewards< / cite > , < cite > terminations< / cite > , < cite > truncations< / cite > and < cite > info< / cite > for each
parallel environment. In addition, < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.step" title = "gymnasium.vector.VectorEnv.step" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > step()< / span > < / code > < / a > expects to receive a batch of actions for each parallel environment.< / p >
< p > Gymnasium contains two types of Vector environments: < a class = "reference internal" href = "#gymnasium.vector.AsyncVectorEnv" title = "gymnasium.vector.AsyncVectorEnv" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > AsyncVectorEnv< / span > < / code > < / a > and < a class = "reference internal" href = "#gymnasium.vector.SyncVectorEnv" title = "gymnasium.vector.SyncVectorEnv" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > SyncVectorEnv< / span > < / code > < / a > .< / p >
< p > The Vector Environments have the additional attributes for users to understand the implementation< / p >
< ul class = "simple" >
< li > < p > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > num_envs< / span > < / code > - The number of sub-environment in the vector environment< / p > < / li >
< li > < p > < a class = "reference internal" href = "#observation_space" title = "observation_space" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > observation_space< / span > < / code > < / a > - The batched observation space of the vector environment< / p > < / li >
< li > < p > < a class = "reference internal" href = "#single_observation_space" title = "single_observation_space" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > single_observation_space< / span > < / code > < / a > - The observation space of a single sub-environment< / p > < / li >
< li > < p > < a class = "reference internal" href = "#action_space" title = "action_space" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > action_space< / span > < / code > < / a > - The batched action space of the vector environment< / p > < / li >
< li > < p > < a class = "reference internal" href = "#single_action_space" title = "single_action_space" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > single_action_space< / span > < / code > < / a > - The action space of a single sub-environment< / p > < / li >
< / ul >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > The info parameter of < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.reset" title = "gymnasium.vector.VectorEnv.reset" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > reset()< / span > < / code > < / a > and < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.step" title = "gymnasium.vector.VectorEnv.step" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > step()< / span > < / code > < / a > was originally implemented before OpenAI Gym v25 was a list
of dictionary for each sub-environment. However, this was modified in OpenAI Gym v25+ and in Gymnasium to a
dictionary with a NumPy array for each key. To use the old info style using the < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > VectorListInfo< / span > < / code > .< / p >
2022-09-13 19:29:14 +00:00
< / div >
2022-10-12 15:02:09 +00:00
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > To render the sub-environments, use < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > call()< / span > < / code > with “render” arguments. Remember to set the < cite > render_modes< / cite >
for all the sub-environments during initialization.< / p >
< / div >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > All parallel environments should share the identical observation and action spaces.
In other words, a vector of multiple different environments is not supported.< / p >
< / div >
< p > Base class for vectorized environments.< / p >
2022-09-13 19:29:14 +00:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < ul class = "simple" >
2022-10-12 15:02:09 +00:00
< li > < p > < strong > num_envs< / strong > – < / p > < / li >
< li > < p > < strong > observation_space< / strong > – < / p > < / li >
< li > < p > < strong > action_space< / strong > – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< section id = "methods" >
< h3 > Methods< a class = "headerlink" href = "#methods" title = "Permalink to this heading" > #< / a > < / h3 >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "gymnasium.vector.VectorEnv.reset" >
< span class = "sig-prename descclassname" > < span class = "pre" > VectorEnv.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > reset< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "o" > < span class = "pre" > *< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > seed< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > int< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > List< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > int< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > options< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.VectorEnv.reset" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Reset all parallel environments and return a batch of initial observations and info.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > seed< / strong > – < / p > < / li >
< li > < p > < strong > options< / strong > – < / p > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / dd >
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
2022-10-12 15:02:09 +00:00
< dd class = "field-even" > < p > < strong > A batch of observations and info from the vectorized environment.< / strong > < / p >
< / dd >
< / dl >
< p > An example:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > gymnasium< / span > < span class = "k" > as< / span > < span class = "nn" > gym< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "go" > (array([[-0.02240574, -0.03439831, -0.03904812, 0.02810693],< / span >
< span class = "go" > [ 0.01586068, 0.01929009, 0.02394426, 0.04016077],< / span >
< span class = "go" > [-0.01314174, 0.03893502, -0.02400815, 0.0038326 ]],< / span >
< span class = "go" > dtype=float32), {})< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "gymnasium.vector.VectorEnv.step" >
< span class = "sig-prename descclassname" > < span class = "pre" > VectorEnv.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > step< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > actions< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.VectorEnv.step" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Take an action for each parallel environment.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < p > < strong > actions< / strong > – < a class = "reference internal" href = "#action_space" title = "action_space" > < code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > action_space< / span > < / code > < / a > Batch of actions.< / p >
< / dd >
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
< dd class = "field-even" > < p > < strong > Batch of< / strong > (< em > observations, rewards, terminations, truncations, infos< / em > )< / p >
< / dd >
< / dl >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > As the vector environments autoreset for a terminating and truncating sub-environments,
the returned observation and info is not the final step’
info as < cite > “final_observation”< / cite > and < cite > “final_info”< / cite > .< / p >
< / div >
< p > An example:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "gp" > > > > < / span > < span class = "n" > actions< / span > < span class = "o" > =< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "mi" > 1< / span > < span class = "p" > ])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > observations< / span > < span class = "p" > ,< / span > < span class = "n" > rewards< / span > < span class = "p" > ,< / span > < span class = "n" > termination< / span > < span class = "p" > ,< / span > < span class = "n" > truncation< / span > < span class = "p" > ,< / span > < span class = "n" > infos< / span > < span class = "o" > =< / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > step< / span > < span class = "p" > (< / span > < span class = "n" > actions< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > observations< / span >
< span class = "go" > array([[ 0.00122802, 0.16228443, 0.02521779, -0.23700266],< / span >
< span class = "go" > [ 0.00788269, -0.17490888, 0.03393489, 0.31735462],< / span >
< span class = "go" > [ 0.04918966, 0.19421194, 0.02938497, -0.29495203]],< / span >
< span class = "go" > dtype=float32)< / span >
< span class = "gp" > > > > < / span > < span class = "n" > rewards< / span >
< span class = "go" > array([1., 1., 1.])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > termination< / span >
< span class = "go" > array([False, False, False])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > termination< / span >
< span class = "go" > array([False, False, False])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > infos< / span >
< span class = "go" > {}< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "gymnasium.vector.VectorEnv.close" >
< span class = "sig-prename descclassname" > < span class = "pre" > VectorEnv.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > close< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "o" > < span class = "pre" > **< / span > < / span > < span class = "n" > < span class = "pre" > kwargs< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.VectorEnv.close" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Close all parallel environments and release resources.< / p >
< p > It also closes all the existing image viewers, then calls < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > close_extras()< / span > < / code > and set
< code class = "xref py py-attr docutils literal notranslate" > < span class = "pre" > closed< / span > < / code > as < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > .< / p >
< div class = "admonition warning" >
< p class = "admonition-title" > Warning< / p >
< p > This function itself does not close the environments, it should be handled
in < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > close_extras()< / span > < / code > . This is generic for both synchronous and asynchronous
vectorized environments.< / p >
< / div >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > This will be automatically called when garbage collected or program exited.< / p >
< / div >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < p > < strong > **kwargs< / strong > – < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > close_extras()< / span > < / code > < / p >
2022-09-13 19:29:14 +00:00
< / dd >
< / dl >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< / section >
< section id = "attributes" >
< h3 > Attributes< a class = "headerlink" href = "#attributes" title = "Permalink to this heading" > #< / a > < / h3 >
2022-09-13 19:29:14 +00:00
< dl class = "py attribute" >
2022-10-12 15:02:09 +00:00
< dt class = "sig sig-object py" id = "action_space" >
< span class = "sig-name descname" > < span class = "pre" > action_space< / span > < / span > < a class = "headerlink" href = "#action_space" title = "Permalink to this definition" > #< / a > < / dt >
2022-09-13 19:29:14 +00:00
< dd > < p > The (batched) action space. The input actions of < cite > step< / cite > must be valid elements of < cite > action_space< / cite > .:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gymnasium< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > action_space< / span >
< span class = "go" > MultiDiscrete([2 2 2])< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py attribute" >
2022-10-12 15:02:09 +00:00
< dt class = "sig sig-object py" id = "observation_space" >
< span class = "sig-name descname" > < span class = "pre" > observation_space< / span > < / span > < a class = "headerlink" href = "#observation_space" title = "Permalink to this definition" > #< / a > < / dt >
2022-09-13 19:29:14 +00:00
< dd > < p > The (batched) observation space. The observations returned by < cite > reset< / cite > and < cite > step< / cite > are valid elements of < cite > observation_space< / cite > .:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gymnasium< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > observation_space< / span >
< span class = "go" > Box([[-4.8 ...]], [[4.8 ...]], (3, 4), float32)< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py attribute" >
2022-10-12 15:02:09 +00:00
< dt class = "sig sig-object py" id = "single_action_space" >
< span class = "sig-name descname" > < span class = "pre" > single_action_space< / span > < / span > < a class = "headerlink" href = "#single_action_space" title = "Permalink to this definition" > #< / a > < / dt >
2022-09-13 19:29:14 +00:00
< dd > < p > The action space of an environment copy.:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gymnasium< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > single_action_space< / span >
< span class = "go" > Discrete(2)< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py attribute" >
2022-10-12 15:02:09 +00:00
< dt class = "sig sig-object py" id = "single_observation_space" >
< span class = "sig-name descname" > < span class = "pre" > single_observation_space< / span > < / span > < a class = "headerlink" href = "#single_observation_space" title = "Permalink to this definition" > #< / a > < / dt >
2022-09-13 19:29:14 +00:00
< dd > < p > The observation space of an environment copy.:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > =< / span > < span class = "n" > gymnasium< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " CartPole-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > envs< / span > < span class = "o" > .< / span > < span class = "n" > single_action_space< / span >
< span class = "go" > Box([-4.8 ...], [4.8 ...], (4,), float32)< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< / section >
< / section >
< section id = "making-vector-environments" >
< h2 > Making Vector Environments< a class = "headerlink" href = "#making-vector-environments" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.vector.make" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.vector.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > make< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > id< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > str< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > num_envs< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > int< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > 1< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > asynchronous< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > wrappers< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > callable< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > List< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > callable< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > disable_env_checker< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "o" > < span class = "pre" > **< / span > < / span > < span class = "n" > < span class = "pre" > kwargs< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < span class = "sig-return" > < span class = "sig-return-icon" > → < / span > < span class = "sig-return-typehint" > < a class = "reference internal" href = "#gymnasium.vector.VectorEnv" title = "gymnasium.vector.vector_env.VectorEnv" > < span class = "pre" > VectorEnv< / span > < / a > < / span > < / span > < a class = "headerlink" href = "#gymnasium.vector.make" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Create a vectorized environment from multiple copies of an environment, from its id.< / p >
< p > Example:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > gymnasium< / span > < span class = "k" > as< / span > < span class = "nn" > gym< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > =< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s1" > ' CartPole-v1' < / span > < span class = "p" > ,< / span > < span class = "n" > num_envs< / span > < span class = "o" > =< / span > < span class = "mi" > 3< / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "go" > array([[-0.04456399, 0.04653909, 0.01326909, -0.02099827],< / span >
< span class = "go" > [ 0.03073904, 0.00145001, -0.03088818, -0.03131252],< / span >
< span class = "go" > [ 0.03468829, 0.01500225, 0.01230312, 0.01825218]],< / span >
< span class = "go" > dtype=float32)< / span >
< / pre > < / div >
< / div >
2022-09-13 19:29:14 +00:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < ul class = "simple" >
2022-10-12 15:02:09 +00:00
< li > < p > < strong > id< / strong > – < / p > < / li >
< li > < p > < strong > num_envs< / strong > – < / p > < / li >
< li > < p > < strong > asynchronous< / strong > – < cite > True< / cite > , wraps the environments in an < a class = "reference internal" href = "#gymnasium.vector.AsyncVectorEnv" title = "gymnasium.vector.AsyncVectorEnv" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > AsyncVectorEnv< / span > < / code > < / a > (which uses < cite > multiprocessing< / cite > to run the environments in parallel). If < code class = "docutils literal notranslate" > < span class = "pre" > False< / span > < / code > , wraps the environments in a < a class = "reference internal" href = "#gymnasium.vector.SyncVectorEnv" title = "gymnasium.vector.SyncVectorEnv" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > SyncVectorEnv< / span > < / code > < / a > .< / p > < / li >
< li > < p > < strong > wrappers< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > , then apply the wrappers to each internal environment during creation.< / p > < / li >
< li > < p > < strong > disable_env_checker< / strong > – < cite > disable_env_checker< / cite > parameter
(that is by default False), otherwise will run according to this argument (True = not run, False = run)< / p > < / li >
< li > < p > < strong > **kwargs< / strong > – < cite > gym.make< / cite > < / p > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / dd >
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
2022-10-12 15:02:09 +00:00
< dd class = "field-even" > < p > < strong > The vectorized environment.< / strong > < / p >
2022-09-13 19:29:14 +00:00
< / dd >
< / dl >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< / section >
< section id = "async-vector-env" >
< h2 > Async Vector Env< a class = "headerlink" href = "#async-vector-env" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "gymnasium.vector.AsyncVectorEnv" >
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.vector.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > AsyncVectorEnv< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > env_fns< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Sequence< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > callable< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > observation_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > action_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > shared_memory< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > copy< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > context< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > str< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > daemon< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > worker< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > callable< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.AsyncVectorEnv" title = "Permalink to t
< dd > < p > Vectorized environment that runs multiple environments in parallel.< / p >
< p > It uses < code class = "docutils literal notranslate" > < span class = "pre" > multiprocessing< / span > < / code > processes, and pipes for communication.< / p >
< p > Example:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > gymnasium< / span > < span class = "k" > as< / span > < span class = "nn" > gym< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > =< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > AsyncVectorEnv< / span > < span class = "p" > ([< / span >
< span class = "gp" > ... < / span > < span class = "k" > lambda< / span > < span class = "p" > :< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " Pendulum-v0" < / span > < span class = "p" > ,< / span > < span class = "n" > g< / span > < span class = "o" > =< / span > < span class = "mf" > 9.81< / span > < span class = "p" > ),< / span >
< span class = "gp" > ... < / span > < span class = "k" > lambda< / span > < span class = "p" > :< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " Pendulum-v0" < / span > < span class = "p" > ,< / span > < span class = "n" > g< / span > < span class = "o" > =< / span > < span class = "mf" > 1.62< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "p" > ])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "go" > array([[-0.8286432 , 0.5597771 , 0.90249056],< / span >
< span class = "go" > [-0.85009176, 0.5266346 , 0.60007906]], dtype=float32)< / span >
2022-09-13 19:29:14 +00:00
< / pre > < / div >
< / div >
2022-10-12 15:02:09 +00:00
< p > Vectorized environment that runs multiple environments in parallel.< / p >
2022-09-13 19:29:14 +00:00
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
2022-10-12 15:02:09 +00:00
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > env_fns< / strong > – < / p > < / li >
< li > < p > < strong > observation_space< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ,
then the observation space of the first environment is taken.< / p > < / li >
< li > < p > < strong > action_space< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ,
then the action space of the first environment is taken.< / p > < / li >
< li > < p > < strong > shared_memory< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > , then the observations from the worker processes are communicated back through
shared variables. This can improve the efficiency if the observations are large (e.g. images).< / p > < / li >
< li > < p > < strong > copy< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > , then the < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > reset()< / span > < / code > and < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > step()< / span > < / code > methods
return a copy of the observations.< / p > < / li >
< li > < p > < strong > context< / strong > – < a href = "#id1" > < span class = "problematic" id = "id2" > `multiprocessing`_< / span > < / a > . If < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > , then the default context is used.< / p > < / li >
< li > < p > < strong > daemon< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > , then subprocesses have < code class = "docutils literal notranslate" > < span class = "pre" > daemon< / span > < / code > flag turned on; that is, they will quit if
the head process quits. However, < code class = "docutils literal notranslate" > < span class = "pre" > daemon=True< / span > < / code > prevents subprocesses to spawn children,
so for some environments you may want to have it set to < code class = "docutils literal notranslate" > < span class = "pre" > False< / span > < / code > .< / p > < / li >
< li > < p > < strong > worker< / strong > –
Can be useful to override some inner vector env logic, for instance, how resets on termination or truncation are handled.< / p > < / li >
< / ul >
2022-09-13 19:29:14 +00:00
< / dd >
2022-10-12 15:02:09 +00:00
< / dl >
< dl class = "simple" >
< dt > Warnings: worker is an advanced mode option. It provides a high degree of flexibility and a high chance< / dt > < dd > < p > to shoot yourself in the foot; thus, if you are writing your own worker, it is recommended to start
from the code for < code class = "docutils literal notranslate" > < span class = "pre" > _worker< / span > < / code > (or < code class = "docutils literal notranslate" > < span class = "pre" > _worker_shared_memory< / span > < / code > ) method, and add changes.< / p >
< / dd >
< / dl >
< dl class = "field-list simple" >
< dt class = "field-odd" > Raises< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > RuntimeError< / strong > –
(or, by default, the observation space of the first sub-environment).< / p > < / li >
< li > < p > < strong > ValueError< / strong > –
such as gymnasium.spaces.Box, gymnasium.spaces.Discrete, or gymnasium.spaces.Dict) and shared_memory is True.< / p > < / li >
< / ul >
2022-09-13 19:29:14 +00:00
< / dd >
< / dl >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< / section >
< section id = "sync-vector-env" >
< h2 > Sync Vector Env< a class = "headerlink" href = "#sync-vector-env" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "gymnasium.vector.SyncVectorEnv" >
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.vector.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > SyncVectorEnv< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > env_fns< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Iterator< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Callable< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < a class = "reference internal" href = "../env/#gymnasium.Env" title = "gymnasium.core.Env" > < span class = "pre" > Env< / span > < / a > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > observation_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > action_space< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < a class = "reference internal" href = "../spaces/#gymnasium.spaces.Space" title = "gymnasium.spaces.space.Space" > < span class = "pre" > Space< / span > < / a > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > None< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > copy< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < span class = "w" > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "w" > < / span > < span class = "default_value" > < span class = "pre" > True< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.vector.SyncVectorEnv" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Vectorized environment that serially runs multiple environments.< / p >
< p > Example:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "kn" > import< / span > < span class = "nn" > gymnasium< / span > < span class = "k" > as< / span > < span class = "nn" > gym< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > =< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > vector< / span > < span class = "o" > .< / span > < span class = "n" > SyncVectorEnv< / span > < span class = "p" > ([< / span >
< span class = "gp" > ... < / span > < span class = "k" > lambda< / span > < span class = "p" > :< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " Pendulum-v0" < / span > < span class = "p" > ,< / span > < span class = "n" > g< / span > < span class = "o" > =< / span > < span class = "mf" > 9.81< / span > < span class = "p" > ),< / span >
< span class = "gp" > ... < / span > < span class = "k" > lambda< / span > < span class = "p" > :< / span > < span class = "n" > gym< / span > < span class = "o" > .< / span > < span class = "n" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " Pendulum-v0" < / span > < span class = "p" > ,< / span > < span class = "n" > g< / span > < span class = "o" > =< / span > < span class = "mf" > 1.62< / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "p" > ])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "go" > array([[-0.8286432 , 0.5597771 , 0.90249056],< / span >
< span class = "go" > [-0.85009176, 0.5266346 , 0.60007906]], dtype=float32)< / span >
2022-09-13 19:29:14 +00:00
< / pre > < / div >
< / div >
2022-10-12 15:02:09 +00:00
< p > Vectorized environment that serially runs multiple environments.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < ul class = "simple" >
< li > < p > < strong > env_fns< / strong > – < / p > < / li >
< li > < p > < strong > observation_space< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ,
then the observation space of the first environment is taken.< / p > < / li >
< li > < p > < strong > action_space< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > ,
then the action space of the first environment is taken.< / p > < / li >
< li > < p > < strong > copy< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > , then the < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > reset()< / span > < / code > and < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > step()< / span > < / code > methods return a copy of the observations.< / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raises< span class = "colon" > :< / span > < / dt >
< dd class = "field-even" > < p > < strong > RuntimeError< / strong > –
(or, by default, the observation space of the first sub-environment).< / p >
< / dd >
< / dl >
< / dd > < / dl >
2022-09-13 19:29:14 +00:00
< / section >
< / section >
< / article >
< / div >
< footer >
< div class = "related-pages" >
< a class = "next-page" href = "../utils/" >
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
< div class = "title" > Utils< / div >
< / div >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
2022-10-12 15:02:09 +00:00
< a class = "prev-page" href = "../wrappers/reward_wrappers/" >
2022-09-13 19:29:14 +00:00
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< div class = "page-info" >
< div class = "context" >
< span > Previous< / span >
< / div >
2022-10-12 15:02:09 +00:00
< div class = "title" > Reward Wrappers< / div >
2022-09-13 19:29:14 +00:00
< / div >
< / a >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
2022-10-23 09:15:41 +00:00
Copyright © 2022 Farama Foundation
2022-09-13 19:29:14 +00:00
< / div >
2022-10-15 15:13:56 +00:00
<!--
2022-09-13 19:29:14 +00:00
Made with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > and < a class = "muted-link" href = "https://pradyunsg.me" > @pradyunsg< / a > 's
< a href = "https://github.com/pradyunsg/furo" > Furo< / a >
2022-10-15 15:13:56 +00:00
-->
2022-09-13 19:29:14 +00:00
< / div >
< div class = "right-details" >
< div class = "icons" >
2022-10-19 14:22:38 +00:00
2022-09-13 19:29:14 +00:00
< / div >
< / div >
< / div >
< / footer >
< / div >
< aside class = "toc-drawer" >
< div class = "toc-sticky toc-scroll" >
< div class = "toc-title-container" >
< span class = "toc-title" >
On this page
< / span >
< / div >
< div class = "toc-tree-container" >
< div class = "toc-tree" >
< ul >
< li > < a class = "reference internal" href = "#" > Vector< / a > < ul >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium-vector-vectorenv" > Gymnasium.vector.VectorEnv< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.vector.VectorEnv" > < code class = "docutils literal notranslate" > < span class = "pre" > VectorEnv< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#methods" > Methods< / a > < ul >
2022-09-25 14:44:48 +00:00
< li > < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.reset" > < code class = "docutils literal notranslate" > < span class = "pre" > VectorEnv.reset()< / span > < / code > < / a > < / li >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.step" > < code class = "docutils literal notranslate" > < span class = "pre" > VectorEnv.step()< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#gymnasium.vector.VectorEnv.close" > < code class = "docutils literal notranslate" > < span class = "pre" > VectorEnv.close()< / span > < / code > < / a > < / li >
2022-09-25 14:44:48 +00:00
< / ul >
< / li >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#attributes" > Attributes< / a > < ul >
< li > < a class = "reference internal" href = "#action_space" > < code class = "docutils literal notranslate" > < span class = "pre" > action_space< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#observation_space" > < code class = "docutils literal notranslate" > < span class = "pre" > observation_space< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#single_action_space" > < code class = "docutils literal notranslate" > < span class = "pre" > single_action_space< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#single_observation_space" > < code class = "docutils literal notranslate" > < span class = "pre" > single_observation_space< / span > < / code > < / a > < / li >
< / ul >
< / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#making-vector-environments" > Making Vector Environments< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.vector.make" > < code class = "docutils literal notranslate" > < span class = "pre" > make()< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#async-vector-env" > Async Vector Env< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.vector.AsyncVectorEnv" > < code class = "docutils literal notranslate" > < span class = "pre" > AsyncVectorEnv< / span > < / code > < / a > < / li >
2022-09-25 14:44:48 +00:00
< / ul >
< / li >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#sync-vector-env" > Sync Vector Env< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.vector.SyncVectorEnv" > < code class = "docutils literal notranslate" > < span class = "pre" > SyncVectorEnv< / span > < / code > < / a > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / div >
< / aside >
< / div >
2022-10-03 15:02:45 +00:00
< / div >
< script >
let toggleMenu = () => {
document.querySelector(".farama-header-menu").classList.toggle("active");
document.querySelector(".farama-header-menu__overlay").classList.toggle("active");
}
document.querySelector(".farama-header-menu__btn").addEventListener("click", toggleMenu);
document.getElementById("farama-close-menu").addEventListener("click", toggleMenu);
document.querySelector(".farama-header-menu__overlay").addEventListener("click", toggleMenu);
window.onclick = function(event) {
if (!event.target.matches('.farama-header-menu__btn')) {
2022-10-15 15:13:56 +00:00
const dropdown = document.querySelector(".farama-header-menu-container");
2022-10-03 15:02:45 +00:00
if (dropdown.classList.contains('active')) {
dropdown.classList.remove('active');
document.querySelector(".farama-header-menu__overlay").classList.remove("active");
}
}
}
< / script >
2022-10-13 10:54:57 +00:00
< script >
(() => {
if (!localStorage.getItem("shownCookieAlert")) {
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. You can disable it by blocking
the JavaScript coming from www.google-analytics.com.`;
containerElem.appendChild(textElem);
const closeBtn = document.createElement("button");
closeBtn.innerHTML = `<?xml version="1.0" ?> < svg viewBox = "0 0 32 32" xmlns = "http://www.w3.org/2000/svg" > < defs > < style > . cls-1 { fill : none ; stroke : #000 ; stroke-linecap : round ; stroke-linejoin : round ; stroke-width : 2 px ; } < / style > < / defs > < title / > < g id = "cross" > < line class = "cls-1" x1 = "7" x2 = "25" y1 = "7" y2 = "25" / > < line class = "cls-1" x1 = "7" x2 = "25" y1 = "25" y2 = "7" / > < / g > < / svg > `
closeBtn.onclick = () => {
localStorage.setItem("shownCookieAlert", "true");
boxElem.style.display = "none";
}
containerElem.appendChild(closeBtn);
boxElem.appendChild(containerElem);
document.body.appendChild(boxElem);
}
})()
< / script >
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-6H9C8TWXZ8" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-6H9C8TWXZ8');
< / script >
2022-10-03 15:02:45 +00:00
< script data-url_root = "../../" id = "documentation_options" src = "../../_static/documentation_options.js" > < / script >
2022-09-13 19:29:14 +00:00
< script src = "../../_static/jquery.js" > < / script >
< script src = "../../_static/underscore.js" > < / script >
< script src = "../../_static/_sphinx_javascript_frameworks_compat.js" > < / script >
< script src = "../../_static/doctools.js" > < / script >
2022-09-25 14:44:48 +00:00
< script src = "../../_static/sphinx_highlight.js" > < / script >
2022-09-13 19:29:14 +00:00
< script src = "../../_static/scripts/furo.js" > < / script >
2022-10-21 15:39:00 +00:00
2022-10-25 11:10:26 +00:00
< script >
const versioningConfig = {
githubUser: 'Farama-Foundation',
githubRepo: 'Gymnasium',
};
fetch('/_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 >
2022-09-13 19:29:14 +00:00
< / html >
