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-09-27 16:22:21 +00:00
< meta name = "color-scheme" content = "light dark" > < 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 = "Classic Control" href = "../../environments/classic_control/" / > < link rel = "prev" title = "Vector" href = "../vector/" / >
2022-09-13 19:29:14 +00:00
< link rel = "canonical" href = "https://gymnasium.farama.org/api/utils.html" / >
2022-10-03 15:02:45 +00:00
< link rel = "shortcut icon" href = "../../_static/favicon.png" / > < meta name = "generator" content = "sphinx-5.2.3, furo 2022.09.15.dev1" / >
2022-09-13 19:29:14 +00:00
< title > Utils - 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-08 23:42:10 +00:00
< link rel = "stylesheet" type = "text/css" href = "../../_static/styles/furo-extensions.css?digest=c2d5e51f39e130612d57e150aebc94239a19910f" / >
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" >
The Farama Foundation
< / 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 >
< div class = "farama-header-menu__list" >
< div class = "farama-header-menu-list__header" >
2022-10-05 17:10:20 +00:00
< a href = "https://farama.org" >
< img class = "farama-header-menu__logo" src = "../../_static/img/farama_solid_white.svg" >
< span > The Farama Foundation< / span >
< / 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 >
< div class = "farama-header-menu-list__body" >
< span class = "farama-header-menu__section-title" > Projects< / span >
< ul >
< li >
< a href = "https://gymnasium.farama.org" > Gymnasium< / a >
< / li >
< li >
< a href = "https://pettingzoo.farama.org" > PettingZoo< / a >
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/SuperSuit" > SuperSuit< / a >
< / li >
< li >
2022-10-05 17:10:20 +00:00
< a href = "https://github.com/Farama-Foundation/MiniGrid" > MiniGrid< / a >
2022-10-03 15:02:45 +00:00
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/gym-robotics" > Gymnasium-Robotics
< / a >
< / li >
< li >
2022-10-05 17:10:20 +00:00
< a href = "https://github.com/Farama-Foundation/tinyscaler" > Tinyscaler< / a >
2022-10-03 15:02:45 +00:00
< / li >
< li >
2022-10-05 17:10:20 +00:00
< a href = "https://github.com/Farama-Foundation/AutoROM" > AutoROM< / a >
2022-10-03 15:02:45 +00:00
< / li >
< li >
< a href = "https://github.com/Farama-Foundation/Jumpy" > JumPy< / a >
< / li >
< / ul >
< / 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-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" > < a class = "reference internal" href = "../vector/" > Vector< / a > < / li >
< li class = "toctree-l1 current current-page" > < a class = "current reference internal" href = "#" > Utils< / a > < / li >
< / ul >
< p class = "caption" role = "heading" > < span class = "caption-text" > Environments< / span > < / p >
< ul >
2022-10-12 15:02:09 +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 >
< / ul >
< / li >
< 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 >
< / ul >
< / li >
< li class = "toctree-l1 has-children" > < a class = "reference internal" href = "../../environments/toy_text/" > Toy Text< / a > < input class = "toctree-checkbox" id = "toctree-checkbox-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 >
< / ul >
< / li >
< 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 >
< / 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 >
< li class = "toctree-l1" > < a class = "reference internal" href = "../../content/environment_creation/" > Make your own custom environment< / a > < / li >
2022-10-12 15:02:09 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../content/vectorising/" > Vectorizing your environments< / a > < / li >
2022-09-27 16:22:21 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../../content/handling_timelimits/" > 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-09-13 19:29:14 +00:00
< li class = "toctree-l1" > < a class = "reference external" href = "https://farama.org/donations" > Donate< / a > < / li >
< / 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/utils.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 = "utils" >
< h1 > Utils< a class = "headerlink" href = "#utils" title = "Permalink to this heading" > #< / a > < / h1 >
< section id = "visualization" >
< h2 > Visualization< a class = "headerlink" href = "#visualization" title = "Permalink to this heading" > #< / a > < / h2 >
2022-10-12 15:02:09 +00:00
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.play.play" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.play.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > play< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > env< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < a class = "reference internal" href = "../env/#gymnasium.Env" title = "gymnasium.core.Env" > < span class = "pre" > Env< / span > < / a > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > transpose< / 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" > True< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > fps< / 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" > int< / 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" > zoom< / 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" > float< / 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" > callback< / 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 > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > keys_to_action< / 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 class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Tuple< / 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" > str< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > int< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > str< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ActType< / 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" > 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" > int< / span > < span
< dd > < p > Allows one to play the game using keyboard.< / 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 = "kn" > from< / span > < span class = "nn" > gymnasium.utils.play< / span > < span class = "kn" > import< / span > < span class = "n" > play< / span >
< span class = "gp" > > > > < / span > < span class = "n" > play< / 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" > " CarRacing-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > render_mode< / span > < span class = "o" > =< / span > < span class = "s2" > " rgb_array" < / span > < span class = "p" > ),< / span > < span class = "n" > keys_to_action< / span > < span class = "o" > =< / span > < span class = "p" > {< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " w" < / span > < span class = "p" > :< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "mf" > 0.7< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ]),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " a" < / span > < span class = "p" > :< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "o" > -< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ]),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " s" < / span > < span class = "p" > :< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "mi" > 0< / 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 = "s2" > " d" < / span > < span class = "p" > :< / 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" > 0< / span > < span class = "p" > ]),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " wa" < / span > < span class = "p" > :< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "o" > -< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span > < span class = "mf" > 0.7< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ]),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " dw" < / span > < span class = "p" > :< / 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 = "mf" > 0.7< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ]),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " ds" < / span > < span class = "p" > :< / 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 = "s2" > " as" < / span > < span class = "p" > :< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > array< / span > < span class = "p" > ([< / span > < span class = "o" > -< / 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 = "p" > },< / span > < span class = "n" > noop< / 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" > 0< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ,< / span > < span class = "mi" > 0< / span > < span class = "p" > ]))< / span >
< / pre > < / div >
< / div >
< p > Above code works also if the environment is wrapped, so it’
verifying that the frame-level preprocessing does not render the game
unplayable.< / p >
< p > If you wish to plot real time statistics as you play, you can use
< code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > gym.utils.play.PlayPlot< / span > < / code > . Here’
for last 150 steps.< / p >
< div class = "doctest 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 = "k" > def< / span > < span class = "nf" > callback< / span > < span class = "p" > (< / span > < span class = "n" > obs_t< / span > < span class = "p" > ,< / span > < span class = "n" > obs_tp1< / span > < span class = "p" > ,< / span > < span class = "n" > action< / span > < span class = "p" > ,< / span > < span class = "n" > rew< / span > < span class = "p" > ,< / span > < span class = "n" > terminated< / span > < span class = "p" > ,< / span > < span class = "n" > truncated< / span > < span class = "p" > ,< / span > < span class = "n" > info< / span > < span class = "p" > ):< / span >
< span class = "gp" > ... < / span > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > rew< / span > < span class = "p" > ,]< / span >
< span class = "gp" > > > > < / span > < span class = "n" > plotter< / span > < span class = "o" > =< / span > < span class = "n" > PlayPlot< / span > < span class = "p" > (< / span > < span class = "n" > callback< / span > < span class = "p" > ,< / span > < span class = "mi" > 150< / span > < span class = "p" > ,< / span > < span class = "p" > [< / span > < span class = "s2" > " reward" < / span > < span class = "p" > ])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > play< / 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" > " CartPole-v1" < / span > < span class = "p" > ),< / span > < span class = "n" > callback< / span > < span class = "o" > =< / span > < span class = "n" > plotter< / span > < span class = "o" > .< / span > < span class = "n" > callback< / span > < span class = "p" > )< / 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 > env< / strong > – < / p > < / li >
< li > < p > < strong > transpose< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > , the output of observation is transposed. Defaults to < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > .< / p > < / li >
< li > < p > < strong > fps< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > (the default),
< code class = "docutils literal notranslate" > < span class = "pre" > env.metadata[" render_fps" " ]< / span > < / code > (or 30, if the environment does not specify “render_fps”) is used.< / p > < / li >
< li > < p > < strong > zoom< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > zoom< / span > < / code > amount, should be positive float< / p > < / li >
< li > < p > < strong > callback< / strong > –
obs_t: observation before performing action
obs_tp1: observation after performing action
action: action that was executed
rew: reward that was received
terminated: whether the environment is terminated or not
truncated: whether the environment is truncated or not
info: debug info< / p > < / li >
< li > < p > < strong > keys_to_action< / strong > – < p > Mapping from keys pressed to action performed.
Different formats are supported: Key combinations can either be expressed as a tuple of unicode code
points of the keys, as a tuple of characters, or as a string where each character of the string represents
one key.
For example if pressing ‘ ’
to trigger action number 2 then < code class = "docutils literal notranslate" > < span class = "pre" > key_to_action< / span > < / code > dict could look like this:< / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "p" > {< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "p" > (< / span > < span class = "nb" > ord< / span > < span class = "p" > (< / span > < span class = "s1" > ' w' < / span > < span class = "p" > ),< / span > < span class = "nb" > ord< / span > < span class = "p" > (< / span > < span class = "s1" > ' ' < / span > < span class = "p" > )):< / span > < span class = "mi" > 2< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > or like this:< / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "p" > {< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "p" > (< / span > < span class = "s2" > " w" < / span > < span class = "p" > ,< / span > < span class = "s2" > " " < / span > < span class = "p" > ):< / span > < span class = "mi" > 2< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > or like this:< / p >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "p" > {< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " w " < / span > < span class = "p" > :< / span > < span class = "mi" > 2< / span >
< span class = "gp" > ... < / span > < span class = "c1" > # ...< / span >
< span class = "gp" > ... < / span > < span class = "p" > }< / span >
< / pre > < / div >
< / div >
< p > If < code class = "docutils literal notranslate" > < span class = "pre" > None< / span > < / code > , default < code class = "docutils literal notranslate" > < span class = "pre" > key_to_action< / span > < / code > mapping for that environment is used, if provided.< / p >
< / p > < / li >
< li > < p > < strong > seed< / strong > – < / p > < / li >
< li > < p > < strong > noop< / strong > – < / p > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py class" >
< dt class = "sig sig-object py" id = "gymnasium.utils.play.PlayPlot" >
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.play.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > PlayPlot< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > callback< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > callable< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > horizon_timesteps< / 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" > plot_names< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > List< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > str< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.utils.play.PlayPlot" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Provides a callback to create live plots of arbitrary metrics when using < a class = "reference internal" href = "#gymnasium.utils.play.play" title = "gymnasium.utils.play.play" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > play()< / span > < / code > < / a > .< / p >
< dl class = "simple" >
< dt > This class is instantiated with a function that accepts information about a single environment transition:< / dt > < dd > < ul class = "simple" >
< li > < p > obs_t: observation before performing action< / p > < / li >
< li > < p > obs_tp1: observation after performing action< / p > < / li >
< li > < p > action: action that was executed< / p > < / li >
< li > < p > rew: reward that was received< / p > < / li >
< li > < p > terminated: whether the environment is terminated or not< / p > < / li >
< li > < p > truncated: whether the environment is truncated or not< / p > < / li >
< li > < p > info: debug info< / p > < / li >
< / ul >
< / dd >
< / dl >
< p > It should return a list of metrics that are computed from this data.
For instance, the function may look like this:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "k" > def< / span > < span class = "nf" > compute_metrics< / span > < span class = "p" > (< / span > < span class = "n" > obs_t< / span > < span class = "p" > ,< / span > < span class = "n" > obs_tp< / span > < span class = "p" > ,< / span > < span class = "n" > action< / span > < span class = "p" > ,< / span > < span class = "n" > reward< / span > < span class = "p" > ,< / span > < span class = "n" > terminated< / span > < span class = "p" > ,< / span > < span class = "n" > truncated< / span > < span class = "p" > ,< / span > < span class = "n" > info< / span > < span class = "p" > ):< / span >
< span class = "gp" > ... < / span > < span class = "k" > return< / span > < span class = "p" > [< / span > < span class = "n" > reward< / span > < span class = "p" > ,< / span > < span class = "n" > info< / span > < span class = "p" > [< / span > < span class = "s2" > " cumulative_reward" < / span > < span class = "p" > ],< / span > < span class = "n" > np< / span > < span class = "o" > .< / span > < span class = "n" > linalg< / span > < span class = "o" > .< / span > < span class = "n" > norm< / span > < span class = "p" > (< / span > < span class = "n" > action< / span > < span class = "p" > )]< / span >
< / pre > < / div >
< / div >
< p > < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot" title = "gymnasium.utils.play.PlayPlot" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > PlayPlot< / span > < / code > < / a > provides the method < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot.callback" title = "gymnasium.utils.play.PlayPlot.callback" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > callback()< / span > < / code > < / a > which will pass its arguments along to that function
and uses the returned values to update live plots of the metrics.< / p >
< p > Typically, this < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot.callback" title = "gymnasium.utils.play.PlayPlot.callback" > < code class = "xref py py-meth docutils literal notranslate" > < span class = "pre" > callback()< / span > < / code > < / a > will be used in conjunction with < a class = "reference internal" href = "#gymnasium.utils.play.play" title = "gymnasium.utils.play.play" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > play()< / span > < / code > < / a > to see how the metrics evolve as you play:< / p >
< div class = "highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > plotter< / span > < span class = "o" > =< / span > < span class = "n" > PlayPlot< / span > < span class = "p" > (< / span > < span class = "n" > compute_metrics< / span > < span class = "p" > ,< / span > < span class = "n" > horizon_timesteps< / span > < span class = "o" > =< / span > < span class = "mi" > 200< / span > < span class = "p" > ,< / span >
< span class = "gp" > ... < / span > < span class = "n" > plot_names< / span > < span class = "o" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " Immediate Rew." < / span > < span class = "p" > ,< / span > < span class = "s2" > " Cumulative Rew." < / span > < span class = "p" > ,< / span > < span class = "s2" > " Action Magnitude" < / span > < span class = "p" > ])< / span >
< span class = "gp" > > > > < / span > < span class = "n" > play< / span > < span class = "p" > (< / span > < span class = "n" > your_env< / span > < span class = "p" > ,< / span > < span class = "n" > callback< / span > < span class = "o" > =< / span > < span class = "n" > plotter< / span > < span class = "o" > .< / span > < span class = "n" > callback< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< p > Constructor of < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot" title = "gymnasium.utils.play.PlayPlot" > < code class = "xref py py-class docutils literal notranslate" > < span class = "pre" > PlayPlot< / span > < / code > < / a > .< / p >
< p > The function < code class = "docutils literal notranslate" > < span class = "pre" > callback< / span > < / code > that is passed to this constructor should return
a list of metrics that is of length < code class = "docutils literal notranslate" > < span class = "pre" > len(plot_names)< / span > < / code > .< / 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 > callback< / strong > – < / p > < / li >
< li > < p > < strong > horizon_timesteps< / strong > – < / p > < / li >
< li > < p > < strong > plot_names< / strong > – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Raises< span class = "colon" > :< / span > < / dt >
< dd class = "field-even" > < p > < strong > DependencyNotInstalled< / strong > – < / p >
< / dd >
< / dl >
< dl class = "py method" >
< dt class = "sig sig-object py" id = "gymnasium.utils.play.PlayPlot.callback" >
< span class = "sig-name descname" > < span class = "pre" > callback< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > obs_t< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > ObsType< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > obs_tp1< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > ObsType< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > action< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > ActType< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > rew< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > float< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > terminated< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > truncated< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > bool< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > info< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > dict< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.utils.play.PlayPlot.callback" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > The callback that calls the provided data callback and adds the data to the plots.< / 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 > obs_t< / strong > – < / p > < / li >
< li > < p > < strong > obs_tp1< / strong > – < / p > < / li >
< li > < p > < strong > action< / strong > – < / p > < / li >
< li > < p > < strong > rew< / strong > – < / p > < / li >
< li > < p > < strong > terminated< / strong > – < / p > < / li >
< li > < p > < strong > truncated< / strong > – < / p > < / li >
< li > < p > < strong > info< / strong > – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< dl class = "py class" >
< dt class = "sig sig-object py" id = "gymnasium.utils.play.PlayableGame" >
< em class = "property" > < span class = "pre" > class< / span > < span class = "w" > < / span > < / em > < span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.play.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > PlayableGame< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > env< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < a class = "reference internal" href = "../env/#gymnasium.Env" title = "gymnasium.core.Env" > < span class = "pre" > Env< / span > < / a > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > keys_to_action< / 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 class = "pre" > Tuple< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > int< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "p" > < span class = "pre" > ...< / span > < / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > int< / 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" > zoom< / 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" > float< / 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.utils.play.PlayableGame" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Wraps an environment allowing keyboard inputs to interact with the environment.< / p >
< p > Wraps an environment with a dictionary of keyboard buttons to action and if to zoom in on the environment.< / 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 > env< / strong > – < / p > < / li >
< li > < p > < strong > keys_to_action< / strong > – < / p > < / li >
< li > < p > < strong > zoom< / strong > – < / p > < / li >
2022-09-13 19:29:14 +00:00
< / ul >
< / dd >
< / dl >
2022-10-12 15:02:09 +00:00
< dl class = "py method" >
< dt class = "sig sig-object py" id = "gymnasium.utils.play.PlayableGame.process_event" >
< span class = "sig-name descname" > < span class = "pre" > process_event< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > event< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Event< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.utils.play.PlayableGame.process_event" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Processes a PyGame event.< / p >
< p > In particular, this function is used to keep track of which buttons are currently pressed
and to exit the < a class = "reference internal" href = "#gymnasium.utils.play.play" title = "gymnasium.utils.play.play" > < code class = "xref py py-func docutils literal notranslate" > < span class = "pre" > play()< / span > < / code > < / a > function when the PyGame window is closed.< / 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" > < p > < strong > event< / strong > – < / p >
2022-09-13 19:29:14 +00:00
< / dd >
< / dl >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< / dd > < / dl >
2022-09-13 19:29:14 +00:00
< / section >
< section id = "save-rendering-videos" >
< h2 > Save Rendering Videos< a class = "headerlink" href = "#save-rendering-videos" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.save_video.save_video" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.save_video.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > save_video< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > frames< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > list< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > video_folder< / 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" > episode_trigger< / 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 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 = "w" > < / span > < span class = "pre" > bool< / 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" > step_trigger< / 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 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 = "w" > < / span > < span class = "pre" > bool< / 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" > video_length< / 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" > int< / 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" > name_prefix< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > str< / 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" > 'rl-video'< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > episode_index< / 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" > 0< / span > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > step_starting_index< / 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" > 0< / 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" > )< /sp
< dd > < p > Save videos from rendering frames.< / p >
< p > This function extract video from a list of render frame episodes.< / 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 > frames< / strong > (< em > List< / em > < em > [< / em > < em > RenderFrame< / em > < em > ]< / em > ) – < / p > < / li >
< li > < p > < strong > video_folder< / strong > (< em > str< / em > ) – < / p > < / li >
< li > < p > < strong > episode_trigger< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > iff a recording should be started at this episode< / p > < / li >
< li > < p > < strong > step_trigger< / strong > – < code class = "docutils literal notranslate" > < span class = "pre" > True< / span > < / code > iff a recording should be started at this step< / p > < / li >
< li > < p > < strong > video_length< / strong > (< em > int< / em > ) – ’
Otherwise, snippets of the specified length are captured.< / p > < / li >
< li > < p > < strong > name_prefix< / strong > (< em > str< / em > ) – < / p > < / li >
< li > < p > < strong > episode_index< / strong > (< em > int< / em > ) – < / p > < / li >
< li > < p > < strong > step_starting_index< / strong > (< em > int< / em > ) – < / p > < / li >
< li > < p > < strong > **kwargs< / strong > – ’
You need to specify either fps or duration.< / p > < / li >
< / ul >
< / dd >
< / dl >
< p class = "rubric" > Example< / p >
2022-09-16 22:43:27 +00:00
< div class = "doctest 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 >
2022-09-13 19:29:14 +00:00
< span class = "gp" > > > > < / span > < span class = "kn" > from< / span > < span class = "nn" > gymnasium.utils.save_video< / span > < span class = "kn" > import< / span > < span class = "n" > save_video< / span >
2022-09-16 22:43:27 +00:00
< 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" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " FrozenLake-v1" < / span > < span class = "p" > ,< / span > < span class = "n" > render_mode< / span > < span class = "o" > =< / span > < span class = "s2" > " rgb_array_list" < / span > < span class = "p" > )< / span >
2022-09-13 19:29:14 +00:00
< span class = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > reset< / span > < span class = "p" > ()< / span >
< span class = "gp" > > > > < / span > < span class = "n" > step_starting_index< / span > < span class = "o" > =< / span > < span class = "mi" > 0< / span >
< span class = "gp" > > > > < / span > < span class = "n" > episode_index< / span > < span class = "o" > =< / span > < span class = "mi" > 0< / span >
< span class = "gp" > > > > < / span > < span class = "k" > for< / span > < span class = "n" > step_index< / span > < span class = "ow" > in< / span > < span class = "nb" > range< / span > < span class = "p" > (< / span > < span class = "mi" > 199< / span > < span class = "p" > ):< / span >
< span class = "gp" > ... < / span > < span class = "n" > action< / span > < span class = "o" > =< / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > action_space< / span > < span class = "o" > .< / span > < span class = "n" > sample< / span > < span class = "p" > ()< / span >
2022-09-16 22:43:27 +00:00
< span class = "gp" > ... < / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "p" > ,< / span > < span class = "n" > terminated< / span > < span class = "p" > ,< / span > < span class = "n" > truncated< / span > < span class = "p" > ,< / span > < span class = "n" > _< / span > < span class = "o" > =< / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > step< / span > < span class = "p" > (< / span > < span class = "n" > action< / span > < span class = "p" > )< / span >
< span class = "gp" > ...< / span >
< span class = "gp" > ... < / span > < span class = "k" > if< / span > < span class = "n" > terminated< / span > < span class = "ow" > or< / span > < span class = "n" > truncated< / span > < span class = "p" > :< / span >
2022-09-13 19:29:14 +00:00
< span class = "gp" > ... < / span > < span class = "n" > save_video< / span > < span class = "p" > (< / span >
< span class = "gp" > ... < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > render< / span > < span class = "p" > (),< / span >
< span class = "gp" > ... < / span > < span class = "s2" > " videos" < / span > < span class = "p" > ,< / span >
< span class = "gp" > ... < / span > < span class = "n" > fps< / span > < span class = "o" > =< / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > metadata< / span > < span class = "p" > [< / span > < span class = "s2" > " render_fps" < / span > < span class = "p" > ],< / span >
< span class = "gp" > ... < / span > < span class = "n" > step_starting_index< / span > < span class = "o" > =< / span > < span class = "n" > step_starting_index< / span > < span class = "p" > ,< / span >
< span class = "gp" > ... < / span > < span class = "n" > episode_index< / span > < span class = "o" > =< / span > < span class = "n" > episode_index< / span >
< span class = "gp" > ... < / span > < span class = "p" > )< / span >
< span class = "gp" > ... < / span > < span class = "n" > step_starting_index< / span > < span class = "o" > =< / span > < span class = "n" > step_index< / span > < span class = "o" > +< / span > < span class = "mi" > 1< / span >
< span class = "gp" > ... < / span > < span class = "n" > episode_index< / span > < span class = "o" > +=< / span > < span class = "mi" > 1< / 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 = "gp" > > > > < / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > close< / span > < span class = "p" > ()< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
< dl class = "py function" >
2022-10-12 15:02:09 +00:00
< dt class = "sig sig-object py" id = "gymnasium.utils.save_video.capped_cubic_video_schedule" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.save_video.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > capped_cubic_video_schedule< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > episode_id< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > int< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < span class = "sig-return" > < span class = "sig-return-icon" > → < / span > < span class = "sig-return-typehint" > < span class = "pre" > bool< / span > < / span > < / span > < a class = "headerlink" href = "#gymnasium.utils.save_video.capped_cubic_video_schedule" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > The default episode trigger.< / p >
< p > This function will trigger recordings at the episode indices 0, 1, 4, 8, 27, …, < span class = "math notranslate nohighlight" > \(k^3\)< / span > , …, 729, 1000, 2000, 3000, …< / 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" > < p > < strong > episode_id< / strong > – < / p >
2022-09-13 19:29:14 +00:00
< / dd >
2022-10-12 15:02:09 +00:00
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
< dd class = "field-even" > < p > < strong > If to apply a video schedule number< / 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 = "old-to-new-step-api-compatibility" >
< h2 > Old to New Step API Compatibility< a class = "headerlink" href = "#old-to-new-step-api-compatibility" title = "Permalink to this heading" > #< / a > < / h2 >
2022-09-13 19:29:14 +00:00
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.step_api_compatibility.step_api_compatibility" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.step_api_compatibility.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > step_api_compatibility< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > step_returns< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Tuple< / 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" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Tuple< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "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" > output_truncation_bool< / 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
< dd > < p > Function to transform step returns to the API specified by < cite > output_truncation_bool< / cite > bool.< / p >
< p > Done (old) step API refers to step() method returning (observation, reward, done, info)
Terminated Truncated (new) step API refers to step() method returning (observation, reward, terminated, truncated, info)
(Refer to docs for details on the API change)< / 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 > step_returns< / strong > (< em > tuple< / em > ) – < / p > < / li >
< li > < p > < strong > output_truncation_bool< / strong > (< em > bool< / em > ) – < / p > < / li >
< li > < p > < strong > is_vector_env< / strong > (< em > bool< / em > ) – < / p > < / li >
< / ul >
< / dd >
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
2022-09-16 22:43:27 +00:00
< dd class = "field-even" > < p > < strong > step_returns< / strong > (< em > tuple< / em > ) – < cite > output_truncation_bool< / cite > bool, it can return < cite > (obs, rew, done, info)< / cite > or < cite > (obs, rew, terminated, truncated, info)< / cite > < / p >
2022-09-13 19:29:14 +00:00
< / dd >
< / dl >
< p class = "rubric" > Examples< / p >
< dl class = "simple" >
< dt > This function can be used to ensure compatibility in step interfaces with conflicting API. Eg. if env is written in old API,< / dt > < dd > < p > wrapper is written in new API, and the final step output is desired to be in old API.< / p >
< / dd >
< / dl >
2022-09-16 22:43:27 +00:00
< div class = "doctest 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" > make< / span > < span class = "p" > (< / span > < span class = "s2" > " OldEnv" < / span > < span class = "p" > )< / span >
< span class = "gp" > > > > < / span > < span class = "n" > obs< / span > < span class = "p" > ,< / span > < span class = "n" > rew< / span > < span class = "p" > ,< / span > < span class = "n" > done< / span > < span class = "p" > ,< / span > < span class = "n" > info< / span > < span class = "o" > =< / span > < span class = "n" > step_api_compatibility< / span > < span class = "p" > (< / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > step< / span > < span class = "p" > (< / span > < span class = "n" > action< / span > < span class = "p" > ),< / span > < span class = "n" > output_truncation_bool< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > )< / span >
2022-09-13 19:29:14 +00:00
< span class = "gp" > > > > < / span > < span class = "n" > obs< / span > < span class = "p" > ,< / span > < span class = "n" > rew< / span > < span class = "p" > ,< / span > < span class = "n" > terminated< / span > < span class = "p" > ,< / span > < span class = "n" > truncated< / span > < span class = "p" > ,< / span > < span class = "n" > info< / span > < span class = "o" > =< / span > < span class = "n" > step_api_compatibility< / span > < span class = "p" > (< / span > < span class = "n" > env< / span > < span class = "o" > .< / span > < span class = "n" > step< / span > < span class = "p" > (< / span > < span class = "n" > action< / span > < span class = "p" > ),< / span > < span class = "n" > output_truncation_bool< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
2022-09-16 22:43:27 +00:00
< / pre > < / div >
< / div >
< div class = "doctest highlight-default notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "gp" > > > > < / span > < span class = "n" > vec_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 = "s2" > " OldEnv" < / span > < span class = "p" > )< / span >
2022-09-13 19:29:14 +00:00
< 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" > dones< / span > < span class = "p" > ,< / span > < span class = "n" > infos< / span > < span class = "o" > =< / span > < span class = "n" > step_api_compatibility< / span > < span class = "p" > (< / span > < span class = "n" > vec_env< / span > < span class = "o" > .< / span > < span class = "n" > step< / span > < span class = "p" > (< / span > < span class = "n" > action< / span > < span class = "p" > ),< / span > < span class = "n" > is_vector_env< / span > < span class = "o" > =< / span > < span class = "kc" > True< / span > < span class = "p" > )< / span >
< / pre > < / div >
< / div >
< / dd > < / dl >
2022-10-12 15:02:09 +00:00
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.step_api_compatibility.convert_to_terminated_truncated_step_api" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.step_api_compatibility.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > convert_to_terminated_truncated_step_api< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > step_returns< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Tuple< / 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" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Tuple< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "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" > is_vector_env< / span > < / span > < span class = "o" > < span class = "pre" > =< / span > < / span > < span class = "default_value" > < span class = "pre" > False< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < span class = "sig-return" > < span class = "sig-return-icon" > → < / span > < span class = "sig-return-typeh
< dd > < p > Function to transform step returns to new step API irrespective of input API.< / 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 > step_returns< / strong > (< em > tuple< / em > ) – < / p > < / li >
< li > < p > < strong > is_vector_env< / strong > (< em > bool< / em > ) – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.step_api_compatibility.convert_to_done_step_api" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.step_api_compatibility.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > convert_to_done_step_api< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > step_returns< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Tuple< / 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" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Tuple< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > ObsType< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > float< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > bool< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > ndarray< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Union< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > dict< / 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 = "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" > is_vector_env< / 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" >
< dd > < p > Function to transform step returns to old step API irrespective of input API.< / 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 > step_returns< / strong > (< em > tuple< / em > ) – < / p > < / li >
< li > < p > < strong > is_vector_env< / strong > (< em > bool< / em > ) – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
2022-09-13 19:29:14 +00:00
< / section >
< section id = "seeding" >
< h2 > Seeding< a class = "headerlink" href = "#seeding" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.seeding.np_random" >
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.seeding.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > np_random< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > seed< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < span class = "pre" > Optional< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > int< / 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 > < span class = "sig-return" > < span class = "sig-return-icon" > → < / span > < span class = "sig-return-typehint" > < span class = "pre" > Tuple< / span > < span class = "p" > < span class = "pre" > [< / span > < / span > < span class = "pre" > Generator< / span > < span class = "p" > < span class = "pre" > ,< / span > < / span > < span class = "w" > < / span > < span class = "pre" > Any< / span > < span class = "p" > < span class = "pre" > ]< / span > < / span > < / span > < / span > < a class = "headerlink" href = "#gymnasium.utils.seeding.np_random" title = "Permalink to this definition" > #< / a > < / dt >
< dd > < p > Generates a random number generator from the seed and returns the Generator and seed.< / p >
< dl class = "field-list simple" >
< dt class = "field-odd" > Parameters< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < p > < strong > seed< / strong > – < / p >
< / dd >
< dt class = "field-even" > Returns< span class = "colon" > :< / span > < / dt >
< dd class = "field-even" > < p > < strong > The generator and resulting seed< / strong > < / p >
< / dd >
< dt class = "field-odd" > Raises< span class = "colon" > :< / span > < / dt >
< dd class = "field-odd" > < p > < strong > Error< / strong > – < / p >
< / dd >
< / dl >
< / dd > < / dl >
< / section >
< section id = "environment-checking" >
< h2 > Environment Checking< a class = "headerlink" href = "#environment-checking" title = "Permalink to this heading" > #< / a > < / h2 >
< dl class = "py function" >
< dt class = "sig sig-object py" id = "gymnasium.utils.env_checker.check_env" >
2022-10-12 15:02:09 +00:00
< span class = "sig-prename descclassname" > < span class = "pre" > gymnasium.utils.env_checker.< / span > < / span > < span class = "sig-name descname" > < span class = "pre" > check_env< / span > < / span > < span class = "sig-paren" > (< / span > < em class = "sig-param" > < span class = "n" > < span class = "pre" > env< / span > < / span > < span class = "p" > < span class = "pre" > :< / span > < / span > < span class = "w" > < / span > < span class = "n" > < a class = "reference internal" href = "../env/#gymnasium.Env" title = "gymnasium.core.Env" > < span class = "pre" > Env< / span > < / a > < / span > < / em > , < em class = "sig-param" > < span class = "n" > < span class = "pre" > warn< / 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 = "n" > < span class = "pre" > skip_render_check< / 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" > False< / span > < / span > < / em > < span class = "sig-paren" > )< / span > < a class = "headerlink" href = "#gymnasium.utils.env_checker.check_env" title = "Permalink to this definition" > #< / a > < / dt >
2022-09-13 19:29:14 +00:00
< dd > < p > Check that an environment follows Gym API.< / p >
< p > This is an invasive function that calls the environment’ < / p >
< p > This is particularly useful when using a custom environment.
2022-09-16 13:02:04 +00:00
Please take a look at < a class = "reference external" href = "https://gymnasium.farama.org/content/environment_creation/" > https://gymnasium.farama.org/content/environment_creation/< / a >
2022-09-13 19:29:14 +00:00
for more information about the API.< / 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< / strong > – < / p > < / li >
< li > < p > < strong > warn< / strong > – < / p > < / li >
< li > < p > < strong > skip_render_check< / strong > – < / p > < / li >
< / ul >
< / dd >
< / dl >
< / dd > < / dl >
< / section >
< / section >
< / article >
< / div >
< footer >
< div class = "related-pages" >
2022-10-12 15:02:09 +00:00
< a class = "next-page" href = "../../environments/classic_control/" >
2022-09-13 19:29:14 +00:00
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
2022-10-12 15:02:09 +00:00
< div class = "title" > Classic Control< / div >
2022-09-13 19:29:14 +00:00
< / div >
< svg class = "furo-related-icon" > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
2022-10-03 15:02:45 +00:00
< a class = "prev-page" href = "../vector/" >
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 >
< div class = "title" > Vector< / div >
< / div >
< / a >
< / div >
< div class = "bottom-of-page" >
< div class = "left-details" >
< div class = "copyright" >
Copyright © 2022, Farama Foundation
< / div >
Made with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > and < a class = "muted-link" href = "https://pradyunsg.me" > @pradyunsg< / a > 's
< a href = "https://github.com/pradyunsg/furo" > Furo< / a >
< / div >
< div class = "right-details" >
< div class = "icons" >
2022-10-03 15:02:45 +00:00
< a class = "muted-link" href = "https://github.com/Farama-Foundation/Gymnasium" aria-label = "On GitHub" >
< svg stroke = "currentColor" fill = "currentColor" stroke-width = "0" viewBox = "0 0 16 16" >
< path fill-rule = "evenodd" d = "M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z" > < / path >
< / svg >
< / a >
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 = "#" > Utils< / a > < ul >
2022-09-25 14:44:48 +00:00
< li > < a class = "reference internal" href = "#visualization" > Visualization< / a > < ul >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.play.play" > < code class = "docutils literal notranslate" > < span class = "pre" > play()< / span > < / code > < / a > < / li >
2022-09-25 14:44:48 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot" > < code class = "docutils literal notranslate" > < span class = "pre" > PlayPlot< / span > < / code > < / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.utils.play.PlayPlot.callback" > < code class = "docutils literal notranslate" > < span class = "pre" > PlayPlot.callback()< / span > < / code > < / a > < / li >
< / ul >
< / li >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.play.PlayableGame" > < code class = "docutils literal notranslate" > < span class = "pre" > PlayableGame< / span > < / code > < / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.utils.play.PlayableGame.process_event" > < code class = "docutils literal notranslate" > < span class = "pre" > PlayableGame.process_event()< / span > < / code > < / a > < / li >
< / ul >
< / li >
2022-09-25 14:44:48 +00:00
< / ul >
< / li >
< li > < a class = "reference internal" href = "#save-rendering-videos" > Save Rendering Videos< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.utils.save_video.save_video" > < code class = "docutils literal notranslate" > < span class = "pre" > save_video()< / span > < / code > < / a > < / li >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.save_video.capped_cubic_video_schedule" > < code class = "docutils literal notranslate" > < span class = "pre" > capped_cubic_video_schedule()< / span > < / code > < / a > < / li >
2022-09-25 14:44:48 +00:00
< / ul >
< / li >
< li > < a class = "reference internal" href = "#old-to-new-step-api-compatibility" > Old to New Step API Compatibility< / a > < ul >
2022-10-12 15:02:09 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.step_api_compatibility.step_api_compatibility" > < code class = "docutils literal notranslate" > < span class = "pre" > step_api_compatibility()< / span > < / code > < / a > < / li >
2022-09-25 14:44:48 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.step_api_compatibility.convert_to_terminated_truncated_step_api" > < code class = "docutils literal notranslate" > < span class = "pre" > convert_to_terminated_truncated_step_api()< / span > < / code > < / a > < / li >
< li > < a class = "reference internal" href = "#gymnasium.utils.step_api_compatibility.convert_to_done_step_api" > < code class = "docutils literal notranslate" > < span class = "pre" > convert_to_done_step_api()< / span > < / code > < / a > < / li >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#seeding" > Seeding< / a > < ul >
< li > < a class = "reference internal" href = "#gymnasium.utils.seeding.np_random" > < code class = "docutils literal notranslate" > < span class = "pre" > np_random()< / span > < / code > < / a > < / li >
< / ul >
< / li >
2022-09-13 19:29:14 +00:00
< li > < a class = "reference internal" href = "#environment-checking" > Environment Checking< / a > < ul >
2022-09-25 14:44:48 +00:00
< li > < a class = "reference internal" href = "#gymnasium.utils.env_checker.check_env" > < code class = "docutils literal notranslate" > < span class = "pre" > check_env()< / 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')) {
const dropdown = document.querySelector(".farama-header-menu__list");
if (dropdown.classList.contains('active')) {
dropdown.classList.remove('active');
document.querySelector(".farama-header-menu__overlay").classList.remove("active");
}
}
}
< / script >
< 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 >
< script async = "async" src = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" > < / script >
2022-10-03 15:02:45 +00:00
< / body >
2022-09-13 19:29:14 +00:00
< / html >
