Documentation source update detected and pushed compilation build dir…

…ectory for Github Pages

docs/compilation/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: e50e9e9e725e4c4a79fe6389537e7fd0
+config: 9103f37c74534f5ebaa3373dac1b67c8
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/compilation/main/.doctrees/nbsphinx/pages/notebooks/drl.ipynb

@@ -441,7 +441,7 @@
    "source": [
     "Now, is time to train the model with the callbacks defined earlier. This may take a few minutes, depending on your computer.\n",
     "\n",
-    ":warning: The warning messages that appear in `model.learn()` output is due to Stable Baselines 3 is not adapted to new standar to get environment attributes yet."
+    ":warning: The warning messages that appear in `model.learn()` output is due to Stable Baselines 3 is not adapted to new standard to get environment attributes yet."
    ]
   },
   {

docs/compilation/main/.doctrees/nbsphinx/pages/notebooks/wrappers_examples.ipynb

@@ -425,7 +425,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This is an example about how to normalize a previous continuos environment action space. If we don't define the range values, it will be constructed with the range `[-1,1]` by default:"
+    "This is an example about how to normalize a previous continuous environment action space. If we don't define the range values, it will be constructed with the range `[-1,1]` by default:"
    ]
   },
   {
@@ -538,7 +538,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This is an example about how to discretize a previous continuos environment. We will require the **new discrete action space** and an **action mapping function** whose output matches with the original unwrapped environment action space:"
+    "This is an example about how to discretize a previous continuous environment. We will require the **new discrete action space** and an **action mapping function** whose output matches with the original unwrapped environment action space:"
    ]
   },
   {

docs/compilation/main/_sources/pages/environments.rst.txt

@@ -461,7 +461,7 @@ To add new buildings for use with *Sinergym*, follow these steps:
 
    The challenge lies in knowing the names but not the possible *Keys* (EnergyPlus does not initially provide this information). 
    These names can be used to define the environment (see step 3). If the *Key* is incorrect, *Sinergym* will notify of the 
-   error and provide a file called **data_available.txt** in the aoutput, since it has already connected with the EnergyPlus API. This file will 
+   error and provide a file called **data_available.txt** in the output, since it has already connected with the EnergyPlus API. This file will 
    contain all the **controllable schedulers** for the actions and all the **observable variables**, this time with their respective *Keys*, 
    enabling the correct definition of the environment.
 

docs/compilation/main/_sources/pages/modules/sinergym.utils.wrappers.IncrementalWrapper.rst.txt

@@ -0,0 +1,46 @@
+sinergym.utils.wrappers.IncrementalWrapper
+==========================================
+
+.. currentmodule:: sinergym.utils.wrappers
+
+.. autoclass:: IncrementalWrapper
+   :members:                                                           
+   :undoc-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~IncrementalWrapper.__init__
+      ~IncrementalWrapper.action
+      ~IncrementalWrapper.class_name
+      ~IncrementalWrapper.close
+      ~IncrementalWrapper.get_wrapper_attr
+      ~IncrementalWrapper.render
+      ~IncrementalWrapper.reset
+      ~IncrementalWrapper.step
+      ~IncrementalWrapper.wrapper_spec
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~IncrementalWrapper.action_space
+      ~IncrementalWrapper.logger
+      ~IncrementalWrapper.metadata
+      ~IncrementalWrapper.np_random
+      ~IncrementalWrapper.observation_space
+      ~IncrementalWrapper.render_mode
+      ~IncrementalWrapper.reward_range
+      ~IncrementalWrapper.spec
+      ~IncrementalWrapper.unwrapped
+
+

docs/compilation/main/_sources/pages/modules/sinergym.utils.wrappers.rst.txt

@@ -22,6 +22,7 @@
       DatetimeWrapper
       DiscreteIncrementalWrapper
       DiscretizeEnv
+      IncrementalWrapper
       LoggerWrapper
       MultiObjectiveReward
       MultiObsWrapper

docs/compilation/main/_sources/pages/wrappers.rst.txt

@@ -72,19 +72,43 @@ output doesn't match with original environment action space, an error will be ra
   :alt: Discretize wrapper graph.
   :align: center
 
+***************************
+IncrementalWrapper
+***************************
+
+A wrapper to transform some of the continuous environment variables into actions indicating an increase/decrease in their current value, 
+rather than directly setting the value. To compute the possible increments/decrements for each variable, a dictionary is specified as 
+an argument, indicating the name of each variable to be transformed as the key, and the value being a tuple of values called **delta** and 
+**step**. This achieves a set of possible increments for each desired variable.
+
+- **delta**: Maximum range of increments and decrements.
+
+- **step**: Interval of intermediate values within the ranges.
+
+The following figure illustrates its operation, basically the values are rounded with nearest increment value and summed with
+current real values of simulation:
+
+.. image:: /_static/incremental_wrapper.png
+  :scale: 50 %
+  :alt: Incremental wrapper graph.
+  :align: center
+
 ***************************
 DiscreteIncrementalWrapper
 ***************************
 
 A wrapper for an incremental setpoint action space environment. This wrapper
 will update an environment, converting it in a *discrete* environment with an action mapping function and action space 
-depending on the **step** and **delta** specified. The action will be sum with **current setpoint** values instead of overwrite the latest action. 
+depending on the **delta** and **step** specified. The action will be sum with **current setpoint** values instead of overwrite the latest action. 
 Then, the action is the current setpoint values with the increase instead of the discrete value action whose purpose is to define 
-the increment/decrement itself. 
+the increment/decrement itself.
 
-.. image:: /_static/incremental_wrapper.png
+.. warning:: "This wrapper fully changes the action space from continuous to discrete, meaning that increments/decrements 
+             apply to all variables. In essence, selecting variables individually as in IncrementalWrapper is not possible."
+
+.. image:: /_static/discrete_incremental_wrapper.png
   :scale: 50 %
-  :alt: Incremental wrapper graph.
+  :alt: Discrete incremental wrapper graph.
   :align: center
 
 ***********************

docs/compilation/main/genindex.html

@@ -178,6 +178,8 @@ <h2 id="_">_</h2>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.html#sinergym.utils.wrappers.DiscreteIncrementalWrapper.__init__">(sinergym.utils.wrappers.DiscreteIncrementalWrapper method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscretizeEnv.html#sinergym.utils.wrappers.DiscretizeEnv.__init__">(sinergym.utils.wrappers.DiscretizeEnv method)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.wrappers.IncrementalWrapper.html#sinergym.utils.wrappers.IncrementalWrapper.__init__">(sinergym.utils.wrappers.IncrementalWrapper method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.LoggerWrapper.html#sinergym.utils.wrappers.LoggerWrapper.__init__">(sinergym.utils.wrappers.LoggerWrapper method)</a>
 </li>
@@ -212,18 +214,20 @@ <h2 id="A">A</h2>
 
       <ul>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscretizeEnv.html#sinergym.utils.wrappers.DiscretizeEnv.action">(sinergym.utils.wrappers.DiscretizeEnv method)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.wrappers.IncrementalWrapper.html#sinergym.utils.wrappers.IncrementalWrapper.action">(sinergym.utils.wrappers.IncrementalWrapper method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeAction.html#sinergym.utils.wrappers.NormalizeAction.action">(sinergym.utils.wrappers.NormalizeAction method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.html#sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.action">(sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper method)</a>
 </li>
       </ul></li>
       <li><a href="pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.html#sinergym.utils.wrappers.DiscreteIncrementalWrapper.action_mapping">action_mapping() (sinergym.utils.wrappers.DiscreteIncrementalWrapper method)</a>
-</li>
-      <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.action_space">action_space (sinergym.envs.eplus_env.EplusEnv property)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.action_space">action_space (sinergym.envs.eplus_env.EplusEnv property)</a>
+</li>
       <li><a href="pages/modules/sinergym.utils.logger.CSVLogger.html#sinergym.utils.logger.CSVLogger.activate_flag">activate_flag() (sinergym.utils.logger.CSVLogger method)</a>
 </li>
       <li><a href="pages/modules/sinergym.utils.wrappers.LoggerWrapper.html#sinergym.utils.wrappers.LoggerWrapper.activate_logger">activate_logger() (sinergym.utils.wrappers.LoggerWrapper method)</a>
@@ -400,10 +404,14 @@ <h2 id="I">I</h2>
         <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.idd_path">(sinergym.envs.eplus_env.EplusEnv property)</a>
 </li>
       </ul></li>
+      <li><a href="pages/modules/sinergym.utils.wrappers.IncrementalWrapper.html#sinergym.utils.wrappers.IncrementalWrapper">IncrementalWrapper (class in sinergym.utils.wrappers)</a>
+</li>
       <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.info">info() (sinergym.envs.eplus_env.EplusEnv method)</a>
 </li>
       <li><a href="pages/modules/sinergym.utils.gcloud.init_storage_client.html#sinergym.utils.gcloud.init_storage_client">init_storage_client() (in module sinergym.utils.gcloud)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.is_discrete">is_discrete (sinergym.envs.eplus_env.EplusEnv property)</a>
 
       <ul>
@@ -412,8 +420,6 @@ <h2 id="I">I</h2>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscretizeEnv.html#sinergym.utils.wrappers.DiscretizeEnv.is_discrete">(sinergym.utils.wrappers.DiscretizeEnv property)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.is_running">is_running (sinergym.envs.eplus_env.EplusEnv property)</a>
 
       <ul>
@@ -466,6 +472,8 @@ <h2 id="L">L</h2>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.html#sinergym.utils.wrappers.DiscreteIncrementalWrapper.logger">(sinergym.utils.wrappers.DiscreteIncrementalWrapper attribute)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.DiscretizeEnv.html#sinergym.utils.wrappers.DiscretizeEnv.logger">(sinergym.utils.wrappers.DiscretizeEnv attribute)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.wrappers.IncrementalWrapper.html#sinergym.utils.wrappers.IncrementalWrapper.logger">(sinergym.utils.wrappers.IncrementalWrapper attribute)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.LoggerWrapper.html#sinergym.utils.wrappers.LoggerWrapper.logger">(sinergym.utils.wrappers.LoggerWrapper attribute)</a>
 </li>

docs/compilation/main/pages/environments.html

@@ -919,7 +919,7 @@ <h2><span class="section-number">5.5. </span>Adding new buildings for environmen
 to identify the possible observable variables.</p>
 <p>The challenge lies in knowing the names but not the possible <em>Keys</em> (EnergyPlus does not initially provide this information).
 These names can be used to define the environment (see step 3). If the <em>Key</em> is incorrect, <em>Sinergym</em> will notify of the
-error and provide a file called <strong>data_available.txt</strong> in the aoutput, since it has already connected with the EnergyPlus API. This file will
+error and provide a file called <strong>data_available.txt</strong> in the output, since it has already connected with the EnergyPlus API. This file will
 contain all the <strong>controllable schedulers</strong> for the actions and all the <strong>observable variables</strong>, this time with their respective <em>Keys</em>,
 enabling the correct definition of the environment.</p>
 </li>

docs/compilation/main/pages/modules/sinergym.utils.wrappers.DatetimeWrapper.html

@@ -97,6 +97,7 @@
 <li class="toctree-l4 current"><a class="current reference internal" href="#">sinergym.utils.wrappers.DatetimeWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DiscreteIncrementalWrapper.html">sinergym.utils.wrappers.DiscreteIncrementalWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DiscretizeEnv.html">sinergym.utils.wrappers.DiscretizeEnv</a></li>
+<li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.IncrementalWrapper.html">sinergym.utils.wrappers.IncrementalWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.LoggerWrapper.html">sinergym.utils.wrappers.LoggerWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObjectiveReward.html">sinergym.utils.wrappers.MultiObjectiveReward</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObsWrapper.html">sinergym.utils.wrappers.MultiObsWrapper</a></li>

docs/compilation/main/pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.html

@@ -97,6 +97,7 @@
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DatetimeWrapper.html">sinergym.utils.wrappers.DatetimeWrapper</a></li>
 <li class="toctree-l4 current"><a class="current reference internal" href="#">sinergym.utils.wrappers.DiscreteIncrementalWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DiscretizeEnv.html">sinergym.utils.wrappers.DiscretizeEnv</a></li>
+<li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.IncrementalWrapper.html">sinergym.utils.wrappers.IncrementalWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.LoggerWrapper.html">sinergym.utils.wrappers.LoggerWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObjectiveReward.html">sinergym.utils.wrappers.MultiObjectiveReward</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObsWrapper.html">sinergym.utils.wrappers.MultiObsWrapper</a></li>

docs/compilation/main/pages/modules/sinergym.utils.wrappers.DiscretizeEnv.html

@@ -24,7 +24,7 @@
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
     <link rel="search" title="Search" href="../../search.html" />
-    <link rel="next" title="sinergym.utils.wrappers.LoggerWrapper" href="sinergym.utils.wrappers.LoggerWrapper.html" />
+    <link rel="next" title="sinergym.utils.wrappers.IncrementalWrapper" href="sinergym.utils.wrappers.IncrementalWrapper.html" />
     <link rel="prev" title="sinergym.utils.wrappers.DiscreteIncrementalWrapper" href="sinergym.utils.wrappers.DiscreteIncrementalWrapper.html" /> 
 </head>
 
@@ -97,6 +97,7 @@
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DatetimeWrapper.html">sinergym.utils.wrappers.DatetimeWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.DiscreteIncrementalWrapper.html">sinergym.utils.wrappers.DiscreteIncrementalWrapper</a></li>
 <li class="toctree-l4 current"><a class="current reference internal" href="#">sinergym.utils.wrappers.DiscretizeEnv</a></li>
+<li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.IncrementalWrapper.html">sinergym.utils.wrappers.IncrementalWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.LoggerWrapper.html">sinergym.utils.wrappers.LoggerWrapper</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObjectiveReward.html">sinergym.utils.wrappers.MultiObjectiveReward</a></li>
 <li class="toctree-l4"><a class="reference internal" href="sinergym.utils.wrappers.MultiObsWrapper.html">sinergym.utils.wrappers.MultiObsWrapper</a></li>
@@ -263,7 +264,7 @@ <h1>sinergym.utils.wrappers.DiscretizeEnv<a class="headerlink" href="#sinergym-u
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="sinergym.utils.wrappers.DiscreteIncrementalWrapper.html" class="btn btn-neutral float-left" title="sinergym.utils.wrappers.DiscreteIncrementalWrapper" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="sinergym.utils.wrappers.LoggerWrapper.html" class="btn btn-neutral float-right" title="sinergym.utils.wrappers.LoggerWrapper" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="sinergym.utils.wrappers.IncrementalWrapper.html" class="btn btn-neutral float-right" title="sinergym.utils.wrappers.IncrementalWrapper" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>