mirror of
https://github.com/Farama-Foundation/Gymnasium.git
synced 2025-08-20 22:12:03 +00:00
Deploying to gh-pages from @ Farama-Foundation/Gymnasium@1b28369789 🚀
This commit is contained in:
pseudo-rnd-thoughts
@@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 309340cd494e6110e8779bfdf20952bc
|
||||
config: c29ef785859083c891d7d61febe82c92
|
||||
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
|
||||
|
||||
34
404.html
34
404.html
@@ -15,7 +15,11 @@
|
||||
<title>404 - Page Not Found - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="/_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="/tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="/tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="/tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="/tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="/tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="/release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -465,11 +477,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -639,7 +651,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Gymnasium-docs - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -545,11 +557,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -719,7 +731,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"\n# Make your own custom environment\n\nThis documentation overviews creating new environments and relevant\nuseful wrappers, utilities and tests included in Gymnasium designed for\nthe creation of new environments. You can clone gym-examples to play\nwith the code that is presented here. We recommend that you use a virtual environment:\n\n.. code:: console\n\n git clone https://github.com/Farama-Foundation/gym-examples\n cd gym-examples\n python -m venv .env\n source .env/bin/activate\n pip install -e .\n\n## Subclassing gymnasium.Env\n\nBefore learning how to create your own environment you should check out\n[the documentation of Gymnasium\u2019s API](/api/core)_.\n\nWe will be concerned with a subset of gym-examples that looks like this:\n\n.. code:: sh\n\n gym-examples/\n README.md\n setup.py\n gym_examples/\n __init__.py\n envs/\n __init__.py\n grid_world.py\n wrappers/\n __init__.py\n relative_position.py\n reacher_weighted_reward.py\n discrete_action.py\n clip_reward.py\n\nTo illustrate the process of subclassing ``gymnasium.Env``, we will\nimplement a very simplistic game, called ``GridWorldEnv``. We will write\nthe code for our custom environment in\n``gym-examples/gym_examples/envs/grid_world.py``. The environment\nconsists of a 2-dimensional square grid of fixed size (specified via the\n``size`` parameter during construction). The agent can move vertically\nor horizontally between grid cells in each timestep. The goal of the\nagent is to navigate to a target on the grid that has been placed\nrandomly at the beginning of the episode.\n\n- Observations provide the location of the target and agent.\n- There are 4 actions in our environment, corresponding to the\n movements \u201cright\u201d, \u201cup\u201d, \u201cleft\u201d, and \u201cdown\u201d.\n- A done signal is issued as soon as the agent has navigated to the\n grid cell where the target is located.\n- Rewards are binary and sparse, meaning that the immediate reward is\n always zero, unless the agent has reached the target, then it is 1.\n\nAn episode in this environment (with ``size=5``) might look like this:\n\nwhere the blue dot is the agent and the red square represents the\ntarget.\n\nLet us look at the source code of ``GridWorldEnv`` piece by piece:\n"
|
||||
"\n# Make your own custom environment\n\nThis documentation overviews creating new environments and relevant\nuseful wrappers, utilities and tests included in Gymnasium designed for\nthe creation of new environments. You can clone gym-examples to play\nwith the code that is presented here. We recommend that you use a virtual environment:\n\n.. code:: console\n\n git clone https://github.com/Farama-Foundation/gym-examples\n cd gym-examples\n python -m venv .env\n source .env/bin/activate\n pip install -e .\n\n## Subclassing gymnasium.Env\n\nBefore learning how to create your own environment you should check out\n[the documentation of Gymnasium\u2019s API](/api/env)_.\n\nWe will be concerned with a subset of gym-examples that looks like this:\n\n.. code:: sh\n\n gym-examples/\n README.md\n setup.py\n gym_examples/\n __init__.py\n envs/\n __init__.py\n grid_world.py\n wrappers/\n __init__.py\n relative_position.py\n reacher_weighted_reward.py\n discrete_action.py\n clip_reward.py\n\nTo illustrate the process of subclassing ``gymnasium.Env``, we will\nimplement a very simplistic game, called ``GridWorldEnv``. We will write\nthe code for our custom environment in\n``gym-examples/gym_examples/envs/grid_world.py``. The environment\nconsists of a 2-dimensional square grid of fixed size (specified via the\n``size`` parameter during construction). The agent can move vertically\nor horizontally between grid cells in each timestep. The goal of the\nagent is to navigate to a target on the grid that has been placed\nrandomly at the beginning of the episode.\n\n- Observations provide the location of the target and agent.\n- There are 4 actions in our environment, corresponding to the\n movements \u201cright\u201d, \u201cup\u201d, \u201cleft\u201d, and \u201cdown\u201d.\n- A done signal is issued as soon as the agent has navigated to the\n grid cell where the target is located.\n- Rewards are binary and sparse, meaning that the immediate reward is\n always zero, unless the agent has reached the target, then it is 1.\n\nAn episode in this environment (with ``size=5``) might look like this:\n\nwhere the blue dot is the agent and the red square represents the\ntarget.\n\nLet us look at the source code of ``GridWorldEnv`` piece by piece:\n"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -196,7 +196,7 @@
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.15"
|
||||
"version": "3.9.16"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
BIN
_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip
Normal file
BIN
_downloads/315c4c52fb68082a731b192d944e2ede/tutorials_python.zip
Normal file
Binary file not shown.
@@ -49,7 +49,7 @@
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.15"
|
||||
"version": "3.9.16"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
File diff suppressed because one or more lines are too long
@@ -20,7 +20,7 @@ Subclassing gymnasium.Env
|
||||
-------------------------
|
||||
|
||||
Before learning how to create your own environment you should check out
|
||||
`the documentation of Gymnasium’s API </api/core>`__.
|
||||
`the documentation of Gymnasium’s API </api/env>`__.
|
||||
|
||||
We will be concerned with a subset of gym-examples that looks like this:
|
||||
|
||||
Binary file not shown.
@@ -107,7 +107,7 @@
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.15"
|
||||
"version": "3.9.16"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
@@ -125,7 +125,7 @@
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.15"
|
||||
"version": "3.9.16"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
@@ -169,7 +169,7 @@
|
||||
},
|
||||
"outputs": [],
|
||||
"source": [
|
||||
"rolling_length = 500\nfig, axs = plt.subplots(ncols=3, figsize=(12, 5))\naxs[0].set_title(\"Episode rewards\")\nreward_moving_average = (\n np.convolve(\n np.array(env.return_queue).flatten(), np.ones(rolling_length), mode=\"valid\"\n )\n / rolling_length\n)\naxs[0].plot(range(len(reward_moving_average)), reward_moving_average)\naxs[1].set_title(\"Episode lengths\")\nlength_moving_average = (\n np.convolve(\n np.array(env.length_queue).flatten(), np.ones(rolling_length), mode=\"same\"\n )\n / rolling_length\n)\naxs[1].plot(range(len(length_moving_average)), length_moving_average)\naxs[2].set_title(\"Training Error\")\ntraining_error_moving_average = (\n np.convolve(np.array(agent.training_error), np.ones(rolling_length), mode=\"same\")\n / rolling_length\n)\naxs[2].plot(range(len(training_error_moving_average)), training_error_moving_average)\nplt.tight_layout()\nplt.show()"
|
||||
"rolling_length = 500\nfig, axs = plt.subplots(ncols=3, figsize=(12, 5))\naxs[0].set_title(\"Episode rewards\")\n# compute and assign a rolling average of the data to provide a smoother graph\nreward_moving_average = (\n np.convolve(\n np.array(env.return_queue).flatten(), np.ones(rolling_length), mode=\"valid\"\n )\n / rolling_length\n)\naxs[0].plot(range(len(reward_moving_average)), reward_moving_average)\naxs[1].set_title(\"Episode lengths\")\nlength_moving_average = (\n np.convolve(\n np.array(env.length_queue).flatten(), np.ones(rolling_length), mode=\"same\"\n )\n / rolling_length\n)\naxs[1].plot(range(len(length_moving_average)), length_moving_average)\naxs[2].set_title(\"Training Error\")\ntraining_error_moving_average = (\n np.convolve(np.array(agent.training_error), np.ones(rolling_length), mode=\"same\")\n / rolling_length\n)\naxs[2].plot(range(len(training_error_moving_average)), training_error_moving_average)\nplt.tight_layout()\nplt.show()"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -264,7 +264,7 @@
|
||||
"name": "python",
|
||||
"nbconvert_exporter": "python",
|
||||
"pygments_lexer": "ipython3",
|
||||
"version": "3.9.15"
|
||||
"version": "3.9.16"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
@@ -299,6 +299,7 @@ for episode in tqdm(range(n_episodes)):
|
||||
rolling_length = 500
|
||||
fig, axs = plt.subplots(ncols=3, figsize=(12, 5))
|
||||
axs[0].set_title("Episode rewards")
|
||||
# compute and assign a rolling average of the data to provide a smoother graph
|
||||
reward_moving_average = (
|
||||
np.convolve(
|
||||
np.array(env.return_queue).flatten(), np.ones(rolling_length), mode="valid"
|
||||
@@ -0,0 +1,710 @@
|
||||
"""
|
||||
Training A2C with Vector Envs and Domain Randomization
|
||||
======================================================
|
||||
|
||||
"""
|
||||
|
||||
|
||||
# %%
|
||||
# Introduction
|
||||
# ------------
|
||||
#
|
||||
# In this tutorial, you'll learn how to use vectorized environments to train an Advantage Actor-Critic agent.
|
||||
# We are going to use A2C, which is the synchronous version of the A3C algorithm [1].
|
||||
#
|
||||
# Vectorized environments [3] can help to achieve quicker and more robust training by allowing multiple instances
|
||||
# of the same environment to run in parallel (on multiple CPUs). This can significantly reduce the variance and thus speeds up the training.
|
||||
#
|
||||
# We will implement an Advantage Actor-Critic from scratch to look at how you can feed batched states into your networks to get a vector of actions
|
||||
# (one action per environment) and calculate the losses for actor and critic on minibatches of transitions.
|
||||
# Each minibatch contains the transitions of one sampling phase: `n_steps_per_update` steps are executed in `n_envs` environments in parallel
|
||||
# (multiply the two to get the number of transitions in a minibatch). After each sampling phase, the losses are calculated and one gradient step is executed.
|
||||
# To calculate the advantages, we are going to use the Generalized Advantage Estimation (GAE) method [2], which balances the tradeoff
|
||||
# between variance and bias of the advantage estimates.
|
||||
#
|
||||
# The A2C agent class is initialized with the number of features of the input state, the number of actions the agent can take,
|
||||
# the learning rates and the number of environments that run in parallel to collect experiences. The actor and critic networks are defined
|
||||
# and their respective optimizers are initialized. The forward pass of the networks takes in a batched vector of states and returns a tensor of state values
|
||||
# and a tensor of action logits. The select_action method returns a tuple of the chosen actions, the log-probs of those actions, and the state values for each action.
|
||||
# In addition, it also returns the entropy of the policy distribution, which is subtracted from the loss later (with a weighting factor `ent_coef`) to encourage exploration.
|
||||
#
|
||||
# The get_losses function calculates the losses for the actor and critic networks (using GAE), which are then updated using the update_parameters function.
|
||||
#
|
||||
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
|
||||
# Author: Till Zemann
|
||||
# License: MIT License
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
import torch
|
||||
import torch.nn as nn
|
||||
from torch import optim
|
||||
from tqdm import tqdm
|
||||
|
||||
import gymnasium as gym
|
||||
|
||||
|
||||
# %%
|
||||
# Advantage Actor-Critic (A2C)
|
||||
# ----------------------------
|
||||
#
|
||||
# The Actor-Critic combines elements of value-based and policy-based methods. In A2C, the agent has two separate neural networks:
|
||||
# a critic network that estimates the state-value function, and an actor network that outputs logits for a categorical probability distribution over all actions.
|
||||
# The critic network is trained to minimize the mean squared error between the predicted state values and the actual returns received by the agent
|
||||
# (this is equivalent to minimizing the squared advantages, because the advantage of an action is as the difference between the return and the state-value: A(s,a) = Q(s,a) - V(s).
|
||||
# The actor network is trained to maximize the expected return by selecting actions that have high expected values according to the critic network.
|
||||
#
|
||||
# The focus of this tutorial will not be on the details of A2C itself. Instead, the tutorial will focus on how to use vectorized environments
|
||||
# and domain randomization to accelerate the training process for A2C (and other reinforcement learning algorithms).
|
||||
#
|
||||
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
|
||||
|
||||
class A2C(nn.Module):
|
||||
"""
|
||||
(Synchronous) Advantage Actor-Critic agent class
|
||||
|
||||
Args:
|
||||
n_features: The number of features of the input state.
|
||||
n_actions: The number of actions the agent can take.
|
||||
device: The device to run the computations on (running on a GPU might be quicker for larger Neural Nets,
|
||||
for this code CPU is totally fine).
|
||||
critic_lr: The learning rate for the critic network (should usually be larger than the actor_lr).
|
||||
actor_lr: The learning rate for the actor network.
|
||||
n_envs: The number of environments that run in parallel (on multiple CPUs) to collect experiences.
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
n_features: int,
|
||||
n_actions: int,
|
||||
device: torch.device,
|
||||
critic_lr: float,
|
||||
actor_lr: float,
|
||||
n_envs: int,
|
||||
) -> None:
|
||||
"""Initializes the actor and critic networks and their respective optimizers."""
|
||||
super().__init__()
|
||||
self.device = device
|
||||
self.n_envs = n_envs
|
||||
|
||||
critic_layers = [
|
||||
nn.Linear(n_features, 32),
|
||||
nn.ReLU(),
|
||||
nn.Linear(32, 32),
|
||||
nn.ReLU(),
|
||||
nn.Linear(32, 1), # estimate V(s)
|
||||
]
|
||||
|
||||
actor_layers = [
|
||||
nn.Linear(n_features, 32),
|
||||
nn.ReLU(),
|
||||
nn.Linear(32, 32),
|
||||
nn.ReLU(),
|
||||
nn.Linear(
|
||||
32, n_actions
|
||||
), # estimate action logits (will be fed into a softmax later)
|
||||
]
|
||||
|
||||
# define actor and critic networks
|
||||
self.critic = nn.Sequential(*critic_layers).to(self.device)
|
||||
self.actor = nn.Sequential(*actor_layers).to(self.device)
|
||||
|
||||
# define optimizers for actor and critic
|
||||
self.critic_optim = optim.RMSprop(self.critic.parameters(), lr=critic_lr)
|
||||
self.actor_optim = optim.RMSprop(self.actor.parameters(), lr=actor_lr)
|
||||
|
||||
def forward(self, x: np.ndarray) -> tuple[torch.Tensor, torch.Tensor]:
|
||||
"""
|
||||
Forward pass of the networks.
|
||||
|
||||
Args:
|
||||
x: A batched vector of states.
|
||||
|
||||
Returns:
|
||||
state_values: A tensor with the state values, with shape [n_envs,].
|
||||
action_logits_vec: A tensor with the action logits, with shape [n_envs, n_actions].
|
||||
"""
|
||||
x = torch.Tensor(x).to(self.device)
|
||||
state_values = self.critic(x) # shape: [n_envs,]
|
||||
action_logits_vec = self.actor(x) # shape: [n_envs, n_actions]
|
||||
return (state_values, action_logits_vec)
|
||||
|
||||
def select_action(
|
||||
self, x: np.ndarray
|
||||
) -> tuple[torch.Tensor, torch.Tensor, torch.Tensor, torch.Tensor]:
|
||||
"""
|
||||
Returns a tuple of the chosen actions and the log-probs of those actions.
|
||||
|
||||
Args:
|
||||
x: A batched vector of states.
|
||||
|
||||
Returns:
|
||||
actions: A tensor with the actions, with shape [n_steps_per_update, n_envs].
|
||||
action_log_probs: A tensor with the log-probs of the actions, with shape [n_steps_per_update, n_envs].
|
||||
state_values: A tensor with the state values, with shape [n_steps_per_update, n_envs].
|
||||
"""
|
||||
state_values, action_logits = self.forward(x)
|
||||
action_pd = torch.distributions.Categorical(
|
||||
logits=action_logits
|
||||
) # implicitly uses softmax
|
||||
actions = action_pd.sample()
|
||||
action_log_probs = action_pd.log_prob(actions)
|
||||
entropy = action_pd.entropy()
|
||||
return (actions, action_log_probs, state_values, entropy)
|
||||
|
||||
def get_losses(
|
||||
self,
|
||||
rewards: torch.Tensor,
|
||||
action_log_probs: torch.Tensor,
|
||||
value_preds: torch.Tensor,
|
||||
entropy: torch.Tensor,
|
||||
masks: torch.Tensor,
|
||||
gamma: float,
|
||||
lam: float,
|
||||
ent_coef: float,
|
||||
device: torch.device,
|
||||
) -> tuple[torch.Tensor, torch.Tensor]:
|
||||
"""
|
||||
Computes the loss of a minibatch (transitions collected in one sampling phase) for actor and critic
|
||||
using Generalized Advantage Estimation (GAE) to compute the advantages (https://arxiv.org/abs/1506.02438).
|
||||
|
||||
Args:
|
||||
rewards: A tensor with the rewards for each time step in the episode, with shape [n_steps_per_update, n_envs].
|
||||
action_log_probs: A tensor with the log-probs of the actions taken at each time step in the episode, with shape [n_steps_per_update, n_envs].
|
||||
value_preds: A tensor with the state value predictions for each time step in the episode, with shape [n_steps_per_update, n_envs].
|
||||
masks: A tensor with the masks for each time step in the episode, with shape [n_steps_per_update, n_envs].
|
||||
gamma: The discount factor.
|
||||
lam: The GAE hyperparameter. (lam=1 corresponds to Monte-Carlo sampling with high variance and no bias,
|
||||
and lam=0 corresponds to normal TD-Learning that has a low variance but is biased
|
||||
because the estimates are generated by a Neural Net).
|
||||
device: The device to run the computations on (e.g. CPU or GPU).
|
||||
|
||||
Returns:
|
||||
critic_loss: The critic loss for the minibatch.
|
||||
actor_loss: The actor loss for the minibatch.
|
||||
"""
|
||||
T = len(rewards)
|
||||
advantages = torch.zeros(T, self.n_envs, device=device)
|
||||
|
||||
# compute the advantages using GAE
|
||||
gae = 0.0
|
||||
for t in reversed(range(T - 1)):
|
||||
td_error = (
|
||||
rewards[t] + gamma * masks[t] * value_preds[t + 1] - value_preds[t]
|
||||
)
|
||||
gae = td_error + gamma * lam * masks[t] * gae
|
||||
advantages[t] = gae
|
||||
|
||||
# calculate the loss of the minibatch for actor and critic
|
||||
critic_loss = advantages.pow(2).mean()
|
||||
|
||||
# give a bonus for higher entropy to encourage exploration
|
||||
actor_loss = (
|
||||
-(advantages.detach() * action_log_probs).mean() - ent_coef * entropy.mean()
|
||||
)
|
||||
return (critic_loss, actor_loss)
|
||||
|
||||
def update_parameters(
|
||||
self, critic_loss: torch.Tensor, actor_loss: torch.Tensor
|
||||
) -> None:
|
||||
"""
|
||||
Updates the parameters of the actor and critic networks.
|
||||
|
||||
Args:
|
||||
critic_loss: The critic loss.
|
||||
actor_loss: The actor loss.
|
||||
"""
|
||||
self.critic_optim.zero_grad()
|
||||
critic_loss.backward()
|
||||
self.critic_optim.step()
|
||||
|
||||
self.actor_optim.zero_grad()
|
||||
actor_loss.backward()
|
||||
self.actor_optim.step()
|
||||
|
||||
|
||||
# %%
|
||||
# Using Vectorized Environments
|
||||
# -----------------------------
|
||||
#
|
||||
# When you calculate the losses for the two Neural Networks over only one epoch, it might have a high variance. With vectorized environments,
|
||||
# we can play with `n_envs` in parallel and thus get up to a linear speedup (meaning that in theory, we collect samples `n_envs` times quicker)
|
||||
# that we can use to calculate the loss for the current policy and critic network. When we are using more samples to calculate the loss,
|
||||
# it will have a lower variance and theirfore leads to quicker learning.
|
||||
#
|
||||
# A2C is a synchronous method, meaning that the parameter updates to Networks take place deterministically (after each sampling phase),
|
||||
# but we can still make use of asynchronous vector envs to spawn multiple processes for parallel environment execution.
|
||||
#
|
||||
# The simplest way to create vector environments is by calling `gym.vector.make`, which creates multiple instances of the same environment:
|
||||
#
|
||||
|
||||
envs = gym.vector.make("LunarLander-v2", num_envs=3, max_episode_steps=600)
|
||||
|
||||
|
||||
# %%
|
||||
# Domain Randomization
|
||||
# --------------------
|
||||
#
|
||||
# If we want to randomize the environment for training to get more robust agents (that can deal with different parameterizations of an environment
|
||||
# and theirfore might have a higher degree of generalization), we can set the desired parameters manually or use a pseudo-random number generator to generate them.
|
||||
#
|
||||
# Manually setting up 3 parallel 'LunarLander-v2' envs with different parameters:
|
||||
|
||||
|
||||
envs = gym.vector.AsyncVectorEnv(
|
||||
[
|
||||
lambda: gym.make(
|
||||
"LunarLander-v2",
|
||||
gravity=-10.0,
|
||||
enable_wind=True,
|
||||
wind_power=15.0,
|
||||
turbulence_power=1.5,
|
||||
max_episode_steps=600,
|
||||
),
|
||||
lambda: gym.make(
|
||||
"LunarLander-v2",
|
||||
gravity=-9.8,
|
||||
enable_wind=True,
|
||||
wind_power=10.0,
|
||||
turbulence_power=1.3,
|
||||
max_episode_steps=600,
|
||||
),
|
||||
lambda: gym.make(
|
||||
"LunarLander-v2", gravity=-7.0, enable_wind=False, max_episode_steps=600
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
# Randomly generating the parameters for 3 parallel 'LunarLander-v2' envs, using `np.clip` to stay in the recommended parameter space:
|
||||
#
|
||||
|
||||
|
||||
envs = gym.vector.AsyncVectorEnv(
|
||||
[
|
||||
lambda: gym.make(
|
||||
"LunarLander-v2",
|
||||
gravity=np.clip(
|
||||
np.random.normal(loc=-10.0, scale=1.0), a_min=-11.99, a_max=-0.01
|
||||
),
|
||||
enable_wind=np.random.choice([True, False]),
|
||||
wind_power=np.clip(
|
||||
np.random.normal(loc=15.0, scale=1.0), a_min=0.01, a_max=19.99
|
||||
),
|
||||
turbulence_power=np.clip(
|
||||
np.random.normal(loc=1.5, scale=0.5), a_min=0.01, a_max=1.99
|
||||
),
|
||||
max_episode_steps=600,
|
||||
)
|
||||
for i in range(3)
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
# Here we are using normal distributions with the standard parameterization of the environment as the mean and an arbitrary standard deviation (scale).
|
||||
# Depending on the problem, you can experiment with higher variance and use different distributions as well.
|
||||
#
|
||||
# If you are training on the same `n_envs` environments for the entire training time, and `n_envs` is a relatively low number
|
||||
# (in proportion to how complex the environment is), you might still get some overfitting to the specific parameterizations that you picked.
|
||||
# To mitigate this, you can either pick a high number of randomly parameterized environments or remake your environments every couple of sampling phases
|
||||
# to generate a new set of pseudo-random parameters.
|
||||
#
|
||||
|
||||
|
||||
# %%
|
||||
# Setup
|
||||
# -----
|
||||
#
|
||||
|
||||
# environment hyperparams
|
||||
n_envs = 10
|
||||
n_updates = 1000
|
||||
n_steps_per_update = 128
|
||||
randomize_domain = False
|
||||
|
||||
# agent hyperparams
|
||||
gamma = 0.999
|
||||
lam = 0.95 # hyperparameter for GAE
|
||||
ent_coef = 0.01 # coefficient for the entropy bonus (to encourage exploration)
|
||||
actor_lr = 0.001
|
||||
critic_lr = 0.005
|
||||
|
||||
# Note: the actor has a slower learning rate so that the value targets become
|
||||
# more stationary and are theirfore easier to estimate for the critic
|
||||
|
||||
# environment setup
|
||||
if randomize_domain:
|
||||
envs = gym.vector.AsyncVectorEnv(
|
||||
[
|
||||
lambda: gym.make(
|
||||
"LunarLander-v2",
|
||||
gravity=np.clip(
|
||||
np.random.normal(loc=-10.0, scale=1.0), a_min=-11.99, a_max=-0.01
|
||||
),
|
||||
enable_wind=np.random.choice([True, False]),
|
||||
wind_power=np.clip(
|
||||
np.random.normal(loc=15.0, scale=1.0), a_min=0.01, a_max=19.99
|
||||
),
|
||||
turbulence_power=np.clip(
|
||||
np.random.normal(loc=1.5, scale=0.5), a_min=0.01, a_max=1.99
|
||||
),
|
||||
max_episode_steps=600,
|
||||
)
|
||||
for i in range(n_envs)
|
||||
]
|
||||
)
|
||||
|
||||
else:
|
||||
envs = gym.vector.make("LunarLander-v2", num_envs=n_envs, max_episode_steps=600)
|
||||
|
||||
|
||||
obs_shape = envs.single_observation_space.shape[0]
|
||||
action_shape = envs.single_action_space.n
|
||||
|
||||
# set the device
|
||||
use_cuda = False
|
||||
if use_cuda:
|
||||
device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
|
||||
else:
|
||||
device = torch.device("cpu")
|
||||
|
||||
# init the agent
|
||||
agent = A2C(obs_shape, action_shape, device, critic_lr, actor_lr, n_envs)
|
||||
|
||||
|
||||
# %%
|
||||
# Training the A2C Agent
|
||||
# ----------------------
|
||||
#
|
||||
# For our training loop, we are using the `RecordEpisodeStatistics` wrapper to record the episode lengths and returns and we are also saving
|
||||
# the losses and entropies to plot them after the agent finished training.
|
||||
#
|
||||
# You may notice that the don't reset the vectorized envs at the start of each episode like we would usually do.
|
||||
# This is because each environment resets automatically once the episode finishes (each environment takes a different number of timesteps to finish
|
||||
# an episode because of the random seeds). As a result, we are also not collecting data in `episodes`, but rather just play a certain number of steps
|
||||
# (`n_steps_per_update`) in each environment (as an example, this could mean that we play 20 timesteps to finish an episode and then
|
||||
# use the rest of the timesteps to begin a new one).
|
||||
#
|
||||
|
||||
# create a wrapper environment to save episode returns and episode lengths
|
||||
envs_wrapper = gym.wrappers.RecordEpisodeStatistics(envs, deque_size=n_envs * n_updates)
|
||||
|
||||
critic_losses = []
|
||||
actor_losses = []
|
||||
entropies = []
|
||||
|
||||
# use tqdm to get a progress bar for training
|
||||
for sample_phase in tqdm(range(n_updates)):
|
||||
|
||||
# we don't have to reset the envs, they just continue playing
|
||||
# until the episode is over and then reset automatically
|
||||
|
||||
# reset lists that collect experiences of an episode (sample phase)
|
||||
ep_value_preds = torch.zeros(n_steps_per_update, n_envs, device=device)
|
||||
ep_rewards = torch.zeros(n_steps_per_update, n_envs, device=device)
|
||||
ep_action_log_probs = torch.zeros(n_steps_per_update, n_envs, device=device)
|
||||
masks = torch.zeros(n_steps_per_update, n_envs, device=device)
|
||||
|
||||
# at the start of training reset all envs to get an initial state
|
||||
if sample_phase == 0:
|
||||
states, info = envs_wrapper.reset(seed=42)
|
||||
|
||||
# play n steps in our parallel environments to collect data
|
||||
for step in range(n_steps_per_update):
|
||||
|
||||
# select an action A_{t} using S_{t} as input for the agent
|
||||
actions, action_log_probs, state_value_preds, entropy = agent.select_action(
|
||||
states
|
||||
)
|
||||
|
||||
# perform the action A_{t} in the environment to get S_{t+1} and R_{t+1}
|
||||
states, rewards, terminated, truncated, infos = envs_wrapper.step(
|
||||
actions.numpy()
|
||||
)
|
||||
|
||||
ep_value_preds[step] = torch.squeeze(state_value_preds)
|
||||
ep_rewards[step] = torch.tensor(rewards, device=device)
|
||||
ep_action_log_probs[step] = action_log_probs
|
||||
|
||||
# add a mask (for the return calculation later);
|
||||
# for each env the mask is 1 if the episode is ongoing and 0 if it is terminated (not by truncation!)
|
||||
masks[step] = torch.tensor([not term for term in terminated])
|
||||
|
||||
# calculate the losses for actor and critic
|
||||
critic_loss, actor_loss = agent.get_losses(
|
||||
ep_rewards,
|
||||
ep_action_log_probs,
|
||||
ep_value_preds,
|
||||
entropy,
|
||||
masks,
|
||||
gamma,
|
||||
lam,
|
||||
ent_coef,
|
||||
device,
|
||||
)
|
||||
|
||||
# update the actor and critic networks
|
||||
agent.update_parameters(critic_loss, actor_loss)
|
||||
|
||||
# log the losses and entropy
|
||||
critic_losses.append(critic_loss.detach().cpu().numpy())
|
||||
actor_losses.append(actor_loss.detach().cpu().numpy())
|
||||
entropies.append(entropy.detach().mean().cpu().numpy())
|
||||
|
||||
|
||||
# %%
|
||||
# Plotting
|
||||
# --------
|
||||
#
|
||||
|
||||
""" plot the results """
|
||||
|
||||
# %matplotlib inline
|
||||
|
||||
rolling_length = 20
|
||||
fig, axs = plt.subplots(nrows=2, ncols=2, figsize=(12, 5))
|
||||
fig.suptitle(
|
||||
f"Training plots for {agent.__class__.__name__} in the LunarLander-v2 environment \n \
|
||||
(n_envs={n_envs}, n_steps_per_update={n_steps_per_update}, randomize_domain={randomize_domain})"
|
||||
)
|
||||
|
||||
# episode return
|
||||
axs[0][0].set_title("Episode Returns")
|
||||
episode_returns_moving_average = (
|
||||
np.convolve(
|
||||
np.array(envs_wrapper.return_queue).flatten(),
|
||||
np.ones(rolling_length),
|
||||
mode="valid",
|
||||
)
|
||||
/ rolling_length
|
||||
)
|
||||
axs[0][0].plot(
|
||||
np.arange(len(episode_returns_moving_average)) / n_envs,
|
||||
episode_returns_moving_average,
|
||||
)
|
||||
axs[0][0].set_xlabel("Number of episodes")
|
||||
|
||||
# entropy
|
||||
axs[1][0].set_title("Entropy")
|
||||
entropy_moving_average = (
|
||||
np.convolve(np.array(entropies), np.ones(rolling_length), mode="valid")
|
||||
/ rolling_length
|
||||
)
|
||||
axs[1][0].plot(entropy_moving_average)
|
||||
axs[1][0].set_xlabel("Number of updates")
|
||||
|
||||
|
||||
# critic loss
|
||||
axs[0][1].set_title("Critic Loss")
|
||||
critic_losses_moving_average = (
|
||||
np.convolve(
|
||||
np.array(critic_losses).flatten(), np.ones(rolling_length), mode="valid"
|
||||
)
|
||||
/ rolling_length
|
||||
)
|
||||
axs[0][1].plot(critic_losses_moving_average)
|
||||
axs[0][1].set_xlabel("Number of updates")
|
||||
|
||||
|
||||
# actor loss
|
||||
axs[1][1].set_title("Actor Loss")
|
||||
actor_losses_moving_average = (
|
||||
np.convolve(np.array(actor_losses).flatten(), np.ones(rolling_length), mode="valid")
|
||||
/ rolling_length
|
||||
)
|
||||
axs[1][1].plot(actor_losses_moving_average)
|
||||
axs[1][1].set_xlabel("Number of updates")
|
||||
|
||||
plt.tight_layout()
|
||||
plt.show()
|
||||
|
||||
# %%
|
||||
# .. image:: /_static/img/tutorials/vector_env_a2c_training_plots.png
|
||||
# :alt: training_plots
|
||||
#
|
||||
|
||||
|
||||
# %%
|
||||
# Performance Analysis of Synchronous and Asynchronous Vectorized Environments
|
||||
# ----------------------------------------------------------------------------
|
||||
#
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
# Asynchronous environments can lead to quicker training times and a higher speedup
|
||||
# for data collection compared to synchronous environments. This is because asynchronous environments
|
||||
# allow multiple agents to interact with their environments in parallel,
|
||||
# while synchronous environments run multiple environments serially.
|
||||
# This results in better efficiency and faster training times for asynchronous environments.
|
||||
#
|
||||
|
||||
# %%
|
||||
# .. image:: /_static/img/tutorials/vector_env_performance_plots.png
|
||||
# :alt: performance_plots
|
||||
#
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
# According to the Karp-Flatt metric (a metric used in parallel computing to estimate the limit for the
|
||||
# speedup when scaling up the number of parallel processes, here the number of environments),
|
||||
# the estimated max. speedup for asynchronous environments is 57, while the estimated maximum speedup
|
||||
# for synchronous environments is 21. This suggests that asynchronous environments have significantly
|
||||
# faster training times compared to synchronous environments (see graphs).
|
||||
#
|
||||
|
||||
# %%
|
||||
# .. image:: /_static/img/tutorials/vector_env_karp_flatt_plot.png
|
||||
# :alt: karp_flatt_metric
|
||||
#
|
||||
|
||||
# %%
|
||||
#
|
||||
# ------------------------------
|
||||
#
|
||||
# However, it is important to note that increasing the number of parallel vector environments
|
||||
# can lead to slower training times after a certain number of environments (see plot below, where the
|
||||
# agent was trained until the mean training returns were above -120). The slower training times might occur
|
||||
# because the gradients of the environments are good enough after a relatively low number of environments
|
||||
# (especially if the environment is not very complex). In this case, increasing the number of environments
|
||||
# does not increase the learning speed, and actually increases the runtime, possibly due to the additional time
|
||||
# needed to calculate the gradients. For LunarLander-v2, the best performing configuration used a AsyncVectorEnv
|
||||
# with 10 parallel environments, but environments with a higher complexity may require more
|
||||
# parallel environments to achieve optimal performance.
|
||||
#
|
||||
|
||||
# %%
|
||||
# .. image:: /_static/img/tutorials/vector_env_runtime_until_threshold.png
|
||||
# :alt: runtime_until_threshold_plot
|
||||
#
|
||||
|
||||
|
||||
# %%
|
||||
# Saving/ Loading Weights
|
||||
# -----------------------
|
||||
#
|
||||
|
||||
save_weights = False
|
||||
load_weights = False
|
||||
|
||||
actor_weights_path = "weights/actor_weights.h5"
|
||||
critic_weights_path = "weights/critic_weights.h5"
|
||||
|
||||
if not os.path.exists("weights"):
|
||||
os.mkdir("weights")
|
||||
|
||||
""" save network weights """
|
||||
if save_weights:
|
||||
torch.save(agent.actor.state_dict(), actor_weights_path)
|
||||
torch.save(agent.critic.state_dict(), critic_weights_path)
|
||||
|
||||
|
||||
""" load network weights """
|
||||
if load_weights:
|
||||
agent = A2C(obs_shape, action_shape, device, critic_lr, actor_lr)
|
||||
|
||||
agent.actor.load_state_dict(torch.load(actor_weights_path))
|
||||
agent.critic.load_state_dict(torch.load(critic_weights_path))
|
||||
agent.actor.eval()
|
||||
agent.critic.eval()
|
||||
|
||||
|
||||
# %%
|
||||
# Showcase the Agent
|
||||
# ------------------
|
||||
#
|
||||
|
||||
""" play a couple of showcase episodes """
|
||||
|
||||
n_showcase_episodes = 3
|
||||
|
||||
for episode in range(n_showcase_episodes):
|
||||
print(f"starting episode {episode}...")
|
||||
|
||||
# create a new sample environment to get new random parameters
|
||||
if randomize_domain:
|
||||
env = gym.make(
|
||||
"LunarLander-v2",
|
||||
render_mode="human",
|
||||
gravity=np.clip(
|
||||
np.random.normal(loc=-10.0, scale=2.0), a_min=-11.99, a_max=-0.01
|
||||
),
|
||||
enable_wind=np.random.choice([True, False]),
|
||||
wind_power=np.clip(
|
||||
np.random.normal(loc=15.0, scale=2.0), a_min=0.01, a_max=19.99
|
||||
),
|
||||
turbulence_power=np.clip(
|
||||
np.random.normal(loc=1.5, scale=1.0), a_min=0.01, a_max=1.99
|
||||
),
|
||||
max_episode_steps=500,
|
||||
)
|
||||
else:
|
||||
env = gym.make("LunarLander-v2", render_mode="human", max_episode_steps=500)
|
||||
|
||||
# get an initial state
|
||||
state, info = env.reset()
|
||||
|
||||
# play one episode
|
||||
done = False
|
||||
while not done:
|
||||
|
||||
# select an action A_{t} using S_{t} as input for the agent
|
||||
with torch.no_grad():
|
||||
action, _, _, _ = agent.select_action(state[None, :])
|
||||
|
||||
# perform the action A_{t} in the environment to get S_{t+1} and R_{t+1}
|
||||
state, reward, terminated, truncated, info = env.step(action.item())
|
||||
|
||||
# update if the environment is done
|
||||
done = terminated or truncated
|
||||
|
||||
env.close()
|
||||
|
||||
|
||||
# %%
|
||||
# Try playing the environment yourself
|
||||
# ------------------------------------
|
||||
#
|
||||
|
||||
# from gymnasium.utils.play import play
|
||||
#
|
||||
# play(gym.make('LunarLander-v2', render_mode='rgb_array'),
|
||||
# keys_to_action={'w': 2, 'a': 1, 'd': 3}, noop=0)
|
||||
|
||||
|
||||
# %%
|
||||
# References
|
||||
# ----------
|
||||
#
|
||||
# [1] V. Mnih, A. P. Badia, M. Mirza, A. Graves, T. P. Lillicrap, T. Harley, D. Silver, K. Kavukcuoglu. "Asynchronous Methods for Deep Reinforcement Learning" ICML (2016).
|
||||
#
|
||||
# [2] J. Schulman, P. Moritz, S. Levine, M. Jordan and P. Abbeel. "High-dimensional continuous control using generalized advantage estimation." ICLR (2016).
|
||||
#
|
||||
# [3] Gymnasium Documentation: Vector environments. (URL: https://gymnasium.farama.org/api/vector/)
|
||||
BIN
_images/sphx_glr_blackjack_tutorial_thumb.png
Normal file
BIN
_images/sphx_glr_blackjack_tutorial_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/sphx_glr_environment_creation_thumb.png
Normal file
BIN
_images/sphx_glr_environment_creation_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/sphx_glr_handling_time_limits_thumb.png
Normal file
BIN
_images/sphx_glr_handling_time_limits_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/sphx_glr_implementing_custom_wrappers_thumb.png
Normal file
BIN
_images/sphx_glr_implementing_custom_wrappers_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/sphx_glr_reinforce_invpend_gym_v26_thumb.png
Normal file
BIN
_images/sphx_glr_reinforce_invpend_gym_v26_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/sphx_glr_vector_envs_tutorial_thumb.png
Normal file
BIN
_images/sphx_glr_vector_envs_tutorial_thumb.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
BIN
_images/vector_env_a2c_training_plots.png
Normal file
BIN
_images/vector_env_a2c_training_plots.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
BIN
_images/vector_env_karp_flatt_plot.png
Normal file
BIN
_images/vector_env_karp_flatt_plot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
BIN
_images/vector_env_performance_plots.png
Normal file
BIN
_images/vector_env_performance_plots.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
BIN
_images/vector_env_runtime_until_threshold.png
Normal file
BIN
_images/vector_env_runtime_until_threshold.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
1
_static/binder_badge_logo.svg
Normal file
1
_static/binder_badge_logo.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="109" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="109" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h64v20H0z"/><path fill="#579aca" d="M64 0h45v20H64z"/><path fill="url(#b)" d="M0 0h109v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"><image x="5" y="3" width="14" height="14" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC"/> <text x="415" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">launch</text><text x="415" y="140" transform="scale(.1)" textLength="370">launch</text><text x="855" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="350">binder</text><text x="855" y="140" transform="scale(.1)" textLength="350">binder</text></g> </svg>
|
||||
|
After Width: | Height: | Size: 3.3 KiB |
BIN
_static/broken_example.png
Normal file
BIN
_static/broken_example.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 751 B After Width: | Height: | Size: 644 B |
Binary file not shown.
|
Before Width: | Height: | Size: 751 B After Width: | Height: | Size: 644 B |
BIN
_static/img/tutorials/vector_env_a2c_training_plots.png
Normal file
BIN
_static/img/tutorials/vector_env_a2c_training_plots.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
BIN
_static/img/tutorials/vector_env_karp_flatt_plot.png
Normal file
BIN
_static/img/tutorials/vector_env_karp_flatt_plot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
BIN
_static/img/tutorials/vector_env_performance_plots.png
Normal file
BIN
_static/img/tutorials/vector_env_performance_plots.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 68 KiB |
BIN
_static/img/tutorials/vector_env_runtime_until_threshold.png
Normal file
BIN
_static/img/tutorials/vector_env_runtime_until_threshold.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
_static/no_image.png
Normal file
BIN
_static/no_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.2 KiB |
6
_static/sg_gallery-binder.css
Normal file
6
_static/sg_gallery-binder.css
Normal file
@@ -0,0 +1,6 @@
|
||||
/* CSS for binder integration */
|
||||
|
||||
div.binder-badge {
|
||||
margin: 1em auto;
|
||||
vertical-align: middle;
|
||||
}
|
||||
46
_static/sg_gallery-dataframe.css
Normal file
46
_static/sg_gallery-dataframe.css
Normal file
@@ -0,0 +1,46 @@
|
||||
/* Pandas dataframe css */
|
||||
/* Taken from: https://github.com/spatialaudio/nbsphinx/blob/fb3ba670fc1ba5f54d4c487573dbc1b4ecf7e9ff/src/nbsphinx.py#L587-L619 */
|
||||
html[data-theme="light"] {
|
||||
--sg-text-color: #000;
|
||||
--sg-tr-odd-color: #f5f5f5;
|
||||
--sg-tr-hover-color: rgba(66, 165, 245, 0.2);
|
||||
}
|
||||
html[data-theme="dark"] {
|
||||
--sg-text-color: #fff;
|
||||
--sg-tr-odd-color: #373737;
|
||||
--sg-tr-hover-color: rgba(30, 81, 122, 0.2);
|
||||
}
|
||||
|
||||
table.dataframe {
|
||||
border: none !important;
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
border-color: transparent;
|
||||
color: var(--sg-text-color);
|
||||
font-size: 12px;
|
||||
table-layout: fixed;
|
||||
}
|
||||
table.dataframe thead {
|
||||
border-bottom: 1px solid var(--sg-text-color);
|
||||
vertical-align: bottom;
|
||||
}
|
||||
table.dataframe tr,
|
||||
table.dataframe th,
|
||||
table.dataframe td {
|
||||
text-align: right;
|
||||
vertical-align: middle;
|
||||
padding: 0.5em 0.5em;
|
||||
line-height: normal;
|
||||
white-space: normal;
|
||||
max-width: none;
|
||||
border: none;
|
||||
}
|
||||
table.dataframe th {
|
||||
font-weight: bold;
|
||||
}
|
||||
table.dataframe tbody tr:nth-child(odd) {
|
||||
background: var(--sg-tr-odd-color);
|
||||
}
|
||||
table.dataframe tbody tr:hover {
|
||||
background: var(--sg-tr-hover-color);
|
||||
}
|
||||
224
_static/sg_gallery-rendered-html.css
Normal file
224
_static/sg_gallery-rendered-html.css
Normal file
@@ -0,0 +1,224 @@
|
||||
/* Adapted from notebook/static/style/style.min.css */
|
||||
html[data-theme="light"] {
|
||||
--sg-text-color: #000;
|
||||
--sg-background-color: #ffffff;
|
||||
--sg-code-background-color: #eff0f1;
|
||||
--sg-tr-hover-color: rgba(66, 165, 245, 0.2);
|
||||
--sg-tr-odd-color: #f5f5f5;
|
||||
}
|
||||
html[data-theme="dark"] {
|
||||
--sg-text-color: #fff;
|
||||
--sg-background-color: #121212;
|
||||
--sg-code-background-color: #2f2f30;
|
||||
--sg-tr-hover-color: rgba(66, 165, 245, 0.2);
|
||||
--sg-tr-odd-color: #1f1f1f;
|
||||
}
|
||||
|
||||
.rendered_html {
|
||||
color: var(--sg-text-color);
|
||||
/* any extras will just be numbers: */
|
||||
}
|
||||
.rendered_html em {
|
||||
font-style: italic;
|
||||
}
|
||||
.rendered_html strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
.rendered_html u {
|
||||
text-decoration: underline;
|
||||
}
|
||||
.rendered_html :link {
|
||||
text-decoration: underline;
|
||||
}
|
||||
.rendered_html :visited {
|
||||
text-decoration: underline;
|
||||
}
|
||||
.rendered_html h1 {
|
||||
font-size: 185.7%;
|
||||
margin: 1.08em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
}
|
||||
.rendered_html h2 {
|
||||
font-size: 157.1%;
|
||||
margin: 1.27em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
}
|
||||
.rendered_html h3 {
|
||||
font-size: 128.6%;
|
||||
margin: 1.55em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
}
|
||||
.rendered_html h4 {
|
||||
font-size: 100%;
|
||||
margin: 2em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
}
|
||||
.rendered_html h5 {
|
||||
font-size: 100%;
|
||||
margin: 2em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
font-style: italic;
|
||||
}
|
||||
.rendered_html h6 {
|
||||
font-size: 100%;
|
||||
margin: 2em 0 0 0;
|
||||
font-weight: bold;
|
||||
line-height: 1.0;
|
||||
font-style: italic;
|
||||
}
|
||||
.rendered_html h1:first-child {
|
||||
margin-top: 0.538em;
|
||||
}
|
||||
.rendered_html h2:first-child {
|
||||
margin-top: 0.636em;
|
||||
}
|
||||
.rendered_html h3:first-child {
|
||||
margin-top: 0.777em;
|
||||
}
|
||||
.rendered_html h4:first-child {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html h5:first-child {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html h6:first-child {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html ul:not(.list-inline),
|
||||
.rendered_html ol:not(.list-inline) {
|
||||
padding-left: 2em;
|
||||
}
|
||||
.rendered_html ul {
|
||||
list-style: disc;
|
||||
}
|
||||
.rendered_html ul ul {
|
||||
list-style: square;
|
||||
margin-top: 0;
|
||||
}
|
||||
.rendered_html ul ul ul {
|
||||
list-style: circle;
|
||||
}
|
||||
.rendered_html ol {
|
||||
list-style: decimal;
|
||||
}
|
||||
.rendered_html ol ol {
|
||||
list-style: upper-alpha;
|
||||
margin-top: 0;
|
||||
}
|
||||
.rendered_html ol ol ol {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
.rendered_html ol ol ol ol {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
.rendered_html ol ol ol ol ol {
|
||||
list-style: decimal;
|
||||
}
|
||||
.rendered_html * + ul {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html * + ol {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html hr {
|
||||
color: var(--sg-text-color);
|
||||
background-color: var(--sg-text-color);
|
||||
}
|
||||
.rendered_html pre {
|
||||
margin: 1em 2em;
|
||||
padding: 0px;
|
||||
background-color: var(--sg-background-color);
|
||||
}
|
||||
.rendered_html code {
|
||||
background-color: var(--sg-code-background-color);
|
||||
}
|
||||
.rendered_html p code {
|
||||
padding: 1px 5px;
|
||||
}
|
||||
.rendered_html pre code {
|
||||
background-color: var(--sg-background-color);
|
||||
}
|
||||
.rendered_html pre,
|
||||
.rendered_html code {
|
||||
border: 0;
|
||||
color: var(--sg-text-color);
|
||||
font-size: 100%;
|
||||
}
|
||||
.rendered_html blockquote {
|
||||
margin: 1em 2em;
|
||||
}
|
||||
.rendered_html table {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
border: none;
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
color: var(--sg-text-color);
|
||||
font-size: 12px;
|
||||
table-layout: fixed;
|
||||
}
|
||||
.rendered_html thead {
|
||||
border-bottom: 1px solid var(--sg-text-color);
|
||||
vertical-align: bottom;
|
||||
}
|
||||
.rendered_html tr,
|
||||
.rendered_html th,
|
||||
.rendered_html td {
|
||||
text-align: right;
|
||||
vertical-align: middle;
|
||||
padding: 0.5em 0.5em;
|
||||
line-height: normal;
|
||||
white-space: normal;
|
||||
max-width: none;
|
||||
border: none;
|
||||
}
|
||||
.rendered_html th {
|
||||
font-weight: bold;
|
||||
}
|
||||
.rendered_html tbody tr:nth-child(odd) {
|
||||
background: var(--sg-tr-odd-color);
|
||||
}
|
||||
.rendered_html tbody tr:hover {
|
||||
color: var(--sg-text-color);
|
||||
background: var(--sg-tr-hover-color);
|
||||
}
|
||||
.rendered_html * + table {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html p {
|
||||
text-align: left;
|
||||
}
|
||||
.rendered_html * + p {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html img {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
.rendered_html * + img {
|
||||
margin-top: 1em;
|
||||
}
|
||||
.rendered_html img,
|
||||
.rendered_html svg {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
.rendered_html img.unconfined,
|
||||
.rendered_html svg.unconfined {
|
||||
max-width: none;
|
||||
}
|
||||
.rendered_html .alert {
|
||||
margin-bottom: initial;
|
||||
}
|
||||
.rendered_html * + .alert {
|
||||
margin-top: 1em;
|
||||
}
|
||||
[dir="rtl"] .rendered_html p {
|
||||
text-align: right;
|
||||
}
|
||||
342
_static/sg_gallery.css
Normal file
342
_static/sg_gallery.css
Normal file
@@ -0,0 +1,342 @@
|
||||
/*
|
||||
Sphinx-Gallery has compatible CSS to fix default sphinx themes
|
||||
Tested for Sphinx 1.3.1 for all themes: default, alabaster, sphinxdoc,
|
||||
scrolls, agogo, traditional, nature, haiku, pyramid
|
||||
Tested for Read the Docs theme 0.1.7 */
|
||||
|
||||
/* Define light colors */
|
||||
:root, html[data-theme="light"], body[data-theme="light"]{
|
||||
--sg-tooltip-foreground: black;
|
||||
--sg-tooltip-background: rgba(250, 250, 250, 0.9);
|
||||
--sg-tooltip-border: #ccc transparent;
|
||||
--sg-thumb-box-shadow-color: #6c757d40;
|
||||
--sg-thumb-hover-border: #0069d9;
|
||||
--sg-script-out: #888;
|
||||
--sg-script-pre: #fafae2;
|
||||
--sg-pytb-foreground: #000;
|
||||
--sg-pytb-background: #ffe4e4;
|
||||
--sg-pytb-border-color: #f66;
|
||||
--sg-download-a-background-color: #ffc;
|
||||
--sg-download-a-background-image: linear-gradient(to bottom, #ffc, #d5d57e);
|
||||
--sg-download-a-border-color: 1px solid #c2c22d;
|
||||
--sg-download-a-color: #000;
|
||||
--sg-download-a-hover-background-color: #d5d57e;
|
||||
--sg-download-a-hover-box-shadow-1: rgba(255, 255, 255, 0.1);
|
||||
--sg-download-a-hover-box-shadow-2: rgba(0, 0, 0, 0.25);
|
||||
}
|
||||
@media(prefers-color-scheme: light) {
|
||||
:root[data-theme="auto"], html[data-theme="auto"], body[data-theme="auto"] {
|
||||
--sg-tooltip-foreground: black;
|
||||
--sg-tooltip-background: rgba(250, 250, 250, 0.9);
|
||||
--sg-tooltip-border: #ccc transparent;
|
||||
--sg-thumb-box-shadow-color: #6c757d40;
|
||||
--sg-thumb-hover-border: #0069d9;
|
||||
--sg-script-out: #888;
|
||||
--sg-script-pre: #fafae2;
|
||||
--sg-pytb-foreground: #000;
|
||||
--sg-pytb-background: #ffe4e4;
|
||||
--sg-pytb-border-color: #f66;
|
||||
--sg-download-a-background-color: #ffc;
|
||||
--sg-download-a-background-image: linear-gradient(to bottom, #ffc, #d5d57e);
|
||||
--sg-download-a-border-color: 1px solid #c2c22d;
|
||||
--sg-download-a-color: #000;
|
||||
--sg-download-a-hover-background-color: #d5d57e;
|
||||
--sg-download-a-hover-box-shadow-1: rgba(255, 255, 255, 0.1);
|
||||
--sg-download-a-hover-box-shadow-2: rgba(0, 0, 0, 0.25);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme="dark"], body[data-theme="dark"] {
|
||||
--sg-tooltip-foreground: white;
|
||||
--sg-tooltip-background: rgba(10, 10, 10, 0.9);
|
||||
--sg-tooltip-border: #333 transparent;
|
||||
--sg-thumb-box-shadow-color: #79848d40;
|
||||
--sg-thumb-hover-border: #003975;
|
||||
--sg-script-out: rgb(179, 179, 179);
|
||||
--sg-script-pre: #2e2e22;
|
||||
--sg-pytb-foreground: #fff;
|
||||
--sg-pytb-background: #1b1717;
|
||||
--sg-pytb-border-color: #622;
|
||||
--sg-download-a-background-color: #443;
|
||||
--sg-download-a-background-image: linear-gradient(to bottom, #443, #221);
|
||||
--sg-download-a-border-color: 1px solid #3a3a0d;
|
||||
--sg-download-a-color: #fff;
|
||||
--sg-download-a-hover-background-color: #616135;
|
||||
--sg-download-a-hover-box-shadow-1: rgba(0, 0, 0, 0.1);
|
||||
--sg-download-a-hover-box-shadow-2: rgba(255, 255, 255, 0.25);
|
||||
}
|
||||
@media(prefers-color-scheme: dark){
|
||||
html[data-theme="auto"], body[data-theme="auto"] {
|
||||
--sg-tooltip-foreground: white;
|
||||
--sg-tooltip-background: rgba(10, 10, 10, 0.9);
|
||||
--sg-tooltip-border: #333 transparent;
|
||||
--sg-thumb-box-shadow-color: #79848d40;
|
||||
--sg-thumb-hover-border: #003975;
|
||||
--sg-script-out: rgb(179, 179, 179);
|
||||
--sg-script-pre: #2e2e22;
|
||||
--sg-pytb-foreground: #fff;
|
||||
--sg-pytb-background: #1b1717;
|
||||
--sg-pytb-border-color: #622;
|
||||
--sg-download-a-background-color: #443;
|
||||
--sg-download-a-background-image: linear-gradient(to bottom, #443, #221);
|
||||
--sg-download-a-border-color: 1px solid #3a3a0d;
|
||||
--sg-download-a-color: #fff;
|
||||
--sg-download-a-hover-background-color: #616135;
|
||||
--sg-download-a-hover-box-shadow-1: rgba(0, 0, 0, 0.1);
|
||||
--sg-download-a-hover-box-shadow-2: rgba(255, 255, 255, 0.25);
|
||||
}
|
||||
}
|
||||
|
||||
.sphx-glr-thumbnails {
|
||||
width: 100%;
|
||||
margin: 0px 0px 20px 0px;
|
||||
|
||||
/* align thumbnails on a grid */
|
||||
justify-content: space-between;
|
||||
display: grid;
|
||||
/* each grid column should be at least 160px (this will determine
|
||||
the actual number of columns) and then take as much of the
|
||||
remaining width as possible */
|
||||
grid-template-columns: repeat(auto-fill, minmax(160px, 1fr));
|
||||
gap: 15px;
|
||||
}
|
||||
.sphx-glr-thumbnails .toctree-wrapper {
|
||||
/* hide empty toctree divs added to the DOM
|
||||
by sphinx even though the toctree is hidden
|
||||
(they would fill grid places with empty divs) */
|
||||
display: none;
|
||||
}
|
||||
.sphx-glr-thumbcontainer {
|
||||
background: transparent;
|
||||
-moz-border-radius: 5px;
|
||||
-webkit-border-radius: 5px;
|
||||
border-radius: 5px;
|
||||
box-shadow: 0 0 10px var(--sg-thumb-box-shadow-color);
|
||||
|
||||
/* useful to absolutely position link in div */
|
||||
position: relative;
|
||||
|
||||
/* thumbnail width should include padding and borders
|
||||
and take all available space */
|
||||
box-sizing: border-box;
|
||||
width: 100%;
|
||||
padding: 10px;
|
||||
border: 1px solid transparent;
|
||||
|
||||
/* align content in thumbnail */
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: center;
|
||||
gap: 7px;
|
||||
}
|
||||
.sphx-glr-thumbcontainer p {
|
||||
position: absolute;
|
||||
top: 0;
|
||||
left: 0;
|
||||
}
|
||||
.sphx-glr-thumbcontainer p,
|
||||
.sphx-glr-thumbcontainer p a {
|
||||
/* link should cover the whole thumbnail div */
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
}
|
||||
.sphx-glr-thumbcontainer p a span {
|
||||
/* text within link should be masked
|
||||
(we are just interested in the href) */
|
||||
display: none;
|
||||
}
|
||||
.sphx-glr-thumbcontainer:hover {
|
||||
border: 1px solid;
|
||||
border-color: var(--sg-thumb-hover-border);
|
||||
cursor: pointer;
|
||||
}
|
||||
.sphx-glr-thumbcontainer a.internal {
|
||||
bottom: 0;
|
||||
display: block;
|
||||
left: 0;
|
||||
box-sizing: border-box;
|
||||
padding: 150px 10px 0;
|
||||
position: absolute;
|
||||
right: 0;
|
||||
top: 0;
|
||||
}
|
||||
/* Next one is to avoid Sphinx traditional theme to cover all the
|
||||
thumbnail with its default link Background color */
|
||||
.sphx-glr-thumbcontainer a.internal:hover {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.sphx-glr-thumbcontainer p {
|
||||
margin: 0 0 0.1em 0;
|
||||
}
|
||||
.sphx-glr-thumbcontainer .figure {
|
||||
margin: 10px;
|
||||
width: 160px;
|
||||
}
|
||||
.sphx-glr-thumbcontainer img {
|
||||
display: inline;
|
||||
max-height: 112px;
|
||||
max-width: 160px;
|
||||
}
|
||||
.sphx-glr-thumbcontainer[tooltip]:hover:after {
|
||||
background: var(--sg-tooltip-background);
|
||||
-webkit-border-radius: 4px;
|
||||
-moz-border-radius: 4px;
|
||||
border-radius: 4px;
|
||||
color: var(--sg-tooltip-foreground);
|
||||
content: attr(tooltip);
|
||||
padding: 10px;
|
||||
z-index: 98;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
position: absolute;
|
||||
pointer-events: none;
|
||||
top: 0;
|
||||
box-sizing: border-box;
|
||||
overflow: hidden;
|
||||
backdrop-filter: blur(3px);
|
||||
}
|
||||
|
||||
.sphx-glr-script-out {
|
||||
color: var(--sg-script-out);
|
||||
display: flex;
|
||||
gap: 0.5em;
|
||||
}
|
||||
.sphx-glr-script-out::before {
|
||||
content: "Out:";
|
||||
/* These numbers come from the pre style in the pydata sphinx theme. This
|
||||
* turns out to match perfectly on the rtd theme, but be a bit too low for
|
||||
* the pydata sphinx theme. As I could not find a dimension to use that was
|
||||
* scaled the same way, I just picked one option that worked pretty close for
|
||||
* both. */
|
||||
line-height: 1.4;
|
||||
padding-top: 10px;
|
||||
}
|
||||
.sphx-glr-script-out .highlight {
|
||||
background-color: transparent;
|
||||
/* These options make the div expand... */
|
||||
flex-grow: 1;
|
||||
/* ... but also keep it from overflowing its flex container. */
|
||||
overflow: auto;
|
||||
}
|
||||
.sphx-glr-script-out .highlight pre {
|
||||
background-color: var(--sg-script-pre);
|
||||
border: 0;
|
||||
max-height: 30em;
|
||||
overflow: auto;
|
||||
padding-left: 1ex;
|
||||
/* This margin is necessary in the pydata sphinx theme because pre has a box
|
||||
* shadow which would be clipped by the overflow:auto in the parent div
|
||||
* above. */
|
||||
margin: 2px;
|
||||
word-break: break-word;
|
||||
}
|
||||
.sphx-glr-script-out + p {
|
||||
margin-top: 1.8em;
|
||||
}
|
||||
blockquote.sphx-glr-script-out {
|
||||
margin-left: 0pt;
|
||||
}
|
||||
.sphx-glr-script-out.highlight-pytb .highlight pre {
|
||||
color: var(--sg-pytb-foreground);
|
||||
background-color: var(--sg-pytb-background);
|
||||
border: 1px solid var(--sg-pytb-border-color);
|
||||
margin-top: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.sphx-glr-footer {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphx-glr-download {
|
||||
margin: 1em auto;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.sphx-glr-download a {
|
||||
background-color: var(--sg-download-a-background-color);
|
||||
background-image: var(--sg-download-a-background-image);
|
||||
border-radius: 4px;
|
||||
border: 1px solid var(--sg-download-a-border-color);
|
||||
color: var(--sg-download-a-color);
|
||||
display: inline-block;
|
||||
font-weight: bold;
|
||||
padding: 1ex;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
div.sphx-glr-download code.download {
|
||||
display: inline-block;
|
||||
white-space: normal;
|
||||
word-break: normal;
|
||||
overflow-wrap: break-word;
|
||||
/* border and background are given by the enclosing 'a' */
|
||||
border: none;
|
||||
background: none;
|
||||
}
|
||||
|
||||
div.sphx-glr-download a:hover {
|
||||
box-shadow: inset 0 1px 0 var(--sg-download-a-hover-box-shadow-1), 0 1px 5px var(--sg-download-a-hover-box-shadow-2);
|
||||
text-decoration: none;
|
||||
background-image: none;
|
||||
background-color: var(--sg-download-a-hover-background-color);
|
||||
}
|
||||
|
||||
.sphx-glr-example-title:target::before {
|
||||
display: block;
|
||||
content: "";
|
||||
margin-top: -50px;
|
||||
height: 50px;
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
ul.sphx-glr-horizontal {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
}
|
||||
ul.sphx-glr-horizontal li {
|
||||
display: inline;
|
||||
}
|
||||
ul.sphx-glr-horizontal img {
|
||||
height: auto !important;
|
||||
}
|
||||
|
||||
.sphx-glr-single-img {
|
||||
margin: auto;
|
||||
display: block;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.sphx-glr-multi-img {
|
||||
max-width: 42%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
div.sphx-glr-animation {
|
||||
margin: auto;
|
||||
display: block;
|
||||
max-width: 100%;
|
||||
}
|
||||
div.sphx-glr-animation .animation {
|
||||
display: block;
|
||||
}
|
||||
|
||||
p.sphx-glr-signature a.reference.external {
|
||||
-moz-border-radius: 5px;
|
||||
-webkit-border-radius: 5px;
|
||||
border-radius: 5px;
|
||||
padding: 3px;
|
||||
font-size: 75%;
|
||||
text-align: right;
|
||||
margin-left: auto;
|
||||
display: table;
|
||||
}
|
||||
|
||||
.sphx-glr-clear {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
a.sphx-glr-backref-instance {
|
||||
text-decoration: none;
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -113,6 +113,15 @@
|
||||
menuElem.classList.remove("active");
|
||||
});
|
||||
|
||||
const sortVersions = (a, b) => {
|
||||
if (a.replace("v", "") > b.replace("v", ""))
|
||||
return -1
|
||||
else if (a.replace("v", "") < b.replace("v", ""))
|
||||
return 1
|
||||
else
|
||||
return 0
|
||||
}
|
||||
|
||||
if (githubUser !== null || repo !== null) {
|
||||
const basePath = "";
|
||||
const mainBranchName = "main"
|
||||
@@ -125,7 +134,7 @@
|
||||
}
|
||||
response.json().then(json => {
|
||||
const versions = json.tree.filter(v => versionRegex.test(v.path)).map(v => v.path);
|
||||
versions.reverse();
|
||||
versions.sort(sortVersions);
|
||||
// verify if exists a directory with main version
|
||||
if (json.tree.filter(v => v.path == mainBranchName).length > 0) {
|
||||
versions.unshift(mainBranchName);
|
||||
|
||||
34
api/env/index.html
vendored
34
api/env/index.html
vendored
@@ -15,7 +15,11 @@
|
||||
<title>Env - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -766,11 +778,11 @@ For more information see the environment creation tutorial.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -941,7 +953,7 @@ For more information see the environment creation tutorial.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Functional Environment - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -607,11 +619,11 @@ we intend to flesh it out and officially expose it to end users.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -781,7 +793,7 @@ we intend to flesh it out and officially expose it to end users.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Experimental - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -701,11 +713,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -875,7 +887,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Vectorizing Environment - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -518,11 +530,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -692,7 +704,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Vector Environment Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -518,11 +530,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -692,7 +704,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -430,11 +442,13 @@
|
||||
If the observations from <code class="xref py py-attr docutils literal notranslate"><span class="pre">func</span></code> are outside the bounds of the <cite>env</cite> spaces, provide a <a class="reference internal" href="../../vector/#observation_space" title="observation_space"><code class="xref py py-attr docutils literal notranslate"><span class="pre">observation_space</span></code></a>.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">LambdaObservationV0</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</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="s1">'CartPole-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">LambdaObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="n">obs</span> <span class="o">+</span> <span class="mf">0.1</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([-0.08319338, 0.04635121, -0.07394746, 0.20877492])</span>
|
||||
<span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="mi">0</span><span class="p">)</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">LambdaObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="n">obs</span> <span class="o">+</span> <span class="mf">0.1</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">random</span><span class="p">(</span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span><span class="p">),</span> <span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([ 0.06199517, 0.0511615 , -0.04432538, 0.02694618]), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Constructor for the lambda observation wrapper.</p>
|
||||
@@ -455,17 +469,18 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<dd><p>Filter Dict observation space by the keys.</p>
|
||||
<p class="rubric">Example</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="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">wrappers</span><span class="o">.</span><span class="n">TransformObservation</span><span class="p">(</span>
|
||||
<span class="gp">... </span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">'CartPole-v1'</span><span class="p">),</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="p">{</span><span class="s1">'obs'</span><span class="p">:</span> <span class="n">obs</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span>
|
||||
<span class="gp">... </span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TransformObservation</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">FilterObservationV0</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">"CartPole-v1"</span><span class="p">)</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">wrappers</span><span class="o">.</span><span class="n">TransformObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="p">{</span><span class="s1">'obs'</span><span class="p">:</span> <span class="n">obs</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">:</span> <span class="mi">0</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span><span class="n">obs</span><span class="o">=</span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">,</span> <span class="n">time</span><span class="o">=</span><span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">{'obs': array([-0.00067088, -0.01860439, 0.04772898, -0.01911527], dtype=float32), 'time': 0}</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="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">({'obs': array([ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 ], dtype=float32), 'time': 0}, {})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FilterObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">filter_keys</span><span class="o">=</span><span class="p">[</span><span class="s1">'time'</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">{'obs': array([ 0.04560107, 0.04466959, -0.0328232 , -0.02367178], dtype=float32)}</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="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">({'time': 0}, {})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="go">({'obs': array([ 0.04649447, -0.14996664, -0.03329664, 0.25847703], dtype=float32)}, 1.0, False, {})</span>
|
||||
<span class="go">({'time': 0}, 1.0, False, False, {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Constructor for an environment with a dictionary observation space where all <code class="xref py py-attr docutils literal notranslate"><span class="pre">filter_keys</span></code> are in the observation space keys.</p>
|
||||
@@ -477,13 +492,14 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<dd><p>Observation wrapper that flattens the observation.</p>
|
||||
<p class="rubric">Example</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="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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">FlattenObservationV0</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FlattenObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(27648,)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(27648,)</span>
|
||||
</pre></div>
|
||||
@@ -498,7 +514,8 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">keep_dim</span></code> will keep the channel dimension</p>
|
||||
<p class="rubric">Example</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="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">"CarRacing-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">GrayscaleObservationV0</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">grayscale_env</span> <span class="o">=</span> <span class="n">GrayscaleObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
@@ -518,6 +535,7 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<dd><p>Resizes image observations using OpenCV to shape.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">ResizeObservationV0</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
@@ -535,7 +553,8 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<dd><p>Reshapes array based observations to shapes.</p>
|
||||
<p class="rubric">Example</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="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">"CarRacing-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">ReshapeObservationV0</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">reshape_env</span> <span class="o">=</span> <span class="n">ReshapeObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="p">(</span><span class="mi">24</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">96</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">))</span>
|
||||
@@ -552,11 +571,13 @@ If the observations from <code class="xref py py-attr docutils literal notransla
|
||||
<dd><p>Linearly rescales observation to between a minimum and maximum value.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">RescaleObservationV0</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">"Pendulum-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box([-1. -1. -8.], [1. 1. 8.], (3,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">RescaleObservationV0</span><span class="p">(</span><span class="n">env</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">2</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="o">-</span><span class="mi">10</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="go">Box([-2. -1. -10.], [1. 0. 1.], (3,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box([ -2. -1. -10.], [1. 0. 1.], (3,), float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Constructor that requires the env observation spaces to be a <code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code>.</p>
|
||||
@@ -628,25 +649,27 @@ as the final element in the tuple.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">TimeAwareObservationV0</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="s1">'CartPole-v1'</span><span class="p">)</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TimeAwareObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Dict(obs: Box([-4.8000002e+00 -3.4028235e+38 -4.1887903e-01 -3.4028235e+38], [4.8000002e+00 3.4028235e+38 4.1887903e-01 3.4028235e+38], (4,), float32), time: Box(0.0, 500, (1,), float32))</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">Dict('obs': Box([-4.8000002e+00 -3.4028235e+38 -4.1887903e-01 -3.4028235e+38], [4.8000002e+00 3.4028235e+38 4.1887903e-01 3.4028235e+38], (4,), float32), 'time': Box(0.0, 1.0, (1,), float32))</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</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">seed</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</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><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="go">OrderedDict([('obs',</span>
|
||||
<span class="gp">... </span> <span class="n">array</span><span class="p">([</span> <span class="mf">0.02866629</span><span class="p">,</span> <span class="mf">0.2310988</span> <span class="p">,</span> <span class="o">-</span><span class="mf">0.02614601</span><span class="p">,</span> <span class="o">-</span><span class="mf">0.2600732</span> <span class="p">],</span> <span class="n">dtype</span><span class="o">=</span><span class="n">float32</span><span class="p">)),</span>
|
||||
<span class="gp">... </span> <span class="p">(</span><span class="s1">'time'</span><span class="p">,</span> <span class="n">array</span><span class="p">([</span><span class="mf">0.002</span><span class="p">]))])</span>
|
||||
<span class="go">{'obs': array([ 0.02727336, -0.20172954, 0.03625453, 0.32351476], dtype=float32), 'time': 0.002}</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt>Flatten observation space example:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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="s1">'CartPole-v1'</span><span class="p">)</span>
|
||||
<dt>Flatten observation space example:</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TimeAwareObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">flatten</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box([-4.8000002e+00 -3.4028235e+38 -4.1887903e-01 -3.4028235e+38 0.0000000e+00], [4.8000002e+00 3.4028235e+38 4.1887903e-01 3.4028235e+38 500], (5,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">Box([-4.8000002e+00 -3.4028235e+38 -4.1887903e-01 -3.4028235e+38</span>
|
||||
<span class="go"> 0.0000000e+00], [4.8000002e+00 3.4028235e+38 4.1887903e-01 3.4028235e+38 1.0000000e+00], (5,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</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">seed</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</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><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="go">array([-0.01232257, 0.19335455, -0.02244143, -0.32388705, 0.002 ], dtype=float32)</span>
|
||||
<span class="go">array([ 0.02727336, -0.20172954, 0.03625453, 0.32351476, 0.002 ],</span>
|
||||
<span class="go"> dtype=float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
@@ -682,11 +705,12 @@ I.e. the observation returned by <code class="xref py py-meth docutils literal n
|
||||
</div>
|
||||
<p class="rubric">Example</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="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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FrameStack</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">FrameStackObservationV0</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FrameStackObservationV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box(4, 96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">Box(0, 255, (4, 96, 96, 3), uint8)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(4, 96, 96, 3)</span>
|
||||
</pre></div>
|
||||
@@ -792,13 +816,15 @@ optimization benefits of FrameStack Wrapper.</p></li>
|
||||
<dd><p>Clip the continuous action within the valid <code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code> observation space bound.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">ClipActionV0</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</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="s1">'BipedalWalker-v3'</span><span class="p">,</span> <span class="n">disable_env_checker</span><span class="o">=</span><span class="kc">True</span><span class="p">)</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">"Hopper-v4"</span><span class="p">,</span> <span class="n">disable_env_checker</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">ClipActionV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box(-1.0, 1.0, (4,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</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="mf">5.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">10.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]))</span>
|
||||
<span class="go"># Executes the action np.array([1.0, 1.0, -1.0, 0]) in the base environment</span>
|
||||
<span class="go">Box(-inf, inf, (3,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </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">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">5.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]))</span>
|
||||
<span class="gp">... </span><span class="c1"># Executes the action np.array([1.0, -1.0, 0]) in the base environment</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper for clipping continuous actions within the valid bound.</p>
|
||||
@@ -817,13 +843,14 @@ optimization benefits of FrameStack Wrapper.</p></li>
|
||||
or <code class="xref py py-attr docutils literal notranslate"><span class="pre">max_action</span></code> are numpy arrays, the shape must match the shape of the environment’s action space.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">RescaleActionV0</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</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="s1">'BipedalWalker-v3'</span><span class="p">,</span> <span class="n">disable_env_checker</span><span class="o">=</span><span class="kc">True</span><span class="p">)</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">"Hopper-v4"</span><span class="p">,</span> <span class="n">disable_env_checker</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</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">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">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</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">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">1</span><span class="p">,</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">min_action</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.5</span>
|
||||
<span class="gp">>>> </span><span class="n">max_action</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="mf">0.0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.75</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">max_action</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="mf">0.0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.75</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span> <span class="o">=</span> <span class="n">RescaleActionV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">min_action</span><span class="o">=</span><span class="n">min_action</span><span class="p">,</span> <span class="n">max_action</span><span class="o">=</span><span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env_obs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped_env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">alltrue</span><span class="p">(</span><span class="n">obs</span> <span class="o">==</span> <span class="n">wrapped_env_obs</span><span class="p">)</span>
|
||||
@@ -897,7 +924,7 @@ in Section 5.2 on page 12.</p>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">ClipRewardV0</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">ClipRewardV0</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span><span class="p">,</span> <span class="n">rew</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</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="mi">1</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">rew</span>
|
||||
<span class="go">0.5</span>
|
||||
@@ -922,6 +949,9 @@ in Section 5.2 on page 12.</p>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.experimental.wrappers.</span></span><span class="sig-name descname"><span class="pre">NormalizeRewardV0</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">gamma</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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.99</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">epsilon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</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">1e-8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.experimental.wrappers.NormalizeRewardV0" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>This wrapper will normalize immediate rewards s.t. their exponential moving average has a fixed variance.</p>
|
||||
<p>The exponential moving average will have variance <span class="math notranslate nohighlight">\((1 - \gamma)^2\)</span>.</p>
|
||||
<p>The property <cite>_update_running_mean</cite> allows to freeze/continue the running mean calculation of the reward
|
||||
statistics. If <cite>True</cite> (default), the <cite>RunningMeanStd</cite> will get updated every time <cite>self.normalize()</cite> is called.
|
||||
If False, the calculated statistics are used but not updated anymore; this may be used during evaluation.</p>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>The scaling depends on past trajectories and rewards will not be scaled correctly if the wrapper was newly
|
||||
@@ -966,16 +996,17 @@ instantiated or the policy was changed recently.</p>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.experimental.wrappers.</span></span><span class="sig-name descname"><span class="pre">OrderEnforcingV0</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">disable_render_order_enforcing</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.experimental.wrappers.OrderEnforcingV0" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>A wrapper that will produce an error if <code class="xref py py-meth docutils literal notranslate"><span class="pre">step()</span></code> is called before an initial <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code>.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.envs.classic_control</span> <span class="kn">import</span> <span class="n">CartPoleEnv</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">CartPoleEnv</span><span class="p">()</span>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">OrderEnforcingV0</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">"CartPole-v1"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">OrderEnforcingV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="go">ResetNeeded: Cannot call env.step() before calling env.reset()</span>
|
||||
<span class="go">gymnasium.error.ResetNeeded: Cannot call env.step() before calling env.reset()</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="go">ResetNeeded: Cannot call env.render() before calling env.reset()</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">gymnasium.error.ResetNeeded('Cannot call `env.render()` before calling `env.reset()`, if this is a intended action, set `disable_render_order_enforcing=True` on the OrderEnforcer wrapper.')</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="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="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="gp">>>> </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="mi">0</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper that will produce an error if <code class="xref py py-meth docutils literal notranslate"><span class="pre">step()</span></code> is called before an initial <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code>.</p>
|
||||
@@ -999,7 +1030,6 @@ using the key <code class="docutils literal notranslate"><span class="pre">episo
|
||||
the episode statistics.</p>
|
||||
<p>After the completion of an episode, <code class="docutils literal notranslate"><span class="pre">info</span></code> will look like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="o">...</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<cumulative reward>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<episode length>"</span><span class="p">,</span>
|
||||
@@ -1010,7 +1040,10 @@ the episode statistics.</p>
|
||||
</div>
|
||||
<p>For a vectorized environments the output will be in the form of:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">infos</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="o">...</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_observation"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_observation"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_info"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_info"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<array of cumulative reward>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<array of episode length>"</span><span class="p">,</span>
|
||||
@@ -1047,12 +1080,32 @@ the episode statistics.</p>
|
||||
<h2>Rendering Wrappers<a class="headerlink" href="#rendering-wrappers" title="Permalink to this heading">#</a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="gymnasium.experimental.wrappers.RecordVideoV0">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.experimental.wrappers.</span></span><span class="sig-name descname"><span class="pre">RecordVideoV0</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 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">ActType</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.experimental.wrappers.RecordVideoV0" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Record a video of an environment.</p>
|
||||
<p>Wraps an environment to allow a modular transformation of the <code class="xref py py-meth docutils literal notranslate"><span class="pre">step()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code> methods.</p>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.experimental.wrappers.</span></span><span class="sig-name descname"><span class="pre">RecordVideoV0</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">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">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">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">disable_logger</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.experimental.wrappers.RecordVideoV0" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>This wrapper records videos of rollouts.</p>
|
||||
<p>Usually, you only want to record episodes intermittently, say every hundredth episode.
|
||||
To do this, you can specify <code class="docutils literal notranslate"><span class="pre">episode_trigger</span></code> or <code class="docutils literal notranslate"><span class="pre">step_trigger</span></code>.
|
||||
They should be functions returning a boolean that indicates whether a recording should be started at the
|
||||
current episode or step, respectively.
|
||||
If neither <code class="xref py py-attr docutils literal notranslate"><span class="pre">episode_trigger</span></code> nor <code class="docutils literal notranslate"><span class="pre">step_trigger</span></code> is passed, a default <code class="docutils literal notranslate"><span class="pre">episode_trigger</span></code> will be employed,
|
||||
i.e. capped_cubic_video_schedule. This function starts a video at every episode that is a power of 3 until 1000 and
|
||||
then every 1000 episodes.
|
||||
By default, the recording will be stopped once reset is called. However, you can also create recordings of fixed
|
||||
length (possibly spanning several episodes) by passing a strictly positive value for <code class="docutils literal notranslate"><span class="pre">video_length</span></code>.
|
||||
This wrapper uses the value <cite>fps</cite> from metadata as the number of frames per second;
|
||||
if <cite>fps</cite> is not defined in metadata, the default value 30 is used.</p>
|
||||
<p>Wrapper records videos of rollouts.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><strong>env</strong> – The environment to wrap</p>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>env</strong> – The environment that will be wrapped</p></li>
|
||||
<li><p><strong>video_folder</strong> (<em>str</em>) – The folder where the recordings will be stored</p></li>
|
||||
<li><p><strong>episode_trigger</strong> – Function that accepts an integer and returns <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> – Function that accepts an integer and returns <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>) – The length of recorded episodes. If 0, entire episodes are recorded.
|
||||
Otherwise, snippets of the specified length are captured</p></li>
|
||||
<li><p><strong>name_prefix</strong> (<em>str</em>) – Will be prepended to the filename of the recordings</p></li>
|
||||
<li><p><strong>disable_logger</strong> (<em>bool</em>) – Whether to disable moviepy logger or not</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1067,26 +1120,28 @@ If you want to use this wrapper with your environments, remember to specify <cod
|
||||
in the metadata of your environment.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">render_mode</span></code> of the wrapped environment must be either <code class="docutils literal notranslate"><span class="pre">'rgb_array'</span></code> or <code class="docutils literal notranslate"><span class="pre">'rgb_array_list'</span></code>.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"LunarLander-v2"</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>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.experimental.wrappers</span> <span class="kn">import</span> <span class="n">HumanRenderingV0</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">"LunarLander-v2"</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="gp">>>> </span><span class="n">wrapped</span> <span class="o">=</span> <span class="n">HumanRenderingV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The wrapper can also be applied directly when the environment is instantiated, simply by passing
|
||||
<code class="docutils literal notranslate"><span class="pre">render_mode="human"</span></code> to <code class="docutils literal notranslate"><span class="pre">make</span></code>. The wrapper will only be applied if the environment does not
|
||||
implement human-rendering natively (i.e. <code class="docutils literal notranslate"><span class="pre">render_mode</span></code> does not contain <code class="docutils literal notranslate"><span class="pre">"human"</span></code>).</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"NoNativeRendering-v2"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span> <span class="c1"># NoNativeRendering-v0 doesn't implement human-rendering natively</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="c1"># This will start rendering to the screen</span>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"CartPoleJax-v1"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span> <span class="c1"># CartPoleJax-v1 doesn't implement human-rendering natively</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt>Warning: If the base environment uses <code class="docutils literal notranslate"><span class="pre">render_mode="rgb_array_list"</span></code>, its (i.e. the <em>base environment’s</em>) render method</dt><dd><p>will always return an empty list:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"LunarLander-v2"</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>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</span> <span class="o">=</span> <span class="n">HumanRenderingV0</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</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">render</span><span class="p">()</span>
|
||||
<span class="go">[] # env.render() will always return an empty list!</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped</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">render</span><span class="p">()</span> <span class="c1"># env.render() will always return an empty list!</span>
|
||||
<span class="go">[]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
@@ -1302,11 +1357,11 @@ The reason for this is jax does not support non-array values, therefore numpy <c
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1477,7 +1532,7 @@ The reason for this is jax does not support non-array values, therefore numpy <c
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Registry - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -641,11 +653,11 @@ instead of printing it to console.</p></li>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -815,7 +827,7 @@ instead of printing it to console.</p></li>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Composite Spaces - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -429,9 +441,9 @@
|
||||
<p>Elements of this space are (ordered) dictionaries of elements from the constituent spaces.</p>
|
||||
<p>Example usage:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Discrete</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span><span class="s2">"position"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="s2">"velocity"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">)})</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span><span class="s2">"position"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="s2">"velocity"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">)},</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go">OrderedDict([('position', 1), ('velocity', 2)])</span>
|
||||
<span class="go">OrderedDict([('position', 0), ('velocity', 2)])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Example usage [nested]:</p>
|
||||
@@ -466,9 +478,9 @@ keyword arguments (where you will need to avoid the keys <code class="docutils l
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span><span class="p">,</span> <span class="n">Discrete</span>
|
||||
<span class="gp">>>> </span><span class="n">Dict</span><span class="p">({</span><span class="s2">"position"</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,)),</span> <span class="s2">"color"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">)})</span>
|
||||
<span class="go">Dict(color:Discrete(3), position:Box(-1.0, 1.0, (2,), float32))</span>
|
||||
<span class="go">Dict('color': Discrete(3), 'position': Box(-1.0, 1.0, (2,), float32))</span>
|
||||
<span class="gp">>>> </span><span class="n">Dict</span><span class="p">(</span><span class="n">position</span><span class="o">=</span><span class="n">Box</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,)),</span> <span class="n">color</span><span class="o">=</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">))</span>
|
||||
<span class="go">Dict(color:Discrete(3), position:Box(-1.0, 1.0, (2,), float32))</span>
|
||||
<span class="go">Dict('position': Box(-1.0, 1.0, (2,), float32), 'color': Discrete(3))</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
@@ -524,9 +536,9 @@ keyword arguments (where you will need to avoid the keys <code class="docutils l
|
||||
<p>Elements of this space are tuples of elements of the constituent spaces.</p>
|
||||
<p>Example usage:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span><span class="p">,</span> <span class="n">Discrete</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">Tuple</span><span class="p">((</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">Box</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,))))</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">Tuple</span><span class="p">((</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="n">Box</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,))),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go">(0, array([0.03633198, 0.42370757], dtype=float32))</span>
|
||||
<span class="go">(0, array([-0.3991573 , 0.21649833], dtype=float32))</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Constructor of <a class="reference internal" href="#gymnasium.spaces.Tuple" title="gymnasium.spaces.Tuple"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tuple</span></code></a> space.</p>
|
||||
@@ -585,11 +597,11 @@ expects the same number of masks as spaces</p>
|
||||
to some space that is specified during initialization and the integer <span class="math notranslate nohighlight">\(n\)</span> is not fixed</p>
|
||||
<dl>
|
||||
<dt>Example::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Sequence</span><span class="p">(</span><span class="n">Box</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Sequence</span><span class="p">(</span><span class="n">Box</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go">(array([0.0259352], dtype=float32),)</span>
|
||||
<span class="go">(array([0.6369617], dtype=float32),)</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go">(array([0.80977976], dtype=float32), array([0.80066574], dtype=float32), array([0.77165383], dtype=float32))</span>
|
||||
<span class="go">(array([0.01652764], dtype=float32), array([0.8132702], dtype=float32),)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
@@ -799,11 +811,11 @@ If no <cite>num_edges</cite> is provided then the <cite>edge_mask</cite> is mult
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -974,7 +986,7 @@ If no <cite>num_edges</cite> is provided then the <cite>edge_mask</cite> is mult
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Fundamental Spaces - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -433,13 +445,13 @@ Each interval has the form of one of <span class="math notranslate nohighlight">
|
||||
<ul>
|
||||
<li><p>Identical bound for each dimension:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=-</span><span class="mf">1.0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mf">2.0</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="go">Box(3, 4)</span>
|
||||
<span class="go">Box(-1.0, 2.0, (3, 4), float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
<li><p>Independent bound for each dimension:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Box</span><span class="p">(</span><span class="n">low</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="o">-</span><span class="mf">1.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.0</span><span class="p">]),</span> <span class="n">high</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="mf">2.0</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">]),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="go">Box(2,)</span>
|
||||
<span class="go">Box([-1. -2.], [2. 4.], (2,), float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</li>
|
||||
@@ -522,7 +534,9 @@ that is chosen according to the form of the interval:</p>
|
||||
<p>This class represents a finite subset of integers, more specifically a set of the form <span class="math notranslate nohighlight">\(\{ a, a+1, \dots, a+n-1 \}\)</span>.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c1"># {0, 1}</span>
|
||||
<span class="go">Discrete(2)</span>
|
||||
<span class="gp">>>> </span><span class="n">Discrete</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="n">start</span><span class="o">=-</span><span class="mi">1</span><span class="p">)</span> <span class="c1"># {-1, 0, 1}</span>
|
||||
<span class="go">Discrete(3, start=-1)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Constructor of <a class="reference internal" href="#gymnasium.spaces.Discrete" title="gymnasium.spaces.Discrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">Discrete</span></code></a> space.</p>
|
||||
@@ -570,13 +584,13 @@ If there are no possible actions (i.e. <cite>np.all(mask == 0)</cite>) then <cit
|
||||
<dd><p>An n-shape binary space.</p>
|
||||
<p>Elements of this space are binary arrays of a shape that is fixed during construction.</p>
|
||||
<p>Example Usage:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">MultiBinary</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">MultiBinary</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go"> array([0, 1, 0, 1, 0], dtype=int8)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">MultiBinary</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">])</span>
|
||||
<span class="go">array([1, 0, 1, 0, 1], dtype=int8)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">MultiBinary</span><span class="p">([</span><span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">observation_space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="go"> array([[0, 0],</span>
|
||||
<span class="go"> [0, 1],</span>
|
||||
<span class="go">array([[1, 0],</span>
|
||||
<span class="go"> [1, 0],</span>
|
||||
<span class="go"> [1, 1]], dtype=int8)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -637,7 +651,7 @@ The expected mask shape is the space shape and mask dtype is <cite>np.int8</cite
|
||||
<p>Although this feature is rarely used, <a class="reference internal" href="#gymnasium.spaces.MultiDiscrete" title="gymnasium.spaces.MultiDiscrete"><code class="xref py py-class docutils literal notranslate"><span class="pre">MultiDiscrete</span></code></a> spaces may also have several axes
|
||||
if <code class="docutils literal notranslate"><span class="pre">nvec</span></code> has several axes:</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">MultiDiscrete</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">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">]]))</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">>></span> <span class="n">d</span> <span class="o">=</span> <span class="n">MultiDiscrete</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">2</span><span class="p">],</span> <span class="p">[</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">]]),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="o">>></span> <span class="n">d</span><span class="o">.</span><span class="n">sample</span><span class="p">()</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="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">]])</span>
|
||||
@@ -689,11 +703,13 @@ Only mask values == 1 are possible to sample unless all mask values for an actio
|
||||
<dl>
|
||||
<dt>Example::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># {"", "B5", "hello", ...}</span>
|
||||
<span class="gp">>>> </span><span class="n">Text</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
|
||||
<span class="go">Text(1, 5, characters=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz)</span>
|
||||
<span class="gp">>>> </span><span class="c1"># {"0", "42", "0123456789", ...}</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">string</span>
|
||||
<span class="gp">>>> </span><span class="n">Text</span><span class="p">(</span><span class="n">min_length</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="n">max_length</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="n">charset</span> <span class="o">=</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span><span class="p">)</span>
|
||||
<span class="go">Text(1, 10, characters=0123456789)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
@@ -855,11 +871,11 @@ If the charlist mask is all zero then an empty string is returned no matter the
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1030,7 +1046,7 @@ If the charlist mask is all zero then an empty string is returned no matter the
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Spaces - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -683,11 +695,11 @@ Therefore, Gymnasium provides a number of additional functions used when using a
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -857,7 +869,7 @@ Therefore, Gymnasium provides a number of additional functions used when using a
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Spaces Utils - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -461,9 +473,9 @@ errors or non-uniform sampling.</p>
|
||||
<dt>Example::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span>
|
||||
<span class="gp">>>> </span><span class="n">box</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">box</span>
|
||||
<span class="go">Box(3, 4, 5)</span>
|
||||
<span class="go">Box(0.0, 1.0, (3, 4, 5), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten_space</span><span class="p">(</span><span class="n">box</span><span class="p">)</span>
|
||||
<span class="go">Box(60,)</span>
|
||||
<span class="go">Box(0.0, 1.0, (60,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten</span><span class="p">(</span><span class="n">box</span><span class="p">,</span> <span class="n">box</span><span class="o">.</span><span class="n">sample</span><span class="p">())</span> <span class="ow">in</span> <span class="n">flatten_space</span><span class="p">(</span><span class="n">box</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
@@ -472,7 +484,7 @@ errors or non-uniform sampling.</p>
|
||||
<dt>Example that flattens a discrete space::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Discrete</span>
|
||||
<span class="gp">>>> </span><span class="n">discrete</span> <span class="o">=</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten_space</span><span class="p">(</span><span class="n">discrete</span><span class="p">)</span>
|
||||
<span class="go">Box(5,)</span>
|
||||
<span class="go">Box(0, 1, (5,), int64)</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten</span><span class="p">(</span><span class="n">box</span><span class="p">,</span> <span class="n">box</span><span class="o">.</span><span class="n">sample</span><span class="p">())</span> <span class="ow">in</span> <span class="n">flatten_space</span><span class="p">(</span><span class="n">box</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
@@ -481,7 +493,7 @@ errors or non-uniform sampling.</p>
|
||||
<dt>Example that recursively flattens a dict::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Discrete</span><span class="p">,</span> <span class="n">Box</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span><span class="s2">"position"</span><span class="p">:</span> <span class="n">Discrete</span><span class="p">(</span><span class="mi">2</span><span class="p">),</span> <span class="s2">"velocity"</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">))})</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten_space</span><span class="p">(</span><span class="n">space</span><span class="p">)</span>
|
||||
<span class="go">Box(6,)</span>
|
||||
<span class="go">Box(0.0, 1.0, (6,), float64)</span>
|
||||
<span class="gp">>>> </span><span class="n">flatten</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">space</span><span class="o">.</span><span class="n">sample</span><span class="p">())</span> <span class="ow">in</span> <span class="n">flatten_space</span><span class="p">(</span><span class="n">space</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
@@ -758,11 +770,11 @@ that the <code class="docutils literal notranslate"><span class="pre">space</spa
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -932,7 +944,7 @@ that the <code class="docutils literal notranslate"><span class="pre">space</spa
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Spaces Vector Utils - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -440,12 +452,13 @@
|
||||
<dd><p>Create a (batched) space, containing multiple copies of a single space.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span><span class="p">,</span> <span class="n">Dict</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span>
|
||||
<span class="gp">... </span> <span class="s1">'position'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span>
|
||||
<span class="gp">... </span> <span class="s1">'velocity'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="gp">... </span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">batch_space</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
|
||||
<span class="go">Dict(position:Box(5, 3), velocity:Box(5, 2))</span>
|
||||
<span class="go">Dict('position': Box(0.0, 1.0, (5, 3), float32), 'velocity': Box(0.0, 1.0, (5, 2), float32))</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
@@ -484,12 +497,13 @@
|
||||
<dd><p>Concatenate multiple samples from space into a single object.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">out</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">items</span> <span class="o">=</span> <span class="p">[</span><span class="n">space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">2</span><span class="p">)]</span>
|
||||
<span class="gp">>>> </span><span class="n">concatenate</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">items</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span>
|
||||
<span class="go">array([[0.6348213 , 0.28607962, 0.60760117],</span>
|
||||
<span class="go"> [0.87383074, 0.192658 , 0.2148103 ]], dtype=float32)</span>
|
||||
<span class="go">array([[0.77395606, 0.43887845, 0.85859793],</span>
|
||||
<span class="go"> [0.697368 , 0.09417735, 0.97562236]], dtype=float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
@@ -529,17 +543,16 @@
|
||||
<dd><p>Iterate over the elements of a (batched) space.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span><span class="p">,</span> <span class="n">Dict</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span>
|
||||
<span class="gp">... </span><span class="s1">'position'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span>
|
||||
<span class="gp">... </span><span class="s1">'velocity'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)})</span>
|
||||
<span class="gp">... </span><span class="s1">'position'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span>
|
||||
<span class="gp">... </span><span class="s1">'velocity'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">),</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)})</span>
|
||||
<span class="gp">>>> </span><span class="n">items</span> <span class="o">=</span> <span class="n">space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">it</span> <span class="o">=</span> <span class="n">iterate</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">items</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="nb">next</span><span class="p">(</span><span class="n">it</span><span class="p">)</span>
|
||||
<span class="go">{'position': array([-0.99644893, -0.08304597, -0.7238421 ], dtype=float32),</span>
|
||||
<span class="go">'velocity': array([0.35848552, 0.1533453 ], dtype=float32)}</span>
|
||||
<span class="go">OrderedDict([('position', array([0.77395606, 0.43887845, 0.85859793], dtype=float32)), ('velocity', array([0.77395606, 0.43887845], dtype=float32))])</span>
|
||||
<span class="gp">>>> </span><span class="nb">next</span><span class="p">(</span><span class="n">it</span><span class="p">)</span>
|
||||
<span class="go">{'position': array([-0.67958736, -0.49076623, 0.38661423], dtype=float32),</span>
|
||||
<span class="go">'velocity': array([0.7975036 , 0.93317133], dtype=float32)}</span>
|
||||
<span class="go">OrderedDict([('position', array([0.697368 , 0.09417735, 0.97562236], dtype=float32)), ('velocity', array([0.85859793, 0.697368 ], dtype=float32))])</span>
|
||||
<span class="gp">>>> </span><span class="nb">next</span><span class="p">(</span><span class="n">it</span><span class="p">)</span>
|
||||
<span class="go">StopIteration</span>
|
||||
</pre></div>
|
||||
@@ -564,7 +577,7 @@
|
||||
<h2>Shared Memory Utils<a class="headerlink" href="#shared-memory-utils" title="Permalink to this heading">#</a></h2>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="gymnasium.vector.utils.create_empty_array">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_empty_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">callable</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">np.zeros</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">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="w"> </span><span class="pre">dict</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></span><a class="headerlink" href="#gymnasium.vector.utils.create_empty_array" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_empty_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</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">np.zeros</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">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="w"> </span><span class="pre">dict</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></span><a class="headerlink" href="#gymnasium.vector.utils.create_empty_array" title="Permalink to this definition">#</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_empty_array</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.multi_binary.MultiBinary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fn=<built-in</span> <span class="pre">function</span> <span class="pre">zeros></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
@@ -582,13 +595,13 @@
|
||||
<dd><p>Create an empty (possibly nested) numpy array.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.spaces</span> <span class="kn">import</span> <span class="n">Box</span><span class="p">,</span> <span class="n">Dict</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
|
||||
<span class="gp">>>> </span><span class="n">space</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">({</span>
|
||||
<span class="gp">... </span><span class="s1">'position'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">3</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">),</span>
|
||||
<span class="gp">... </span><span class="s1">'velocity'</span><span class="p">:</span> <span class="n">Box</span><span class="p">(</span><span class="n">low</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="p">(</span><span class="mi">2</span><span class="p">,),</span> <span class="n">dtype</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">float32</span><span class="p">)})</span>
|
||||
<span class="gp">>>> </span><span class="n">create_empty_array</span><span class="p">(</span><span class="n">space</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">2</span><span class="p">,</span> <span class="n">fn</span><span class="o">=</span><span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">)</span>
|
||||
<span class="go">OrderedDict([('position', array([[0., 0., 0.],</span>
|
||||
<span class="go"> [0., 0., 0.]], dtype=float32)),</span>
|
||||
<span class="go"> ('velocity', array([[0., 0.],</span>
|
||||
<span class="go"> [0., 0., 0.]], dtype=float32)), ('velocity', array([[0., 0.],</span>
|
||||
<span class="go"> [0., 0.]], dtype=float32))])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -613,17 +626,17 @@
|
||||
<dt class="sig sig-object py" id="gymnasium.vector.utils.create_shared_memory">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="../#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">mp</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">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">tuple</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Array</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gymnasium.vector.utils.create_shared_memory" title="Permalink to this definition">#</a></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.multi_binary.MultiBinary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.multi_binary.MultiBinary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.multi_discrete.MultiDiscrete</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.multi_discrete.MultiDiscrete</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.discrete.Discrete</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.discrete.Discrete</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.box.Box</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.box.Box</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.tuple.Tuple</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.tuple.Tuple</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dt class="sig sig-object py">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.dict.Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.15/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.utils.</span></span><span class="sig-name descname"><span class="pre">create_shared_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">space:</span> <span class="pre">~gymnasium.spaces.dict.Dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ctx=<module</span> <span class="pre">'multiprocessing'</span> <span class="pre">from</span> <span class="pre">'/opt/hostedtoolcache/Python/3.9.16/x64/lib/python3.9/multiprocessing/__init__.py'></span></span></em><span class="sig-paren">)</span></dt>
|
||||
<dd><p>Create a shared memory object, to be shared across processes.</p>
|
||||
<p>This eventually contains the observations from the vectorized environment.</p>
|
||||
<dl class="field-list simple">
|
||||
@@ -804,11 +817,11 @@ This object is created with <cite>create_shared_memory</cite>.</p></li>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -978,7 +991,7 @@ This object is created with <cite>create_shared_memory</cite>.</p></li>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Utils - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -429,7 +441,7 @@
|
||||
<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="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-v2"</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>
|
||||
@@ -448,6 +460,7 @@ unplayable.</p>
|
||||
<code class="xref py py-class docutils literal notranslate"><span class="pre">gym.utils.play.PlayPlot</span></code>. Here’s a sample code for plotting the reward
|
||||
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="kn">from</span> <span class="nn">gymnasium.utils.play</span> <span class="kn">import</span> <span class="n">PlayPlot</span><span class="p">,</span> <span class="n">play</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>
|
||||
@@ -476,7 +489,7 @@ points of the keys, as a tuple of characters, or as a string where each characte
|
||||
one key.
|
||||
For example if pressing ‘w’ and space at the same time is supposed
|
||||
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>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">key_to_action</span> <span class="o">=</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>
|
||||
@@ -484,7 +497,7 @@ to trigger action number 2 then <code class="docutils literal notranslate"><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>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">key_to_action</span> <span class="o">=</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>
|
||||
@@ -492,7 +505,7 @@ to trigger action number 2 then <code class="docutils literal notranslate"><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>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">key_to_action</span> <span class="o">=</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>
|
||||
@@ -510,7 +523,7 @@ to trigger action number 2 then <code class="docutils literal notranslate"><span
|
||||
|
||||
<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>
|
||||
<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">
|
||||
@@ -632,7 +645,7 @@ You need to specify either fps or duration.</p></li>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.utils.save_video</span> <span class="kn">import</span> <span class="n">save_video</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">"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>
|
||||
<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">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="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>
|
||||
@@ -698,13 +711,16 @@ Terminated Truncated (new) step API refers to step() method returning (observati
|
||||
</dd>
|
||||
</dl>
|
||||
<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>
|
||||
<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>
|
||||
<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">"CartPole-v0"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">rewards</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="mi">0</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>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">rewards</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="mi">0</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>
|
||||
</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>
|
||||
<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>
|
||||
<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">"CartPole-v0"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">vec_env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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="mi">0</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> <span class="n">output_truncation_bool</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">rewards</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">vec_env</span><span class="o">.</span><span class="n">step</span><span class="p">([</span><span class="mi">0</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> <span class="n">output_truncation_bool</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
@@ -889,11 +905,11 @@ for more information about the API.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1064,7 +1080,7 @@ for more information about the API.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Vector - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -491,10 +503,10 @@ In other words, a vector of multiple different environments is not supported.</p
|
||||
<p>An example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
|
||||
<span class="gp">>>> </span><span class="n">envs</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"CartPole-v1"</span><span class="p">,</span> <span class="n">num_envs</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">envs</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">(array([[-0.02240574, -0.03439831, -0.03904812, 0.02810693],</span>
|
||||
<span class="go"> [ 0.01586068, 0.01929009, 0.02394426, 0.04016077],</span>
|
||||
<span class="go"> [-0.01314174, 0.03893502, -0.02400815, 0.0038326 ]],</span>
|
||||
<span class="gp">>>> </span><span class="n">envs</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([[ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 ],</span>
|
||||
<span class="go"> [ 0.01522993, -0.04562247, -0.04799704, 0.03392126],</span>
|
||||
<span class="go"> [-0.03774345, -0.02418869, -0.00942293, 0.0469184 ]],</span>
|
||||
<span class="go"> dtype=float32), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -520,14 +532,13 @@ info as <cite>“final_observation”</cite> and <cite>“final_info”</cite>.<
|
||||
</div>
|
||||
<p>An example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">envs</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"CartPole-v1"</span><span class="p">,</span> <span class="n">num_envs</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">envs</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">envs</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">actions</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">observations</span><span class="p">,</span> <span class="n">rewards</span><span class="p">,</span> <span class="n">termination</span><span class="p">,</span> <span class="n">truncation</span><span class="p">,</span> <span class="n">infos</span> <span class="o">=</span> <span class="n">envs</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">actions</span><span class="p">)</span>
|
||||
|
||||
<span class="gp">>>> </span><span class="n">observations</span>
|
||||
<span class="go">array([[ 0.00122802, 0.16228443, 0.02521779, -0.23700266],</span>
|
||||
<span class="go"> [ 0.00788269, -0.17490888, 0.03393489, 0.31735462],</span>
|
||||
<span class="go"> [ 0.04918966, 0.19421194, 0.02938497, -0.29495203]],</span>
|
||||
<span class="go">array([[ 0.02727336, 0.18847767, 0.03625453, -0.26141977],</span>
|
||||
<span class="go"> [ 0.01431748, -0.24002443, -0.04731862, 0.3110827 ],</span>
|
||||
<span class="go"> [-0.03822722, 0.1710671 , -0.00848456, -0.2487226 ]],</span>
|
||||
<span class="go"> dtype=float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">rewards</span>
|
||||
<span class="go">array([1., 1., 1.])</span>
|
||||
@@ -617,16 +628,16 @@ vectorized environments.</p>
|
||||
<h2>Making Vector Environments<a class="headerlink" href="#making-vector-environments" title="Permalink to this heading">#</a></h2>
|
||||
<dl class="py function">
|
||||
<dt class="sig sig-object py" id="gymnasium.vector.make">
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.</span></span><span class="sig-name descname"><span class="pre">make</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_envs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asynchronous</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wrappers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_env_checker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gymnasium.vector.VectorEnv" title="gymnasium.vector.vector_env.VectorEnv"><span class="pre">VectorEnv</span></a></span></span><a class="headerlink" href="#gymnasium.vector.make" title="Permalink to this definition">#</a></dt>
|
||||
<span class="sig-prename descclassname"><span class="pre">gymnasium.vector.</span></span><span class="sig-name descname"><span class="pre">make</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_envs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">asynchronous</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wrappers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.core.Env"><span class="pre">Env</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.core.Env"><span class="pre">Env</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.core.Env"><span class="pre">Env</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.core.Env"><span class="pre">Env</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_env_checker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gymnasium.vector.VectorEnv" title="gymnasium.vector.vector_env.VectorEnv"><span class="pre">VectorEnv</span></a></span></span><a class="headerlink" href="#gymnasium.vector.make" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Create a vectorized environment from multiple copies of an environment, from its id.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">'CartPole-v1'</span><span class="p">,</span> <span class="n">num_envs</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([[-0.04456399, 0.04653909, 0.01326909, -0.02099827],</span>
|
||||
<span class="go"> [ 0.03073904, 0.00145001, -0.03088818, -0.03131252],</span>
|
||||
<span class="go"> [ 0.03468829, 0.01500225, 0.01230312, 0.01825218]],</span>
|
||||
<span class="go"> dtype=float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([[ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 ],</span>
|
||||
<span class="go"> [ 0.01522993, -0.04562247, -0.04799704, 0.03392126],</span>
|
||||
<span class="go"> [-0.03774345, -0.02418869, -0.00942293, 0.0469184 ]],</span>
|
||||
<span class="go"> dtype=float32), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl class="field-list simple">
|
||||
@@ -652,18 +663,18 @@ vectorized environments.</p>
|
||||
<h2>Async Vector Env<a class="headerlink" href="#async-vector-env" title="Permalink to this heading">#</a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="gymnasium.vector.AsyncVectorEnv">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.vector.</span></span><span class="sig-name descname"><span class="pre">AsyncVectorEnv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_fns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">observation_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../spaces/#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../spaces/#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">daemon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.vector.AsyncVectorEnv" title="Permalink to this definition">#</a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.vector.</span></span><span class="sig-name descname"><span class="pre">AsyncVectorEnv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env_fns</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.core.Env"><span class="pre">Env</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">observation_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../spaces/#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../spaces/#gymnasium.spaces.Space" title="gymnasium.spaces.space.Space"><span class="pre">Space</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_memory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">daemon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">worker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.vector.AsyncVectorEnv" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Vectorized environment that runs multiple environments in parallel.</p>
|
||||
<p>It uses <code class="docutils literal notranslate"><span class="pre">multiprocessing</span></code> processes, and pipes for communication.</p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">AsyncVectorEnv</span><span class="p">([</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v0"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">9.81</span><span class="p">),</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v0"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">1.62</span><span class="p">)</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v1"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">9.81</span><span class="p">),</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v1"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">1.62</span><span class="p">)</span>
|
||||
<span class="gp">... </span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([[-0.8286432 , 0.5597771 , 0.90249056],</span>
|
||||
<span class="go"> [-0.85009176, 0.5266346 , 0.60007906]], dtype=float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([[-0.14995256, 0.9886932 , -0.12224312],</span>
|
||||
<span class="go"> [ 0.5760367 , 0.8174238 , -0.91244936]], dtype=float32), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Vectorized environment that runs multiple environments in parallel.</p>
|
||||
@@ -715,12 +726,12 @@ from the code for <code class="docutils literal notranslate"><span class="pre">_
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">gymnasium</span> <span class="k">as</span> <span class="nn">gym</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">SyncVectorEnv</span><span class="p">([</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v0"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">9.81</span><span class="p">),</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v0"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">1.62</span><span class="p">)</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v1"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">9.81</span><span class="p">),</span>
|
||||
<span class="gp">... </span> <span class="k">lambda</span><span class="p">:</span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s2">"Pendulum-v1"</span><span class="p">,</span> <span class="n">g</span><span class="o">=</span><span class="mf">1.62</span><span class="p">)</span>
|
||||
<span class="gp">... </span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([[-0.8286432 , 0.5597771 , 0.90249056],</span>
|
||||
<span class="go"> [-0.85009176, 0.5266346 , 0.60007906]], dtype=float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([[-0.14995256, 0.9886932 , -0.12224312],</span>
|
||||
<span class="go"> [ 0.5760367 , 0.8174238 , -0.91244936]], dtype=float32), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Vectorized environment that serially runs multiple environments.</p>
|
||||
@@ -850,11 +861,11 @@ then the action space of the first environment is taken.</p></li>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1024,7 +1035,7 @@ then the action space of the first environment is taken.</p></li>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Action Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -459,12 +471,14 @@ the <code class="xref py py-meth docutils literal notranslate"><span class="pre"
|
||||
<dd><p>Clip the continuous action within the valid <code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code> observation space bound.</p>
|
||||
<p class="rubric">Example</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="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="s1">'Bipedal-Walker-v3'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">ClipAction</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">"Hopper-v4"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">ClipAction</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box(-1.0, 1.0, (4,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</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="mf">5.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">10.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]))</span>
|
||||
<span class="go"># Executes the action np.array([1.0, 1.0, -1.0, 0]) in the base environment</span>
|
||||
<span class="go">Box(-1.0, 1.0, (3,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </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">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mf">5.0</span><span class="p">,</span> <span class="o">-</span><span class="mf">2.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">]))</span>
|
||||
<span class="gp">... </span><span class="c1"># Executes the action np.array([1.0, -1.0, 0]) in the base environment</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper for clipping continuous actions within the valid bound.</p>
|
||||
@@ -483,15 +497,17 @@ the <code class="xref py py-meth docutils literal notranslate"><span class="pre"
|
||||
or <code class="xref py py-attr docutils literal notranslate"><span class="pre">max_action</span></code> are numpy arrays, the shape must match the shape of the environment’s action space.</p>
|
||||
<p class="rubric">Example</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="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="s1">'BipedalWalker-v3'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box(-1.0, 1.0, (4,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">RescaleAction</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</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">"Hopper-v4"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</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">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">1</span><span class="p">,</span><span class="mi">1</span><span class="p">]))</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">min_action</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.5</span>
|
||||
<span class="gp">>>> </span><span class="n">max_action</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="mf">0.0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mf">0.75</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">RescaleAction</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">min_action</span><span class="o">=</span><span class="n">min_action</span><span class="p">,</span> <span class="n">max_action</span><span class="o">=</span><span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box(-0.5, [0. 0.5 1. 0.75], (4,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">RescaleAction</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">min_action</span><span class="p">,</span> <span class="n">max_action</span><span class="p">)</span><span class="o">.</span><span class="n">action_space</span> <span class="o">==</span> <span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Box</span><span class="p">(</span><span class="n">min_action</span><span class="p">,</span> <span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">max_action</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="mf">0.0</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.75</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span> <span class="o">=</span> <span class="n">RescaleAction</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">min_action</span><span class="o">=</span><span class="n">min_action</span><span class="p">,</span> <span class="n">max_action</span><span class="o">=</span><span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env_obs</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped_env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">max_action</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">alltrue</span><span class="p">(</span><span class="n">obs</span> <span class="o">==</span> <span class="n">wrapped_env_obs</span><span class="p">)</span>
|
||||
<span class="go">True</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -598,11 +614,11 @@ or <code class="xref py py-attr docutils literal notranslate"><span class="pre">
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -772,7 +788,7 @@ or <code class="xref py py-attr docutils literal notranslate"><span class="pre">
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -431,29 +443,29 @@ Most environments that are generated via <a class="reference internal" href="../
|
||||
with (possibly optional) parameters to the wrapper’s constructor.</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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">RescaleAction</span>
|
||||
<span class="gp">>>> </span><span class="n">base_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">"BipedalWalker-v3"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">base_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">"Hopper-v4"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">base_env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box([-1. -1. -1. -1.], [1. 1. 1. 1.], (4,), float32)</span>
|
||||
<span class="go">Box(-1.0, 1.0, (3,), float32)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span> <span class="o">=</span> <span class="n">RescaleAction</span><span class="p">(</span><span class="n">base_env</span><span class="p">,</span> <span class="n">min_action</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_action</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span><span class="o">.</span><span class="n">action_space</span>
|
||||
<span class="go">Box([0. 0. 0. 0.], [1. 1. 1. 1.], (4,), float32)</span>
|
||||
<span class="go">Box(-1.0, 1.0, (3,), float32)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can access the environment underneath the <strong>first</strong> wrapper by using the <a class="reference internal" href="#gymnasium.wrappers.gymnasium.Wrapper.env" title="gymnasium.wrappers.gymnasium.Wrapper.env"><code class="xref py py-attr docutils literal notranslate"><span class="pre">gymnasium.Wrapper.env</span></code></a> attribute.
|
||||
As the <a class="reference internal" href="#gymnasium.Wrapper" title="gymnasium.Wrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">gymnasium.Wrapper</span></code></a> class inherits from <a class="reference internal" href="../env/#gymnasium.Env" title="gymnasium.Env"><code class="xref py py-class docutils literal notranslate"><span class="pre">gymnasium.Env</span></code></a> then <a class="reference internal" href="#gymnasium.wrappers.gymnasium.Wrapper.env" title="gymnasium.wrappers.gymnasium.Wrapper.env"><code class="xref py py-attr docutils literal notranslate"><span class="pre">gymnasium.Wrapper.env</span></code></a> can be another wrapper.</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">wrapped_env</span>
|
||||
<span class="go"><RescaleAction<TimeLimit<OrderEnforcing<BipedalWalker<BipedalWalker-v3>>>>></span>
|
||||
<span class="go"><RescaleAction<TimeLimit<OrderEnforcing<PassiveEnvChecker<HopperEnv<Hopper-v4>>>>>></span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span><span class="o">.</span><span class="n">env</span>
|
||||
<span class="go"><TimeLimit<OrderEnforcing<BipedalWalker<BipedalWalker-v3>>>></span>
|
||||
<span class="go"><TimeLimit<OrderEnforcing<PassiveEnvChecker<HopperEnv<Hopper-v4>>>>></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you want to get to the environment underneath <strong>all</strong> of the layers of wrappers, you can use the
|
||||
<a class="reference internal" href="#gymnasium.Wrapper.unwrapped" title="gymnasium.Wrapper.unwrapped"><code class="xref py py-attr docutils literal notranslate"><span class="pre">gymnasium.Wrapper.unwrapped</span></code></a> attribute.
|
||||
If the environment is already a bare environment, the <a class="reference internal" href="#gymnasium.Wrapper.unwrapped" title="gymnasium.Wrapper.unwrapped"><code class="xref py py-attr docutils literal notranslate"><span class="pre">gymnasium.Wrapper.unwrapped</span></code></a> attribute will just return itself.</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">wrapped_env</span>
|
||||
<span class="go"><RescaleAction<TimeLimit<OrderEnforcing<BipedalWalker<BipedalWalker-v3>>>>></span>
|
||||
<span class="go"><RescaleAction<TimeLimit<OrderEnforcing<PassiveEnvChecker<HopperEnv<Hopper-v4>>>>>></span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped_env</span><span class="o">.</span><span class="n">unwrapped</span>
|
||||
<span class="go"><gymnasium.envs.box2d.bipedal_walker.BipedalWalker object at 0x7f87d70712d0></span>
|
||||
<span class="go"><gymnasium.envs.mujoco.hopper_v4.HopperEnv object at 0x7fbb5efd0490></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>There are three common things you might want a wrapper to do:</p>
|
||||
@@ -779,11 +791,11 @@ wrapper in the page on the wrapper type</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -953,7 +965,7 @@ wrapper in the page on the wrapper type</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Misc Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -538,12 +550,14 @@ New step API refers to step() method returning (observation, reward, terminated,
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">StepAPICompatibility</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="c1"># wrapper not applied by default, set to new API</span>
|
||||
<span class="go"><TimeLimit<OrderEnforcing<PassiveEnvChecker<CartPoleEnv<CartPole-v1>>>>></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">"CartPole-v1"</span><span class="p">,</span> <span class="n">apply_api_compatibility</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># set to old API</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">StepAPICompatibility</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="gp">>>> </span><span class="n">env</span>
|
||||
<span class="go"><StepAPICompatibility<TimeLimit<OrderEnforcing<PassiveEnvChecker<CartPoleEnv<CartPole-v1>>>>>></span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">StepAPICompatibility</span><span class="p">(</span><span class="n">CustomEnv</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> <span class="c1"># manually using wrapper on unregistered envs</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper which can transform an environment from new step API to old and vice-versa.</p>
|
||||
@@ -574,26 +588,28 @@ If you want to use this wrapper with your environments, remember to specify <cod
|
||||
in the metadata of your environment.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">render_mode</span></code> of the wrapped environment must be either <code class="docutils literal notranslate"><span class="pre">'rgb_array'</span></code> or <code class="docutils literal notranslate"><span class="pre">'rgb_array_list'</span></code>.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"LunarLander-v2"</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>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">HumanRendering</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">"LunarLander-v2"</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="gp">>>> </span><span class="n">wrapped</span> <span class="o">=</span> <span class="n">HumanRendering</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The wrapper can also be applied directly when the environment is instantiated, simply by passing
|
||||
<code class="docutils literal notranslate"><span class="pre">render_mode="human"</span></code> to <code class="docutils literal notranslate"><span class="pre">make</span></code>. The wrapper will only be applied if the environment does not
|
||||
implement human-rendering natively (i.e. <code class="docutils literal notranslate"><span class="pre">render_mode</span></code> does not contain <code class="docutils literal notranslate"><span class="pre">"human"</span></code>).</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"NoNativeRendering-v2"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span> <span class="c1"># NoNativeRendering-v0 doesn't implement human-rendering natively</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="c1"># This will start rendering to the screen</span>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"CartPoleJax-v1"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span> <span class="c1"># CartPoleJax-v1 doesn't implement human-rendering natively</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span> <span class="c1"># This will start rendering to the screen</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<dl>
|
||||
<dt>Warning: If the base environment uses <code class="docutils literal notranslate"><span class="pre">render_mode="rgb_array_list"</span></code>, its (i.e. the <em>base environment’s</em>) render method</dt><dd><p>will always return an empty list:</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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">"LunarLander-v2"</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>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</span> <span class="o">=</span> <span class="n">HumanRendering</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">wrapped</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">render</span><span class="p">()</span>
|
||||
<span class="go">[] # env.render() will always return an empty list!</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">wrapped</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">render</span><span class="p">()</span> <span class="c1"># env.render() will always return an empty list!</span>
|
||||
<span class="go">[]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
@@ -611,16 +627,17 @@ implement human-rendering natively (i.e. <code class="docutils literal notransla
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.wrappers.</span></span><span class="sig-name descname"><span class="pre">OrderEnforcing</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">disable_render_order_enforcing</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.wrappers.OrderEnforcing" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>A wrapper that will produce an error if <code class="xref py py-meth docutils literal notranslate"><span class="pre">step()</span></code> is called before an initial <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code>.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.envs.classic_control</span> <span class="kn">import</span> <span class="n">CartPoleEnv</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">CartPoleEnv</span><span class="p">()</span>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">OrderEnforcing</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">"CartPole-v1"</span><span class="p">,</span> <span class="n">render_mode</span><span class="o">=</span><span class="s2">"human"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">OrderEnforcing</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="go">ResetNeeded: Cannot call env.step() before calling env.reset()</span>
|
||||
<span class="go">gymnasium.error.ResetNeeded: Cannot call env.step() before calling env.reset()</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="go">ResetNeeded: Cannot call env.render() before calling env.reset()</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">gymnasium.error.ResetNeeded('Cannot call `env.render()` before calling `env.reset()`, if this is a intended action, set `disable_render_order_enforcing=True` on the OrderEnforcer wrapper.')</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="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="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="gp">>>> </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="mi">0</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper that will produce an error if <code class="xref py py-meth docutils literal notranslate"><span class="pre">step()</span></code> is called before an initial <code class="xref py py-meth docutils literal notranslate"><span class="pre">reset()</span></code>.</p>
|
||||
@@ -644,7 +661,6 @@ using the key <code class="docutils literal notranslate"><span class="pre">episo
|
||||
the episode statistics.</p>
|
||||
<p>After the completion of an episode, <code class="docutils literal notranslate"><span class="pre">info</span></code> will look like this:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="o">...</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<cumulative reward>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<episode length>"</span><span class="p">,</span>
|
||||
@@ -655,7 +671,10 @@ the episode statistics.</p>
|
||||
</div>
|
||||
<p>For a vectorized environments the output will be in the form of:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">infos</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="o">...</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_observation"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_observation"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_info"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_info"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<array of cumulative reward>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<array of episode length>"</span><span class="p">,</span>
|
||||
@@ -740,9 +759,9 @@ Otherwise, snippets of the specified length are captured</p></li>
|
||||
<p>If a truncation is not defined inside the environment itself, this is the only place that the truncation signal is issued.
|
||||
Critically, this is different from the <cite>terminated</cite> signal that originates from the underlying environment as part of the MDP.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.envs.classic_control</span> <span class="kn">import</span> <span class="n">CartPoleEnv</span>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TimeLimit</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">CartPoleEnv</span><span class="p">()</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TimeLimit</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">max_episode_steps</span><span class="o">=</span><span class="mi">1000</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -768,16 +787,33 @@ environments. If using other wrappers that perform
|
||||
operation on info like <cite>RecordEpisodeStatistics</cite> this
|
||||
need to be the outermost wrapper.</p>
|
||||
<p>i.e. <cite>VectorListInfo(RecordEpisodeStatistics(envs))</cite></p>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># actual</span>
|
||||
<span class="gp">>>> </span><span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"k"</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="mf">0.</span><span class="p">,</span> <span class="mf">0.</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">0.3</span><span class="p">],</span>
|
||||
<span class="gp">... </span> <span class="s2">"_k"</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="kc">False</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="kc">True</span><span class="p">]</span>
|
||||
<span class="gp">... </span> <span class="p">}</span>
|
||||
<span class="gp">>>> </span><span class="c1"># classic</span>
|
||||
<span class="gp">>>> </span><span class="p">[{},</span> <span class="p">{},</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">},</span> <span class="p">{</span><span class="n">k</span><span class="p">:</span> <span class="mf">0.3</span><span class="p">}]</span>
|
||||
<dl>
|
||||
<dt>Example::</dt><dd><div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1"># As dict:</span>
|
||||
<span class="gp">>>> </span><span class="n">infos</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_observation"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_observation"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_info"</span><span class="p">:</span> <span class="s2">"<array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"_final_info"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<array of cumulative reward>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<array of episode length>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"<array of elapsed time since beginning of episode>"</span>
|
||||
<span class="gp">... </span> <span class="p">},</span>
|
||||
<span class="gp">... </span> <span class="s2">"_episode"</span><span class="p">:</span> <span class="s2">"<boolean array of length num-envs>"</span>
|
||||
<span class="gp">... </span><span class="p">}</span>
|
||||
<span class="gp">>>> </span><span class="c1"># As list:</span>
|
||||
<span class="gp">>>> </span><span class="n">infos</span> <span class="o">=</span> <span class="p">[</span>
|
||||
<span class="gp">... </span> <span class="p">{</span>
|
||||
<span class="gp">... </span> <span class="s2">"episode"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"r"</span><span class="p">:</span> <span class="s2">"<cumulative reward>"</span><span class="p">,</span> <span class="s2">"l"</span><span class="p">:</span> <span class="s2">"<episode length>"</span><span class="p">,</span> <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"<elapsed time since beginning of episode>"</span><span class="p">},</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_observation"</span><span class="p">:</span> <span class="s2">"<observation>"</span><span class="p">,</span>
|
||||
<span class="gp">... </span> <span class="s2">"final_info"</span><span class="p">:</span> <span class="p">{},</span>
|
||||
<span class="gp">... </span> <span class="p">},</span>
|
||||
<span class="gp">... </span> <span class="o">...</span><span class="p">,</span>
|
||||
<span class="gp">... </span><span class="p">]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>This wrapper will convert the info into the list format.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
@@ -876,11 +912,11 @@ need to be the outermost wrapper.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1050,7 +1086,7 @@ need to be the outermost wrapper.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Observation Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -461,11 +473,13 @@ index of the timestep to the observation.</p>
|
||||
<p>If the transformation you wish to apply to observations returns values in a <em>different</em> space, you should subclass <code class="xref py py-class docutils literal notranslate"><span class="pre">ObservationWrapper</span></code>, implement the transformation, and set the new observation space accordingly. If you were to use this wrapper instead, the observation space would be set incorrectly.</p>
|
||||
<p class="rubric">Example</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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TransformObservation</span>
|
||||
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</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="s1">'CartPole-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TransformObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="n">obs</span> <span class="o">+</span> <span class="mf">0.1</span><span class="o">*</span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="o">*</span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([-0.08319338, 0.04635121, -0.07394746, 0.20877492])</span>
|
||||
<span class="gp">>>> </span><span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">(</span><span class="mi">0</span><span class="p">)</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TransformObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="n">obs</span> <span class="o">+</span> <span class="mf">0.1</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">randn</span><span class="p">(</span><span class="o">*</span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">(</span><span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([0.20380084, 0.03390356, 0.13373359, 0.24382612]), {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Initialize the <a class="reference internal" href="#gymnasium.wrappers.TransformObservation" title="gymnasium.wrappers.TransformObservation"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransformObservation</span></code></a> wrapper with an environment and a transform function <code class="xref py py-attr docutils literal notranslate"><span class="pre">f</span></code>.</p>
|
||||
@@ -485,17 +499,17 @@ index of the timestep to the observation.</p>
|
||||
<dd><p>Filter Dict observation space by the keys.</p>
|
||||
<p class="rubric">Example</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="n">env</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">wrappers</span><span class="o">.</span><span class="n">TransformObservation</span><span class="p">(</span>
|
||||
<span class="gp">... </span> <span class="n">gym</span><span class="o">.</span><span class="n">make</span><span class="p">(</span><span class="s1">'CartPole-v1'</span><span class="p">),</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="p">{</span><span class="s1">'obs'</span><span class="p">:</span> <span class="n">obs</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">:</span> <span class="mi">0</span><span class="p">}</span>
|
||||
<span class="gp">... </span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TransformObservation</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TransformObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">obs</span><span class="p">:</span> <span class="p">{</span><span class="s1">'obs'</span><span class="p">:</span> <span class="n">obs</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">:</span> <span class="mi">0</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span> <span class="o">=</span> <span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Dict</span><span class="p">(</span><span class="n">obs</span><span class="o">=</span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="p">,</span> <span class="n">time</span><span class="o">=</span><span class="n">gym</span><span class="o">.</span><span class="n">spaces</span><span class="o">.</span><span class="n">Discrete</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">{'obs': array([-0.00067088, -0.01860439, 0.04772898, -0.01911527], dtype=float32), 'time': 0}</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="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">({'obs': array([ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 ], dtype=float32), 'time': 0}, {})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FilterObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="n">filter_keys</span><span class="o">=</span><span class="p">[</span><span class="s1">'obs'</span><span class="p">])</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">{'obs': array([ 0.04560107, 0.04466959, -0.0328232 , -0.02367178], dtype=float32)}</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="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">({'obs': array([ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 ], dtype=float32)}, {})</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
|
||||
<span class="go">({'obs': array([ 0.04649447, -0.14996664, -0.03329664, 0.25847703], dtype=float32)}, 1.0, False, {})</span>
|
||||
<span class="go">({'obs': array([ 0.02727336, -0.20172954, 0.03625453, 0.32351476], dtype=float32)}, 1.0, False, False, {})</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A wrapper that filters dictionary observations by their keys.</p>
|
||||
@@ -521,13 +535,14 @@ index of the timestep to the observation.</p>
|
||||
<dd><p>Observation wrapper that flattens the observation.</p>
|
||||
<p class="rubric">Example</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="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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">FlattenObservation</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FlattenObservation</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(27648,)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(27648,)</span>
|
||||
</pre></div>
|
||||
@@ -560,11 +575,12 @@ I.e. the observation returned by <code class="xref py py-meth docutils literal n
|
||||
</div>
|
||||
<p class="rubric">Example</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="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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">FrameStack</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">FrameStack</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">4</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box(4, 96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">Box(0, 255, (4, 96, 96, 3), uint8)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(4, 96, 96, 3)</span>
|
||||
</pre></div>
|
||||
@@ -586,13 +602,15 @@ I.e. the observation returned by <code class="xref py py-meth docutils literal n
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.wrappers.</span></span><span class="sig-name descname"><span class="pre">GrayScaleObservation</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">keep_dim</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.wrappers.GrayScaleObservation" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Convert the image observation from RGB to gray scale.</p>
|
||||
<p class="rubric">Example</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<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="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">GrayScaleObservation</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box(0, 255, (96, 96, 3), uint8)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">GrayScaleObservation</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="s1">'CarRacing-v1'</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">GrayScaleObservation</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-v2"</span><span class="p">))</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box(0, 255, (96, 96), uint8)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">GrayScaleObservation</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="s1">'CarRacing-v1'</span><span class="p">),</span> <span class="n">keep_dim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">GrayScaleObservation</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-v2"</span><span class="p">),</span> <span class="n">keep_dim</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span>
|
||||
<span class="go">Box(0, 255, (96, 96, 1), uint8)</span>
|
||||
</pre></div>
|
||||
@@ -641,22 +659,23 @@ space is of type <code class="xref py py-class docutils literal notranslate"><sp
|
||||
space) will be added to the dictionary under the key “state”.</p>
|
||||
<p class="rubric">Example</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="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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="s1">'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="gp">>>> </span><span class="n">obs</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">PixelObservationWrapper</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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-v2"</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="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
<span class="go">odict_keys(['pixels'])</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">[</span><span class="s1">'pixels'</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(400, 600, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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="s1">'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">pixels_only</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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-v2"</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">pixels_only</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
<span class="go">odict_keys(['state', 'pixels'])</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">[</span><span class="s1">'state'</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">[</span><span class="s1">'pixels'</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(400, 600, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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="s1">'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">pixel_keys</span><span class="o">=</span><span class="p">(</span><span class="s1">'obs'</span><span class="p">,))</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">PixelObservationWrapper</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-v2"</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">pixel_keys</span><span class="o">=</span><span class="p">(</span><span class="s1">'obs'</span><span class="p">,))</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</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">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
|
||||
<span class="go">odict_keys(['obs'])</span>
|
||||
<span class="gp">>>> </span><span class="n">obs</span><span class="p">[</span><span class="s1">'obs'</span><span class="p">]</span><span class="o">.</span><span class="n">shape</span>
|
||||
@@ -696,14 +715,18 @@ Defaults to <cite>(pixels,)</cite>.</p></li>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="gymnasium.wrappers.ResizeObservation">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.wrappers.</span></span><span class="sig-name descname"><span class="pre">ResizeObservation</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">shape</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="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.wrappers.ResizeObservation" title="Permalink to this definition">#</a></dt>
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">gymnasium.wrappers.</span></span><span class="sig-name descname"><span class="pre">ResizeObservation</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"><span class="pre">gym.Env</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gymnasium.wrappers.ResizeObservation" title="Permalink to this definition">#</a></dt>
|
||||
<dd><p>Resize the image observation.</p>
|
||||
<p>This wrapper works on environments with image observations (or more generally observations of shape AxBxC) and resizes
|
||||
the observation to the shape given by the 2-tuple <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code>. The argument <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code> may also be an integer.
|
||||
In that case, the observation is scaled to a square of side-length <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code>.</p>
|
||||
<p>This wrapper works on environments with image observations. More generally,
|
||||
the input can either be two-dimensional (AxB, e.g. grayscale images) or
|
||||
three-dimensional (AxBxC, e.g. color images). This resizes the observation
|
||||
to the shape given by the 2-tuple <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code>.
|
||||
The argument <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code> may also be an integer, in which case, the
|
||||
observation is scaled to a square of side-length <code class="xref py py-attr docutils literal notranslate"><span class="pre">shape</span></code>.</p>
|
||||
<p class="rubric">Example</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="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="s1">'CarRacing-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">ResizeObservation</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">"CarRacing-v2"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">shape</span>
|
||||
<span class="go">(96, 96, 3)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">ResizeObservation</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="mi">64</span><span class="p">)</span>
|
||||
@@ -730,12 +753,14 @@ In that case, the observation is scaled to a square of side-length <code class="
|
||||
In particular, pixel observations are not supported. This wrapper will append the current timestep within the current episode to the observation.</p>
|
||||
<p class="rubric">Example</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="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="s1">'CartPole-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TimeAwareObservation</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TimeAwareObservation</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="go">array([ 0.03810719, 0.03522411, 0.02231044, -0.01088205, 0. ])</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="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="go">(array([ 0.0273956 , -0.00611216, 0.03585979, 0.0197368 , 0. ]), {})</span>
|
||||
<span class="gp">>>> </span><span class="n">_</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">seed</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</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><span class="mi">0</span><span class="p">]</span>
|
||||
<span class="go">array([ 0.03881167, -0.16021058, 0.0220928 , 0.28875574, 1. ])</span>
|
||||
<span class="go">array([ 0.02727336, -0.20172954, 0.03625453, 0.32351476, 1. ])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Initialize <a class="reference internal" href="#gymnasium.wrappers.TimeAwareObservation" title="gymnasium.wrappers.TimeAwareObservation"><code class="xref py py-class docutils literal notranslate"><span class="pre">TimeAwareObservation</span></code></a> that requires an environment with a flat <code class="xref py py-class docutils literal notranslate"><span class="pre">Box</span></code> observation space.</p>
|
||||
@@ -844,11 +869,11 @@ In particular, pixel observations are not supported. This wrapper will append th
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1018,7 +1043,7 @@ In particular, pixel observations are not supported. This wrapper will append th
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Reward Wrappers - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -461,9 +473,10 @@ you can simply define <code class="xref py py-attr docutils literal notranslate"
|
||||
</div>
|
||||
<p class="rubric">Example</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="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="s1">'CartPole-v1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">gymnasium.wrappers</span> <span class="kn">import</span> <span class="n">TransformReward</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">"CartPole-v1"</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span> <span class="o">=</span> <span class="n">TransformReward</span><span class="p">(</span><span class="n">env</span><span class="p">,</span> <span class="k">lambda</span> <span class="n">r</span><span class="p">:</span> <span class="mf">0.01</span><span class="o">*</span><span class="n">r</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">_</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">reset</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">observation</span><span class="p">,</span> <span class="n">reward</span><span class="p">,</span> <span class="n">terminated</span><span class="p">,</span> <span class="n">truncated</span><span class="p">,</span> <span class="n">info</span> <span class="o">=</span> <span class="n">env</span><span class="o">.</span><span class="n">step</span><span class="p">(</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>
|
||||
<span class="gp">>>> </span><span class="n">reward</span>
|
||||
<span class="go">0.01</span>
|
||||
@@ -593,11 +606,11 @@ instantiated or the policy was changed recently.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -768,7 +781,7 @@ instantiated or the policy was changed recently.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Basic Usage - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -513,8 +525,8 @@ Values can be shifted to {a, a+1, …, a+n-1} using an optional argument.</p></l
|
||||
<section id="more-information">
|
||||
<h2>More information<a class="headerlink" href="#more-information" title="Permalink to this heading">#</a></h2>
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="../../tutorials/environment_creation/"><span class="doc std std-doc">Making a Custom environment using the Gymnasium API</span></a></p></li>
|
||||
<li><p><a class="reference internal" href="../../tutorials/blackjack_tutorial/"><span class="doc std std-doc">Training an agent to play blackjack</span></a></p></li>
|
||||
<li><p><span class="xref myst">Making a Custom environment using the Gymnasium API</span></p></li>
|
||||
<li><p><span class="xref myst">Training an agent to play blackjack</span></p></li>
|
||||
<li><p><a class="reference internal" href="../gym_compatibility/"><span class="doc std std-doc">Compatibility with OpenAI Gym</span></a></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -594,11 +606,11 @@ Values can be shifted to {a, a+1, …, a+n-1} using an optional argument.</p></l
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -768,7 +780,7 @@ Values can be shifted to {a, a+1, …, a+n-1} using an optional argument.</p></l
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Compatibility with Gym - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -527,11 +539,11 @@ To allow backward compatibility, Gym and Gymnasium v0.26+ include an <code class
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -701,7 +713,7 @@ To allow backward compatibility, Gym and Gymnasium v0.26+ include an <code class
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>v21 to v26 Migration Guide - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -492,6 +504,11 @@ However, environments that have reasons for episode truncation rather than termi
|
||||
For users looping through an environment, they should modify <code class="docutils literal notranslate"><span class="pre">done</span> <span class="pre">=</span> <span class="pre">terminated</span> <span class="pre">or</span> <span class="pre">truncated</span></code> as is show in the example code.
|
||||
For training libraries, the primary difference is to change <code class="docutils literal notranslate"><span class="pre">done</span></code> to <code class="docutils literal notranslate"><span class="pre">terminated</span></code>, indicating whether bootstrapping should or shouldn’t happen.</p>
|
||||
</section>
|
||||
<section id="timelimit-wrapper">
|
||||
<h2>TimeLimit Wrapper<a class="headerlink" href="#timelimit-wrapper" title="Permalink to this heading">#</a></h2>
|
||||
<p>In v21, the <code class="xref py py-class docutils literal notranslate"><span class="pre">TimeLimit</span></code> wrapper added an extra key in the <code class="docutils literal notranslate"><span class="pre">info</span></code> dictionary <code class="docutils literal notranslate"><span class="pre">TimeLimit.truncated</span></code> whenever the agent reached the time limit without reaching a terminal state.</p>
|
||||
<p>In v26, this information is instead communicated through the <cite>truncated</cite> return value described in the previous section, which is <cite>True</cite> if the agent reaches the time limit, whether or not it reaches a terminal state. The old dictionary entry is equivalent to <code class="docutils literal notranslate"><span class="pre">truncated</span> <span class="pre">and</span> <span class="pre">not</span> <span class="pre">terminated</span></code></p>
|
||||
</section>
|
||||
<section id="environment-render">
|
||||
<h2>Environment Render<a class="headerlink" href="#environment-render" title="Permalink to this heading">#</a></h2>
|
||||
<p>In v26, a new render API was introduced such that the render mode is fixed at initialisation as some environments don’t allow on-the-fly render mode changes. Therefore, users should now specify the <a class="reference internal" href="../../api/env/#gymnasium.Env.render_mode" title="gymnasium.Env.render_mode"><code class="xref py py-attr docutils literal notranslate"><span class="pre">render_mode</span></code></a> within <code class="docutils literal notranslate"><span class="pre">gym.make</span></code> as shown in the v26 example code above.</p>
|
||||
@@ -572,6 +589,7 @@ For training libraries, the primary difference is to change <code class="docutil
|
||||
<li><a class="reference internal" href="#seed-and-random-number-generator">Seed and random number generator</a></li>
|
||||
<li><a class="reference internal" href="#environment-reset">Environment Reset</a></li>
|
||||
<li><a class="reference internal" href="#environment-step">Environment Step</a></li>
|
||||
<li><a class="reference internal" href="#timelimit-wrapper">TimeLimit Wrapper</a></li>
|
||||
<li><a class="reference internal" href="#environment-render">Environment Render</a></li>
|
||||
<li><a class="reference internal" href="#removed-code">Removed code</a></li>
|
||||
</ul>
|
||||
@@ -591,11 +609,11 @@ For training libraries, the primary difference is to change <code class="docutil
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -765,7 +783,7 @@ For training libraries, the primary difference is to change <code class="docutil
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Adventure - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -592,11 +604,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -766,7 +778,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Air Raid - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -632,11 +644,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -806,7 +818,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Alien - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -612,11 +624,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -786,7 +798,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Amidar - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -653,11 +665,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -827,7 +839,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Assault - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -633,11 +645,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -807,7 +819,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Asterix - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -650,11 +662,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -824,7 +836,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Asteroids - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -667,11 +679,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -841,7 +853,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Atlantis - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -638,11 +650,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -812,7 +824,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Bank Heist - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -614,11 +626,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -788,7 +800,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Battle Zone - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -611,11 +623,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -785,7 +797,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Beam Rider - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -650,11 +662,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -824,7 +836,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Berzerk - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -610,11 +622,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -784,7 +796,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Bowling - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -644,11 +656,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -818,7 +830,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Boxing - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -610,11 +622,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -784,7 +796,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Breakout - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -636,11 +648,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -810,7 +822,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Carnival - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -643,11 +655,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -817,7 +829,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Centipede - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -613,11 +625,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -787,7 +799,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Chopper Command - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -611,11 +623,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -785,7 +797,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Complete List - Atari - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -1211,11 +1223,11 @@
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1385,7 +1397,7 @@
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Crazy Climber - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -652,11 +664,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -826,7 +838,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Defender - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -612,11 +624,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -786,7 +798,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Demon Attack - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -654,11 +666,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -828,7 +840,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Double Dunk - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -652,11 +664,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -826,7 +838,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Elevator Action - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -655,11 +667,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -829,7 +841,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Enduro - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -650,11 +662,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -824,7 +836,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>FishingDerby - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -703,11 +715,11 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -877,7 +889,7 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Freeway - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -703,11 +715,11 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -877,7 +889,7 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Frostbite - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -703,11 +715,11 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -877,7 +889,7 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Gopher - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -703,11 +715,11 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -877,7 +889,7 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Gravitar - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -703,11 +715,11 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -877,7 +889,7 @@ customize the environment using the arguments above, if necessary.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Hero - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -613,11 +625,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -787,7 +799,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>IceHockey - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -612,11 +624,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -786,7 +798,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Atari - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -1140,11 +1152,11 @@ URL: https://jair.org/index.php/jair/article/view/11182</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -1314,7 +1326,7 @@ URL: https://jair.org/index.php/jair/article/view/11182</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>Jamesbond - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -613,11 +625,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -787,7 +799,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
@@ -15,7 +15,11 @@
|
||||
<title>JourneyEscape - Gymnasium Documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?digest=3cf7b839e8c50b5f3a39bb99d90baa7b845de926" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=91b9f2a71a58ed2481980f1e5725e16457fde93d" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-binder.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-dataframe.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/sg_gallery-rendered-html.css" />
|
||||
<link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?digest=b332e145f118bbc5b181998bee244c1e810e1f8b" />
|
||||
|
||||
|
||||
|
||||
@@ -363,15 +367,23 @@
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../tutorials/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/gymnasium_basics/">Gymnasium Basics</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle 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="../../../tutorials/gymnasium_basics/handling_time_limits/">Handling Time Limits</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/implementing_custom_wrappers/">Implementing Custom Wrappers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../tutorials/training_agents/">Training Agents</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><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="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium">Github</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../release_notes/">Release Notes</a></li>
|
||||
<li class="toctree-l1"><a class="reference external" href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
|
||||
</ul>
|
||||
|
||||
@@ -672,11 +684,11 @@ general article on Atari environments.</p>
|
||||
const menuBtn = document.querySelector(".farama-header-menu__btn");
|
||||
const menuContainer = document.querySelector(".farama-header-menu-container");
|
||||
if (document.querySelector(".farama-header-menu").classList.contains("active")) {
|
||||
menuBtn.ariaExpanded = "false";
|
||||
menuContainer.ariaHidden = "true";
|
||||
menuBtn.setAttribute("aria-expanded", "false");
|
||||
menuContainer.setAttribute("aria-hidden", "true");
|
||||
} else {
|
||||
menuBtn.ariaExpanded = "true";
|
||||
menuContainer.ariaHidden = "false";
|
||||
menuBtn.setAttribute("aria-expanded", "true");
|
||||
menuContainer.setAttribute("aria-hidden", "false");
|
||||
}
|
||||
document.querySelector(".farama-header-menu").classList.toggle("active");
|
||||
}
|
||||
@@ -846,7 +858,7 @@ general article on Atari environments.</p>
|
||||
githubUser: 'Farama-Foundation',
|
||||
githubRepo: 'Gymnasium',
|
||||
};
|
||||
fetch('/_static/versioning/versioning_menu.html').then(response => {
|
||||
fetch('/main/_static/versioning/versioning_menu.html').then(response => {
|
||||
if (response.status === 200) {
|
||||
response.text().then(text => {
|
||||
const container = document.createElement("div");
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user