[HOTFIX] Manual Update in documentation compilation

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: 624309e1205313da36d665decc97bc53
+config: 79ec15fc35c91773691686c95d0218f0
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -107,18 +107,4 @@ It has a battery control for charging and discharging from the grid.
 .. image:: /_static/officeGrid.png
   :width: 700
   :alt: Shop building
-  :align: center
-
-**************************
-AutobalanceModel
-**************************
-
-**autobalance_model.epJSON:**
-It is a family house with three bedrooms, bathroom, living room and kitchen. The building has underfloor 
-heating from which you can control the water inlet and outlet of each room and the water temperature of 
-the boiler.
-
-.. image:: /_static/autobalance_model.png
-  :width: 700
-  :alt: Autobalance building
   :align: center

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

@@ -212,22 +212,6 @@ The **list of available environments** is the following:
 +----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
 | Eplus-shop-hot-discrete-stochastic-v1              | ShopWithVandBattery.epJSON               | USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw                        | Yes                 | Discrete(10)     | 01/01 - 31/12             |
 +----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-cool-discrete-v1                 | autobalanceStorageSmoothing.epJSON       | USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw | No                  | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-mixed-discrete-v1                | autobalanceStorageSmoothing.epJSON       | USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw             | No                  | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-hot-discrete-v1                  | autobalanceStorageSmoothing.epJSON       | USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw                        | No                  | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-stockholm-discrete-v1            | autobalanceStorageSmoothing.epJSON       | SWE_Stockholm.Arlanda.024600_IWEC.epw                           | No                  | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-cool-discrete-stochastic-v1      | autobalanceStorageSmoothing.epJSON       | USA_WA_Port.Angeles-William.R.Fairchild.Intl.AP.727885_TMY3.epw | Yes                 | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-mixed-discrete-stochastic-v1     | autobalanceStorageSmoothing.epJSON       | USA_NY_New.York-J.F.Kennedy.Intl.AP.744860_TMY3.epw             | Yes                 | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-hot-discrete-stochastic-v1       | autobalanceStorageSmoothing.epJSON       | USA_AZ_Davis-Monthan.AFB.722745_TMY3.epw                        | Yes                 | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
-| Eplus-autobalance-stockholm-discrete-stochastic-v1 | autobalanceStorageSmoothing.epJSON       | SWE_Stockholm.Arlanda.024600_IWEC.epw                           | Yes                 | MultiDiscrete(5) | 01/10 - 30/04 (next year) |
-+----------------------------------------------------+------------------------------------------+-----------------------------------------------------------------+---------------------+------------------+---------------------------+
 
 .. important:: Since *Sinergym* v3.0.9, these environments are generated automatically using JSON configuration files
                for each building instead of register manually each environment id with parameters directly set in 

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

@@ -1,4 +1,4 @@
-sinergym.utils.rewards.BaseReward
+sinergym.utils.rewards.BaseReward
 =================================
 
 .. currentmodule:: sinergym.utils.rewards

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

@@ -1,4 +1,4 @@
-sinergym.utils.rewards.ExpReward
+sinergym.utils.rewards.ExpReward
 ================================
 
 .. currentmodule:: sinergym.utils.rewards

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

@@ -1,4 +1,4 @@
-sinergym.utils.rewards.HourlyLinearReward
+sinergym.utils.rewards.HourlyLinearReward
 =========================================
 
 .. currentmodule:: sinergym.utils.rewards

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

@@ -1,4 +1,4 @@
-sinergym.utils.rewards.LinearReward
+sinergym.utils.rewards.LinearReward
 ===================================
 
 .. currentmodule:: sinergym.utils.rewards

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

@@ -0,0 +1,30 @@
+sinergym.utils.rewards.NormalizedLinearReward
+=============================================
+
+.. currentmodule:: sinergym.utils.rewards
+
+.. autoclass:: NormalizedLinearReward
+   :members:                                                           
+   :undoc-members:               
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~NormalizedLinearReward.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~NormalizedLinearReward.logger
+
+

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

@@ -1,4 +1,4 @@
-sinergym.utils.rewards
+sinergym.utils.rewards
 ======================
 
 .. automodule:: sinergym.utils.rewards
@@ -23,6 +23,7 @@ sinergym.utils.rewards
       ExpReward
       HourlyLinearReward
       LinearReward
+      NormalizedLinearReward
 
 
 

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

@@ -24,7 +24,8 @@ respectively.
 
 .. warning:: :math:`\lambda_P` and :math:`\lambda_T` are constants established in order to set up a 
              proportional concordance between energy and comfort penalties. If you are
-             using other buildings, be careful with these constants and update them.
+             using other buildings, be careful with these constants and update them in order to
+             have a similar magnitude of the reward components.
 
 This is the main idea of reward system in *Sinergym*. However, depending some details,
 different kinds of reward function is developed:
@@ -46,6 +47,14 @@ different kinds of reward function is developed:
    comfort and energy consumption weights equally, but outside those hours only energy 
    is considered.
 
+- ``NormalizedLinearReward`` is the same function than ``LinearReward``, but it does not use
+  the :math:`\lambda_P` and :math:`\lambda_T` to equilibrate the value magnitudes in reward
+  components. Instead, it applies a normalization using the maximum energy consumption and comfort
+  out of range values. This reward function is adaptive, since these maximum values are updated
+  along the process. It is possible to specify the initial maximum values, by default they are 0.
+
+  .. warning:: This reward function is not very precise at the beginning of the simulation, be careful with that.
+
 The reward functions have a series of **parameters** in their constructor whose values 
 may depend on the building we are using or other characteristics. For example, the 
 internal temperature or energy variables used to calculate penalties may have a 
@@ -68,11 +77,6 @@ The main parameters that it is considered in a function reward will be the next:
 - **energy_weight**: Weight given to the energy term. Defaults to 0.5. Comfort weight
   will have 1-*energy_weight*.
 
-- **lambda_energy**: Constant for removing dimensions from power(1/W). Defaults to 1e-4.
-
-- **lambda_temperature**: Constant for removing dimensions from temperature(1/C). 
-  Defaults to 1.0.
-
 .. note:: These parameters are usually common to any reward function. 
           However, they may have different parameters depending on the 
           one being used.

docs/compilation/main/genindex.html

@@ -1,12 +1,14 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Index &mdash; sinergym  documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
-      <link rel="stylesheet" href="_static/doc_theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/doc_theme.css?v=bb66aae0" />
+
+
     <link rel="shortcut icon" href="_static/logo-sidebar.png"/>
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
@@ -168,6 +170,8 @@ <h2 id="_">_</h2>
         <li><a href="pages/modules/sinergym.utils.rewards.HourlyLinearReward.html#sinergym.utils.rewards.HourlyLinearReward.__init__">(sinergym.utils.rewards.HourlyLinearReward method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.rewards.LinearReward.html#sinergym.utils.rewards.LinearReward.__init__">(sinergym.utils.rewards.LinearReward method)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.rewards.NormalizedLinearReward.html#sinergym.utils.rewards.NormalizedLinearReward.__init__">(sinergym.utils.rewards.NormalizedLinearReward method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.DatetimeWrapper.html#sinergym.utils.wrappers.DatetimeWrapper.__init__">(sinergym.utils.wrappers.DatetimeWrapper method)</a>
 </li>
@@ -550,10 +554,12 @@ <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation.normalize">normalize() (sinergym.utils.wrappers.NormalizeObservation method)</a>
+</li>
+      <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeAction.html#sinergym.utils.wrappers.NormalizeAction">NormalizeAction (class in sinergym.utils.wrappers)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeAction.html#sinergym.utils.wrappers.NormalizeAction">NormalizeAction (class in sinergym.utils.wrappers)</a>
+      <li><a href="pages/modules/sinergym.utils.rewards.NormalizedLinearReward.html#sinergym.utils.rewards.NormalizedLinearReward">NormalizedLinearReward (class in sinergym.utils.rewards)</a>
 </li>
       <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation">NormalizeObservation (class in sinergym.utils.wrappers)</a>
 </li>
@@ -909,6 +915,7 @@ <h2 id="Z">Z</h2>
             <dd><a href="../v2.5.2/index.html">v2.5.2</a></dd>
             <dd><a href="../v3.0.1/index.html">v3.0.1</a></dd>
             <dd><a href="../v3.0.6/index.html">v3.0.6</a></dd>
+            <dd><a href="../v3.1.0/index.html">v3.1.0</a></dd>
         </dl>
         <dl>
             <dt>Branches</dt>

docs/compilation/main/index.html

@@ -1,13 +1,15 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="./">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Welcome to sinergym! &mdash; sinergym  documentation</title>
-      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
-      <link rel="stylesheet" href="_static/doc_theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="_static/doc_theme.css?v=bb66aae0" />
+
+
     <link rel="shortcut icon" href="_static/logo-sidebar.png"/>
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
@@ -151,7 +153,8 @@ <h1>Welcome to <strong>sinergym</strong>!<a class="headerlink" href="#welcome-to
         <img
             src="https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge" />
     </a>
-</p><div class="admonition note">
+</p>
+<div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Please, help us to improve by <strong>reporting your questions and issues</strong>
 <a class="reference external" href="https://github.com/ugr-sail/sinergym/issues">here</a>. It is easy, just 2 clicks
@@ -247,7 +250,8 @@ <h2>Projects using Sinergym<a class="headerlink" href="#projects-using-sinergym"
         <img
             src="https://img.shields.io/badge/Powered%20by-Sinergym%20%E2%86%92-gray.svg?colorA=00BABF&colorB=4BF2F7&style=for-the-badge" />
     </a>
-</p></section>
+</p>
+</section>
 <section id="examples">
 <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
 <p>The examples can be run if you have your computer or container properly configured (see <a class="reference internal" href="pages/installation.html#installation"><span class="std std-ref">Installation</span></a> section) from our notebooks hosted in the <a class="reference external" href="https://github.com/ugr-sail/sinergym/tree/main/examples">examples</a> folder of the official <em>Sinergym</em> repository.</p>
@@ -346,6 +350,7 @@ <h2>Citing Sinergym<a class="headerlink" href="#citing-sinergym" title="Link to
             <dd><a href="../v2.5.2/index.html">v2.5.2</a></dd>
             <dd><a href="../v3.0.1/index.html">v3.0.1</a></dd>
             <dd><a href="../v3.0.6/index.html">v3.0.6</a></dd>
+            <dd><a href="../v3.1.0/index.html">v3.1.0</a></dd>
         </dl>
         <dl>
             <dt>Branches</dt>

docs/compilation/main/pages/API-reference.html

@@ -1,13 +1,15 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>API reference &mdash; sinergym  documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/doc_theme.css" type="text/css" />
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+      <link rel="stylesheet" type="text/css" href="../_static/doc_theme.css?v=bb66aae0" />
+
+
     <link rel="shortcut icon" href="../_static/logo-sidebar.png"/>
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
@@ -199,6 +201,7 @@ <h1>API reference<a class="headerlink" href="#api-reference" title="Link to this
             <dd><a href="../../v2.5.2/pages/API-reference.html">v2.5.2</a></dd>
             <dd><a href="../../v3.0.1/pages/API-reference.html">v3.0.1</a></dd>
             <dd><a href="../../v3.0.6/pages/API-reference.html">v3.0.6</a></dd>
+            <dd><a href="../../v3.1.0/pages/API-reference.html">v3.1.0</a></dd>
         </dl>
         <dl>
             <dt>Branches</dt>