Deploying to gh-pages from @ 52b6878 🚀

main/.buildinfo

@@ -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: 79c07efea7393e3ce97d12fc03b9fa79
+config: 864b7cce83fdb3ab7e31738d032452a4
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620

main/_downloads/7720e20eb2c7f37162a67699a7b0ba23/FrozenLake_tuto.py

@@ -4,7 +4,6 @@
 
 """
 
-
 # %%
 # In this post we'll compare a bunch of different map sizes on the
 # `FrozenLake <https://gymnasium.farama.org/environments/toy_text/frozen_lake/>`__

main/_downloads/e688a889564af5a98daa8accfbca806e/vector_envs_tutorial.py

@@ -3,6 +3,7 @@
 ======================================================
 
 """
+
 # %%
 # Notice
 # ------

main/_modules/gymnasium/core/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.core</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Core API for Environment, Wrapper, ActionWrapper, RewardWrapper and ObservationWrapper.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>

main/_modules/gymnasium/envs/functional_jax_env/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.envs.functional_jax_env</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Functional to Environment compatibility.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>

main/_modules/gymnasium/envs/registration/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.envs.registration</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Functions for registering environments within gymnasium using public functions ``make``, ``register`` and ``spec``.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">contextlib</span>
@@ -524,15 +525,13 @@ <h1>Source code for gymnasium.envs.registration</h1><div class="highlight"><pre>
 <span class="k">class</span> <span class="nc">EnvCreator</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function type expected for an environment.&quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Env</span><span class="p">:</span>
-        <span class="o">...</span>
+    <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Env</span><span class="p">:</span> <span class="o">...</span>
 
 
 <span class="k">class</span> <span class="nc">VectorEnvCreator</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Function type expected for an environment.&quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">VectorEnv</span><span class="p">:</span>
-        <span class="o">...</span>
+    <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">gym</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">VectorEnv</span><span class="p">:</span> <span class="o">...</span>
 
 
 <div class="viewcode-block" id="WrapperSpec">

main/_modules/gymnasium/functional/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.functional</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Base class and definitions for an alternative, functional backend for gym envs, particularly suitable for hardware accelerated and otherwise transformed environments.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Generic</span><span class="p">,</span> <span class="n">TypeVar</span>

main/_modules/gymnasium/spaces/box/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.box</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents closed boxes in euclidean space.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">SupportsFloat</span>

main/_modules/gymnasium/spaces/dict/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.dict</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents the cartesian product of other spaces as a dictionary.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">collections.abc</span>

main/_modules/gymnasium/spaces/discrete/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.discrete</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space consisting of finitely many elements.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span>

main/_modules/gymnasium/spaces/graph/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.graph</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents graph information where nodes and edges can be represented with euclidean space.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">NamedTuple</span><span class="p">,</span> <span class="n">Sequence</span>
@@ -655,8 +656,7 @@ <h1>Source code for gymnasium.spaces.graph</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../../../api/spaces/composite/#gymnasium.spaces.Graph.sample">[docs]</a>
     <span class="k">def</span> <span class="nf">sample</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
-        <span class="n">mask</span><span class="p">:</span> <span class="kc">None</span>
-        <span class="o">|</span> <span class="p">(</span>
+        <span class="n">mask</span><span class="p">:</span> <span class="kc">None</span> <span class="o">|</span> <span class="p">(</span>
             <span class="nb">tuple</span><span class="p">[</span>
                 <span class="n">NDArray</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>
                 <span class="n">NDArray</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span> <span class="o">|</span> <span class="nb">tuple</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span>

main/_modules/gymnasium/spaces/multi_binary/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.multi_binary</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that consists of binary np.ndarrays of a fixed shape.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Sequence</span>

main/_modules/gymnasium/spaces/multi_discrete/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.multi_discrete</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents the cartesian product of `Discrete` spaces.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span>

main/_modules/gymnasium/spaces/oneof/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.oneof</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents the cartesian product of other spaces.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">typing</span>

main/_modules/gymnasium/spaces/sequence/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.sequence</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents finite-length sequences.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">typing</span>
@@ -579,8 +580,7 @@ <h1>Source code for gymnasium.spaces.sequence</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../../../api/spaces/composite/#gymnasium.spaces.Sequence.sample">[docs]</a>
     <span class="k">def</span> <span class="nf">sample</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
-        <span class="n">mask</span><span class="p">:</span> <span class="kc">None</span>
-        <span class="o">|</span> <span class="p">(</span>
+        <span class="n">mask</span><span class="p">:</span> <span class="kc">None</span> <span class="o">|</span> <span class="p">(</span>
             <span class="nb">tuple</span><span class="p">[</span>
                 <span class="kc">None</span> <span class="o">|</span> <span class="n">np</span><span class="o">.</span><span class="n">integer</span> <span class="o">|</span> <span class="n">NDArray</span><span class="p">[</span><span class="n">np</span><span class="o">.</span><span class="n">integer</span><span class="p">],</span>
                 <span class="n">Any</span><span class="p">,</span>

main/_modules/gymnasium/spaces/space/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.space</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of the `Space` metaclass.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Generic</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Sequence</span><span class="p">,</span> <span class="n">TypeVar</span>

main/_modules/gymnasium/spaces/text/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.text</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents textual strings.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>

main/_modules/gymnasium/spaces/tuple/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.spaces.tuple</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Implementation of a space that represents the cartesian product of other spaces.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">typing</span>

main/_modules/gymnasium/spaces/utils/index.html

@@ -475,6 +475,7 @@ <h1>Source code for gymnasium.spaces.utils</h1><div class="highlight"><pre>
 <span class="sd">These functions mostly take care of flattening and unflattening elements of spaces</span>
 <span class="sd"> to facilitate their usage in learning code.</span>
 <span class="sd">&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">operator</span> <span class="k">as</span> <span class="nn">op</span>
@@ -1022,9 +1023,9 @@ <h1>Source code for gymnasium.spaces.utils</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">_flatten_space_graph</span><span class="p">(</span><span class="n">space</span><span class="p">:</span> <span class="n">Graph</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Graph</span><span class="p">:</span>
     <span class="k">return</span> <span class="n">Graph</span><span class="p">(</span>
         <span class="n">node_space</span><span class="o">=</span><span class="n">flatten_space</span><span class="p">(</span><span class="n">space</span><span class="o">.</span><span class="n">node_space</span><span class="p">),</span>
-        <span class="n">edge_space</span><span class="o">=</span><span class="n">flatten_space</span><span class="p">(</span><span class="n">space</span><span class="o">.</span><span class="n">edge_space</span><span class="p">)</span>
-        <span class="k">if</span> <span class="n">space</span><span class="o">.</span><span class="n">edge_space</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
-        <span class="k">else</span> <span class="kc">None</span><span class="p">,</span>
+        <span class="n">edge_space</span><span class="o">=</span><span class="p">(</span>
+            <span class="n">flatten_space</span><span class="p">(</span><span class="n">space</span><span class="o">.</span><span class="n">edge_space</span><span class="p">)</span> <span class="k">if</span> <span class="n">space</span><span class="o">.</span><span class="n">edge_space</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
+        <span class="p">),</span>
     <span class="p">)</span>
 
 

main/_modules/gymnasium/utils/ezpickle/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.utils.ezpickle</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Class for pickling and unpickling objects via their constructor arguments.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
 
 

main/_modules/gymnasium/utils/play/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.utils.play</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Utilities of visualising an environment.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">deque</span>

main/_modules/gymnasium/utils/save_video/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.utils.save_video</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Utility functions to save rendering videos.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">os</span>

main/_modules/gymnasium/utils/seeding/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.utils.seeding</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Set of random number generator functions: seeding, generator, hashing seeds.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

main/_modules/gymnasium/utils/step_api_compatibility/index.html

@@ -471,6 +471,7 @@
 
             <h1>Source code for gymnasium.utils.step_api_compatibility</h1><div class="highlight"><pre>
 <span></span><span class="sd">&quot;&quot;&quot;Contains methods for step compatibility, from old-to-new and new-to-old API.&quot;&quot;&quot;</span>
+
 <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
 
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">SupportsFloat</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Union</span>