<liclass="toctree-l1 current has-children"><aclass="reference internal"href="../">Spaces</a><inputchecked=""class="toctree-checkbox"id="toctree-checkbox-1"name="toctree-checkbox-1"role="switch"type="checkbox"/><labelfor="toctree-checkbox-1"><divclass="visually-hidden">Toggle navigation of Spaces</div><iclass="icon"><svg><usehref="#svg-arrow-right"></use></svg></i></label><ulclass="current">
<liclass="toctree-l2"><aclass="reference internal"href="../../../environments/classic_control/mountain_car_continuous/">Mountain Car Continuous</a></li>
<liclass="toctree-l1 has-children"><aclass="reference internal"href="../../../environments/toy_text/">Toy Text</a><inputclass="toctree-checkbox"id="toctree-checkbox-6"name="toctree-checkbox-6"role="switch"type="checkbox"/><labelfor="toctree-checkbox-6"><divclass="visually-hidden">Toggle navigation of Toy Text</div><iclass="icon"><svg><usehref="#svg-arrow-right"></use></svg></i></label><ul>
<liclass="toctree-l2"><aclass="reference internal"href="../../../tutorials/gymnasium_basics/environment_creation/">Make your own custom environment</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../../../tutorials/gymnasium_basics/vector_envs_tutorial/">Training A2C with Vector Envs and Domain Randomization</a></li>
<liclass="toctree-l1 has-children"><aclass="reference internal"href="../../../tutorials/training_agents/">Training Agents links in the Gymnasium Documentation</a><inputclass="toctree-checkbox"id="toctree-checkbox-9"name="toctree-checkbox-9"role="switch"type="checkbox"/><labelfor="toctree-checkbox-9"><divclass="visually-hidden">Toggle navigation of Training Agents links in the Gymnasium Documentation</div><iclass="icon"><svg><usehref="#svg-arrow-right"></use></svg></i></label><ul>
<liclass="toctree-l2"><aclass="reference internal"href="../../../tutorials/training_agents/reinforce_invpend_gym_v26/">Training using REINFORCE for Mujoco</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="../../../tutorials/training_agents/blackjack_tutorial/">Solving Blackjack with Q-Learning</a></li>
<liclass="toctree-l1"><aclass="reference external"href="https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md">Contribute to the Docs</a></li>
<dd><p>A (possibly unbounded) box in <spanclass="math notranslate nohighlight">\(\mathbb{R}^n\)</span>.</p>
<p>Specifically, a Box represents the Cartesian product of n closed intervals.
Each interval has the form of one of <spanclass="math notranslate nohighlight">\([a, b]\)</span>, <spanclass="math notranslate nohighlight">\((-\infty, b]\)</span>,
<spanclass="math notranslate nohighlight">\([a, \infty)\)</span>, or <spanclass="math notranslate nohighlight">\((-\infty, \infty)\)</span>.</p>
<li><p><strong>low</strong> (<em>SupportsFloat</em><em> | </em><em>np.ndarray</em>) – Lower bounds of the intervals. If integer, must be at least <codeclass="docutils literal notranslate"><spanclass="pre">-2**63</span></code>.</p></li>
<li><p><strong>high</strong> (<em>SupportsFloat</em><em> | </em><em>np.ndarray</em><em>]</em>) – Upper bounds of the intervals. If integer, must be at most <codeclass="docutils literal notranslate"><spanclass="pre">2**63</span><spanclass="pre">-</span><spanclass="pre">2</span></code>.</p></li>
<li><p><strong>shape</strong> (<em>Optional</em><em>[</em><aclass="reference internal"href="../composite/#gymnasium.spaces.Sequence"title="gymnasium.spaces.Sequence"><em>Sequence</em></a><em>[</em><em>int</em><em>]</em><em>]</em>) – The shape is inferred from the shape of <cite>low</cite> or <cite>high</cite><cite>np.ndarray`s with
`low</cite> and <cite>high</cite> scalars defaulting to a shape of (1,)</p></li>
<li><p><strong>dtype</strong>– The dtype of the elements of the space. If this is an integer type, the <aclass="reference internal"href="#gymnasium.spaces.Box"title="gymnasium.spaces.Box"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Box</span></code></a> is essentially a discrete space.</p></li>
<li><p><strong>seed</strong>– Optionally, you can use this argument to seed the RNG that is used to sample from the space.</p></li>
<spanclass="sig-name descname"><spanclass="pre">sample</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mask</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">probability</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">ndarray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">dtype</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/box/#Box.sample"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.Box.sample"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">seed</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="headerlink"href="#gymnasium.spaces.Box.seed"title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<ddclass="field-odd"><p><strong>seed</strong>– The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
<ddclass="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
<spanclass="sig-name descname"><spanclass="pre">is_bounded</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">manner</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">'both'</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/box/#Box.is_bounded"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.Box.is_bounded"title="Link to this definition">¶</a></dt>
<ddclass="field-odd"><p><strong>ValueError</strong>– If <cite>manner</cite> is neither <codeclass="docutils literal notranslate"><spanclass="pre">"both"</span></code> nor <codeclass="docutils literal notranslate"><spanclass="pre">"below"</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">"above"</span></code></p>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">gymnasium.spaces.</span></span><spanclass="sig-name descname"><spanclass="pre">Discrete</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">np.random.Generator</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">0</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/discrete/#Discrete"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.Discrete"title="Link to this definition">¶</a></dt>
<dd><p>A space consisting of finitely many elements.</p>
<p>This class represents a finite subset of integers, more specifically a set of the form <spanclass="math notranslate nohighlight">\(\{ a, a+1, \dots, a+n-1 \}\)</span>.</p>
<li><p><strong>n</strong> (<em>int</em>) – The number of elements of this space.</p></li>
<li><p><strong>seed</strong>– Optionally, you can use this argument to seed the RNG that is used to sample from the <codeclass="docutils literal notranslate"><spanclass="pre">Dict</span></code> space.</p></li>
<li><p><strong>start</strong> (<em>int</em>) – The smallest element of this space.</p></li>
<spanclass="sig-name descname"><spanclass="pre">sample</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mask</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">MaskNDArray</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">probability</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">MaskNDArray</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">np.int64</span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/discrete/#Discrete.sample"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.Discrete.sample"title="Link to this definition">¶</a></dt>
<p>A sample will be chosen uniformly at random with the mask if provided, or it will be chosen according to a specified probability distribution if the probability mask is provided.</p>
If there are no possible actions (i.e. <codeclass="docutils literal notranslate"><spanclass="pre">np.all(mask</span><spanclass="pre">==</span><spanclass="pre">0)</span></code>) then <codeclass="docutils literal notranslate"><spanclass="pre">space.start</span></code> will be returned.</p></li>
<li><p><strong>probability</strong>– An optional probability mask describing the probability of each action being selected.
Expected <cite>np.ndarray</cite> of shape <codeclass="docutils literal notranslate"><spanclass="pre">(n,)</span></code> and dtype <codeclass="docutils literal notranslate"><spanclass="pre">np.float64</span></code> where each value is in the range <codeclass="docutils literal notranslate"><spanclass="pre">[0,</span><spanclass="pre">1]</span></code> and the sum of all values is 1.
If the values do not sum to 1, an exception will be thrown.</p></li>
<spanclass="sig-name descname"><spanclass="pre">seed</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="headerlink"href="#gymnasium.spaces.Discrete.seed"title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<ddclass="field-odd"><p><strong>seed</strong>– The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
<ddclass="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">gymnasium.spaces.</span></span><spanclass="sig-name descname"><spanclass="pre">MultiBinary</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">n</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><aclass="reference internal"href="../composite/#gymnasium.spaces.Sequence"title="gymnasium.spaces.Sequence"><spanclass="pre">Sequence</span></a><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">int</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">np.random.Generator</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/multi_binary/#MultiBinary"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.MultiBinary"title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">sample</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mask</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">MaskNDArray</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">probability</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">MaskNDArray</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.int8</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/multi_binary/#MultiBinary.sample"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.MultiBinary.sample"title="Link to this definition">¶</a></dt>
<li><p><strong>mask</strong>– An optional <codeclass="docutils literal notranslate"><spanclass="pre">np.ndarray</span></code> to mask samples with expected shape of <codeclass="docutils literal notranslate"><spanclass="pre">space.shape</span></code>.
For <codeclass="docutils literal notranslate"><spanclass="pre">mask</span><spanclass="pre">==</span><spanclass="pre">0</span></code> then the samples will be <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code>, for a <codeclass="docutils literal notranslate"><spanclass="pre">mask</span><spanclass="pre">==</span><spanclass="pre">1</span></code> then the samples will be <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>.
For random samples, using a mask value of <codeclass="docutils literal notranslate"><spanclass="pre">2</span></code>.
The expected mask shape is the space shape and mask dtype is <codeclass="docutils literal notranslate"><spanclass="pre">np.int8</span></code>.</p></li>
<li><p><strong>probability</strong>– An optional <codeclass="docutils literal notranslate"><spanclass="pre">np.ndarray</span></code> to mask samples with expected shape of space.shape where each element
represents the probability of the corresponding sample element being a 1.
The expected mask shape is the space shape and mask dtype is <codeclass="docutils literal notranslate"><spanclass="pre">np.float64</span></code>.</p></li>
<spanclass="sig-name descname"><spanclass="pre">seed</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="headerlink"href="#gymnasium.spaces.MultiBinary.seed"title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<ddclass="field-odd"><p><strong>seed</strong>– The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
<ddclass="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">gymnasium.spaces.</span></span><spanclass="sig-name descname"><spanclass="pre">MultiDiscrete</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">nvec</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">dtype</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">type</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">np.int64</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">np.random.Generator</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">start</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/multi_discrete/#MultiDiscrete"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.MultiDiscrete"title="Link to this definition">¶</a></dt>
<p>It can be initialized as <codeclass="docutils literal notranslate"><spanclass="pre">MultiDiscrete([</span><spanclass="pre">5,</span><spanclass="pre">2,</span><spanclass="pre">2</span><spanclass="pre">])</span></code> such that a sample might be <codeclass="docutils literal notranslate"><spanclass="pre">array([3,</span><spanclass="pre">1,</span><spanclass="pre">0])</span></code>.</p>
<p>Although this feature is rarely used, <aclass="reference internal"href="#gymnasium.spaces.MultiDiscrete"title="gymnasium.spaces.MultiDiscrete"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MultiDiscrete</span></code></a> spaces may also have several axes
if <codeclass="docutils literal notranslate"><spanclass="pre">nvec</span></code> has several axes:</p>
<spanclass="sig-name descname"><spanclass="pre">sample</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mask</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">MaskNDArray</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">...</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">probability</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">MaskNDArray</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">...</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.integer</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Any</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/multi_discrete/#MultiDiscrete.sample"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.MultiDiscrete.sample"title="Link to this definition">¶</a></dt>
<dd><p>Generates a single random sample from this space.</p>
<li><p><strong>mask</strong>– An optional mask for multi-discrete, expects tuples with a <codeclass="docutils literal notranslate"><spanclass="pre">np.ndarray</span></code> mask in the position of each
action with shape <codeclass="docutils literal notranslate"><spanclass="pre">(n,)</span></code> where <codeclass="docutils literal notranslate"><spanclass="pre">n</span></code> is the number of actions and <codeclass="docutils literal notranslate"><spanclass="pre">dtype=np.int8</span></code>.
Only <codeclass="docutils literal notranslate"><spanclass="pre">mask</span><spanclass="pre">values</span><spanclass="pre">==</span><spanclass="pre">1</span></code> are possible to sample unless all mask values for an action are <codeclass="docutils literal notranslate"><spanclass="pre">0</span></code> then the default action <codeclass="docutils literal notranslate"><spanclass="pre">self.start</span></code> (the smallest element) is sampled.</p></li>
<li><p><strong>probability</strong>– An optional probability mask for multi-discrete, expects tuples with a <codeclass="docutils literal notranslate"><spanclass="pre">np.ndarray</span></code> probability mask in the position of each
action with shape <codeclass="docutils literal notranslate"><spanclass="pre">(n,)</span></code> where <codeclass="docutils literal notranslate"><spanclass="pre">n</span></code> is the number of actions and <codeclass="docutils literal notranslate"><spanclass="pre">dtype=np.float64</span></code>.
Only probability mask values within <codeclass="docutils literal notranslate"><spanclass="pre">[0,1]</span></code> are possible to sample as long as the sum of all values is <codeclass="docutils literal notranslate"><spanclass="pre">1</span></code>.</p></li>
<spanclass="sig-name descname"><spanclass="pre">seed</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="headerlink"href="#gymnasium.spaces.MultiDiscrete.seed"title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<ddclass="field-odd"><p><strong>seed</strong>– The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
<ddclass="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
<li><p><strong>min_length</strong> (<em>int</em>) – Minimum text length (in characters). Defaults to 1 to prevent empty strings.</p></li>
<li><p><strong>max_length</strong> (<em>int</em>) – Maximum text length (in characters).</p></li>
<li><p><strong>charset</strong> (<em>Union</em><em>[</em><em>set</em><em>]</em><em>, </em><em>str</em>) – Character set, defaults to the lower and upper english alphabet plus latin digits.</p></li>
<li><p><strong>seed</strong>– The seed for sampling from the space.</p></li>
<spanclass="sig-name descname"><spanclass="pre">sample</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">mask</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">None</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.int8</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">probability</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">None</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">tuple</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">NDArray</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">np.float64</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">str</span></span></span><aclass="reference internal"href="../../../_modules/gymnasium/spaces/text/#Text.sample"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink"href="#gymnasium.spaces.Text.sample"title="Link to this definition">¶</a></dt>
<dd><p>Generates a single random sample from this space with by default a random length between <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">max_length</span></code> and sampled from the <codeclass="docutils literal notranslate"><spanclass="pre">charset</span></code>.</p>
<li><p><strong>mask</strong>– An optional tuples of length and mask for the text.
The length is expected to be between the <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">max_length</span></code>.
Otherwise, a random integer between <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">max_length</span></code> is selected.
For the mask, we expect a numpy array of length of the charset passed with <codeclass="docutils literal notranslate"><spanclass="pre">dtype</span><spanclass="pre">==</span><spanclass="pre">np.int8</span></code>.
If the charlist mask is all zero then an empty string is returned no matter the <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code></p></li>
<li><p><strong>probability</strong>– An optional tuples of length and probability mask for the text.
The length is expected to be between the <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">max_length</span></code>.
Otherwise, a random integer between <codeclass="docutils literal notranslate"><spanclass="pre">min_length</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">max_length</span></code> is selected.
For the probability mask, we expect a numpy array of length of the charset passed with <codeclass="docutils literal notranslate"><spanclass="pre">dtype</span><spanclass="pre">==</span><spanclass="pre">np.float64</span></code>.
The sum of the probability mask should be 1, otherwise an exception is raised.</p></li>
<spanclass="sig-name descname"><spanclass="pre">seed</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">seed</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">int</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">dict</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="w"></span><spanclass="pre">int</span><spanclass="p"><spanclass="pre">]</span></span></span></span><aclass="headerlink"href="#gymnasium.spaces.Text.seed"title="Link to this definition">¶</a></dt>
<dd><p>Seed the pseudorandom number generator (PRNG) of this space and, if applicable, the PRNGs of subspaces.</p>
<ddclass="field-odd"><p><strong>seed</strong>– The seed value for the space. This is expanded for composite spaces to accept multiple values. For further details, please refer to the space’s documentation.</p>
<ddclass="field-even"><p><strong>The seed values used for all the PRNGs, for composite spaces this can be a tuple or dictionary of values.</strong></p>
