Cleaner code to imagine and render imaginary rollouts from custom states by splitting RLToyEnv.render() into 2 functions; improved naming of the image representation function to get_image_representation in ImageMultiDiscrete and ImageContinuous; made get_image_representation for the cont. 2-D toy env in ImageContinuous be applicable to an array of observations and render an epistemic uncertainty around the observation.

Author: RaghuSpaceRajan

docs/_autosummary/mdp_playground.spaces.image_continuous.ImageContinuous.rst

@@ -21,7 +21,7 @@ mdp\_playground.spaces.image\_continuous.ImageContinuous
       ~ImageContinuous.convert_to_pixel
       ~ImageContinuous.from_jsonable
       ~ImageContinuous.generate_image
-      ~ImageContinuous.get_concatenated_image
+      ~ImageContinuous.get_image_representation
       ~ImageContinuous.is_bounded
       ~ImageContinuous.sample
       ~ImageContinuous.seed

docs/_autosummary/mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.rst

@@ -20,7 +20,7 @@ mdp\_playground.spaces.image\_multi\_discrete.ImageMultiDiscrete
       ~ImageMultiDiscrete.contains
       ~ImageMultiDiscrete.from_jsonable
       ~ImageMultiDiscrete.generate_image
-      ~ImageMultiDiscrete.get_concatenated_image
+      ~ImageMultiDiscrete.get_image_representation
       ~ImageMultiDiscrete.is_bounded
       ~ImageMultiDiscrete.sample
       ~ImageMultiDiscrete.seed

docs/_build/html/_autosummary/mdp_playground.spaces.image_continuous.ImageContinuous.html

@@ -465,8 +465,8 @@ <h1>mdp_playground.spaces.image_continuous.ImageContinuous<a class="headerlink"
 <p>A space that maps a continuous 1- or 2-D space 1-to-1 to images so that the
 images may be used as representations for corresponding continuous environments.</p>
 <dl class="py method">
-<dt id="mdp_playground.spaces.image_continuous.ImageContinuous.get_concatenated_image">
-<code class="sig-name descname"><span class="pre">get_concatenated_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuous_obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_continuous.html#ImageContinuous.get_concatenated_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdp_playground.spaces.image_continuous.ImageContinuous.get_concatenated_image" title="Permalink to this definition">¶</a></dt>
+<dt id="mdp_playground.spaces.image_continuous.ImageContinuous.get_image_representation">
+<code class="sig-name descname"><span class="pre">get_image_representation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">continuous_obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_continuous.html#ImageContinuous.get_image_representation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdp_playground.spaces.image_continuous.ImageContinuous.get_image_representation" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets an image representation for a given feature space observation</p>
 </dd></dl>
 
@@ -538,7 +538,7 @@ <h1>mdp_playground.spaces.image_continuous.ImageContinuous<a class="headerlink"
 </dl>
 </p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#id0" title="mdp_playground.spaces.image_continuous.ImageContinuous.get_concatenated_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_concatenated_image</span></code></a>(obs)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#id0" title="mdp_playground.spaces.image_continuous.ImageContinuous.get_image_representation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_image_representation</span></code></a>(obs)</p></td>
 <td><p>Gets the “stitched together” image made from images corresponding to each continuous sub-space within the continuous space, concatenated along the X-axis.</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_bounded</span></code>([manner])</p></td>
@@ -585,7 +585,7 @@ <h1>mdp_playground.spaces.image_continuous.ImageContinuous<a class="headerlink"
 
 <dl class="py method">
 <dt id="id0">
-<code class="sig-name descname"><span class="pre">get_concatenated_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_continuous.html#ImageContinuous.get_concatenated_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname"><span class="pre">get_image_representation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_continuous.html#ImageContinuous.get_image_representation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the “stitched together” image made from images corresponding to
 each continuous sub-space within the continuous space, concatenated
 along the X-axis.</p>

docs/_build/html/_autosummary/mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.html

@@ -464,8 +464,8 @@ <h1>mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete<a class="heade
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">gym.spaces.box.Box</span></code></p>
 <p>A space that maps a (multi-)discrete space 1-to-1 to images so that the images may be used as representations for corresponding (multi-)discrete states. A MultiDiscrete space will have multiple dimensions. For each of these dimensions, there is a size that represents the number of categorical states that correspond to that dimension. For size = n, each of these categorical states is numbered from 0 to n-1. For each categorical state numbered n, we associate a polygon with n + 3 sides. This polygon is present in the image associated with this dimension. The images generated for all the dimensions are concatenated together by placing them side by side in the order of the dimensions in Space. Any of the transforms - rotate, flip, scale, shift - can be associated with an object of this class, to apply at random to polygons in the images whenever they are generated.</p>
 <dl class="py method">
-<dt id="mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_concatenated_image">
-<code class="sig-name descname"><span class="pre">get_concatenated_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">multi_discrete_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_multi_discrete.html#ImageMultiDiscrete.get_concatenated_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_concatenated_image" title="Permalink to this definition">¶</a></dt>
+<dt id="mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_image_representation">
+<code class="sig-name descname"><span class="pre">get_image_representation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">multi_discrete_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_multi_discrete.html#ImageMultiDiscrete.get_image_representation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_image_representation" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets an image representation for a given multi_discrete_state</p>
 </dd></dl>
 
@@ -532,7 +532,7 @@ <h1>mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete<a class="heade
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">generate_image</span></code>(discrete_state)</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="#id0" title="mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_concatenated_image"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_concatenated_image</span></code></a>(multi_discrete_state)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="#id0" title="mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete.get_image_representation"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_image_representation</span></code></a>(multi_discrete_state)</p></td>
 <td><p>Gets the “stitched together” image made from images corresponding to each discrete sub-space within the multidiscrete space, concatenated along the X-axis</p></td>
 </tr>
 <tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_bounded</span></code>([manner])</p></td>
@@ -564,7 +564,7 @@ <h1>mdp_playground.spaces.image_multi_discrete.ImageMultiDiscrete<a class="heade
 
 <dl class="py method">
 <dt id="id0">
-<code class="sig-name descname"><span class="pre">get_concatenated_image</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">multi_discrete_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_multi_discrete.html#ImageMultiDiscrete.get_concatenated_image"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname"><span class="pre">get_image_representation</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">multi_discrete_state</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/mdp_playground/spaces/image_multi_discrete.html#ImageMultiDiscrete.get_image_representation"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the “stitched together” image made from images corresponding to each discrete sub-space within the multidiscrete space, concatenated along the X-axis</p>
 </dd></dl>
 

docs/_build/html/_modules/mdp_playground/envs/rl_toy_env.html

@@ -1823,7 +1823,7 @@ <h1>Source code for mdp_playground.envs.rl_toy_env</h1><div class="highlight"><p
             <span class="n">next_obs</span> <span class="o">=</span> <span class="n">next_state</span>
 
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_representations</span><span class="p">:</span>
-            <span class="n">next_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">get_concatenated_image</span><span class="p">(</span><span class="n">next_state</span><span class="p">)</span>
+            <span class="n">next_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">get_image_representation</span><span class="p">(</span><span class="n">next_state</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">curr_state</span> <span class="o">=</span> <span class="n">next_state</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">curr_obs</span> <span class="o">=</span> <span class="n">next_obs</span>
@@ -1935,7 +1935,7 @@ <h1>Source code for mdp_playground.envs.rl_toy_env</h1><div class="highlight"><p
 
 
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_representations</span><span class="p">:</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">curr_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">get_concatenated_image</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">curr_state</span><span class="p">)</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">curr_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">observation_space</span><span class="o">.</span><span class="n">get_image_representation</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">curr_state</span><span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">curr_obs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">curr_state</span>
 

docs/_build/html/_modules/mdp_playground/spaces/image_continuous.html

@@ -453,7 +453,7 @@ <h1>Source code for mdp_playground.spaces.image_continuous</h1><div class="highl
 
 <span class="sd">    Methods</span>
 <span class="sd">    -------</span>
-<span class="sd">    get_concatenated_image(continuous_obs)</span>
+<span class="sd">    get_image_representation(continuous_obs)</span>
 <span class="sd">        Gets an image representation for a given feature space observation</span>
 <span class="sd">    &#39;&#39;&#39;</span>
 
@@ -556,7 +556,7 @@ <h1>Source code for mdp_playground.spaces.image_continuous</h1><div class="highl
             <span class="n">offset</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">relevant</span> <span class="k">else</span> <span class="mi">2</span>
             <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid_shape</span><span class="p">[</span><span class="mi">0</span> <span class="o">+</span> <span class="n">offset</span><span class="p">]</span> <span class="o">+</span> <span class="mi">1</span><span class="p">):</span> <span class="c1"># +1 because this is along</span>
             <span class="c1"># concatentation dimension when stitching together images below in</span>
-            <span class="c1"># get_concatenated_image</span>
+            <span class="c1"># get_image_representation</span>
                 <span class="n">x_</span> <span class="o">=</span> <span class="n">i</span> <span class="o">*</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">//</span> <span class="bp">self</span><span class="o">.</span><span class="n">grid_shape</span><span class="p">[</span><span class="mi">0</span> <span class="o">+</span> <span class="n">offset</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span> <span class="c1"># -1 to not go outside</span>
                 <span class="c1"># image size for the last line drawn</span>
                 <span class="n">y_</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">height</span>
@@ -612,7 +612,7 @@ <h1>Source code for mdp_playground.spaces.image_continuous</h1><div class="highl
 
         <span class="k">return</span> <span class="n">ret_arr</span></div>
 
-<div class="viewcode-block" id="ImageContinuous.get_concatenated_image"><a class="viewcode-back" href="../../../_autosummary/mdp_playground.spaces.image_continuous.ImageContinuous.html#mdp_playground.spaces.image_continuous.ImageContinuous.get_concatenated_image">[docs]</a>    <span class="k">def</span> <span class="nf">get_concatenated_image</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
+<div class="viewcode-block" id="ImageContinuous.get_image_representation"><a class="viewcode-back" href="../../../_autosummary/mdp_playground.spaces.image_continuous.ImageContinuous.html#mdp_playground.spaces.image_continuous.ImageContinuous.get_image_representation">[docs]</a>    <span class="k">def</span> <span class="nf">get_image_representation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obs</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;Gets the &quot;stitched together&quot; image made from images corresponding to</span>
 <span class="sd">        each continuous sub-space within the continuous space, concatenated</span>
 <span class="sd">        along the X-axis.</span>
@@ -645,7 +645,7 @@ <h1>Source code for mdp_playground.spaces.image_continuous</h1><div class="highl
 <div class="viewcode-block" id="ImageContinuous.sample"><a class="viewcode-back" href="../../../_autosummary/mdp_playground.spaces.image_continuous.ImageContinuous.html#mdp_playground.spaces.image_continuous.ImageContinuous.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">sampled</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">feature_space</span><span class="o">.</span><span class="n">sample</span><span class="p">()</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_concatenated_image</span><span class="p">(</span><span class="n">sampled</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_image_representation</span><span class="p">(</span><span class="n">sampled</span><span class="p">)</span></div>
 
     <span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2"> with continuous underlying space of shape: </span><span class="si">{}</span><span class="s2"> and &quot;</span>\