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: d2eeced913a217d4567409d94e74fa56
+config: 6e885d4a122622fcd7dad58a50bfeccf
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -1136,8 +1136,8 @@
    ],
    "source": [
     "artifact = wandb.Artifact(\n",
-    "        name=\"training\",\n",
-    "        type=\"experiment1\")\n",
+    "        name=\"experiment1\",\n",
+    "        type=\"training\")\n",
     "artifact.add_dir(\n",
     "        env.experiment_path,\n",
     "        name='training_output/')\n",
@@ -1385,7 +1385,7 @@
     "# get wandb artifact path (to load model)\n",
     "load_artifact_entity = 'alex_ugr'\n",
     "load_artifact_project = 'sinergym'\n",
-    "load_artifact_name = 'training'\n",
+    "load_artifact_name = 'experiment1'\n",
     "load_artifact_tag = 'latest'\n",
     "load_artifact_model_path = 'evaluation_output/best_model/model.zip'\n",
     "wandb_path = load_artifact_entity + '/' + load_artifact_project + \\\n",
@@ -1718,8 +1718,8 @@
    ],
    "source": [
     "artifact = wandb.Artifact(\n",
-    "    name=\"evaluating\",\n",
-    "    type=\"evaluation1\")\n",
+    "    name=\"evaluation1\",\n",
+    "    type=\"evaluating\")\n",
     "artifact.add_dir(\n",
     "    env.experiment_path,\n",
     "    name='evaluation_output/')\n",

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

@@ -20,7 +20,7 @@
       ~NormalizeObservation.close
       ~NormalizeObservation.get_unwrapped_obs
       ~NormalizeObservation.get_wrapper_attr
-      ~NormalizeObservation.observation
+      ~NormalizeObservation.normalize
       ~NormalizeObservation.render
       ~NormalizeObservation.reset
       ~NormalizeObservation.step

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

@@ -63,10 +63,6 @@ directory, they are organized by different modules:
   `sinergym/sinergym/utils/common.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/common.py>`__. 
   Here will be all tests that check *Sinergym* common utils functionalities.
 
-- **test_constants.py**: Tests for 
-  `sinergym/sinergym/utils/constants.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/constants.py>`__. 
-  Here will be all tests that check *Sinergym* global variables.
-
 - **test_reward.py**: Tests for 
   `sinergym/sinergym/utils/rewards.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/rewards.py>`__. 
   Here will be all tests that check implementation(s) of reward function(s) applicable to sinergym environments.

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

@@ -27,17 +27,9 @@ You can implement your own wrappers inheriting from *gym.Wrapper* or some of its
   :alt: Incremental wrapper graph.
   :align: center
 
-- **NormalizeObservation**: It is used to transform observation received from simulator in values between 0 and 1.
-  It is possible to define a list of variables you want to normalize, if you don't define this list, all environment
-  variables will be included. In order to normalize values, it is necessary a dictionary in order to store max and min values. 
-  Then, if a environment variable is not included in the dictionary specified in wrapper constructor, then the normalization 
-  for that variable will be skipped.
-
-  .. warning:: In case a new observation variable is added to the default ones for an environment, care must be 
-          taken in case observation normalization is to be done. This is because you have to update 
-          the dictionary of ranges of values available in `constants.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/constants.py>`__ as discussed in 
-          issue `#249 <https://github.com/ugr-sail/sinergym/issues/249>`__. You can use the ``range_getter`` function of `common.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/common.py>`__ to get these 
-          ranges automatically from a experiment output folder.
+- **NormalizeObservation**: It is used to transform observation received from simulator in values between -1 and 1.
+  It is based in the `dynamic normalization wrapper of Gymnasium <https://gymnasium.farama.org/_modules/gymnasium/wrappers/normalize/#NormalizeObservation>`__. At the beginning,
+  it is not precise and the values may be out of range usually, so use this wrapper carefully.
 
 - **LoggerWrapper**: Wrapper for logging all interactions between agent and environment. Logger class can be selected
   in the constructor if other type of logging is required. For more information about *Sinergym* Logger visit :ref:`Logger`.

docs/compilation/main/genindex.html

@@ -492,6 +492,10 @@ <h2 id="M">M</h2>
 
 <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>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation">NormalizeObservation (class in sinergym.utils.wrappers)</a>
 </li>
@@ -504,8 +508,6 @@ <h2 id="O">O</h2>
       <li><a href="pages/modules/sinergym.utils.wrappers.DatetimeWrapper.html#sinergym.utils.wrappers.DatetimeWrapper.observation">observation() (sinergym.utils.wrappers.DatetimeWrapper method)</a>
 
       <ul>
-        <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation.observation">(sinergym.utils.wrappers.NormalizeObservation method)</a>
-</li>
         <li><a href="pages/modules/sinergym.utils.wrappers.PreviousObservationWrapper.html#sinergym.utils.wrappers.PreviousObservationWrapper.observation">(sinergym.utils.wrappers.PreviousObservationWrapper method)</a>
 </li>
       </ul></li>
@@ -555,6 +557,8 @@ <h2 id="R">R</h2>
         <li><a href="pages/modules/sinergym.utils.wrappers.LoggerWrapper.html#sinergym.utils.wrappers.LoggerWrapper.reset">(sinergym.utils.wrappers.LoggerWrapper method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.MultiObsWrapper.html#sinergym.utils.wrappers.MultiObsWrapper.reset">(sinergym.utils.wrappers.MultiObsWrapper method)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation.reset">(sinergym.utils.wrappers.NormalizeObservation method)</a>
 </li>
       </ul></li>
       <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.runperiod">runperiod (sinergym.envs.eplus_env.EplusEnv property)</a>
@@ -636,15 +640,15 @@ <h2 id="S">S</h2>
         <li><a href="pages/modules/sinergym.utils.common.html#module-sinergym.utils.common">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     sinergym.utils.constants
 
       <ul>
         <li><a href="pages/modules/sinergym.utils.constants.html#module-sinergym.utils.constants">module</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     sinergym.utils.controllers
 
@@ -704,6 +708,8 @@ <h2 id="S">S</h2>
         <li><a href="pages/modules/sinergym.utils.wrappers.MultiObjectiveReward.html#sinergym.utils.wrappers.MultiObjectiveReward.step">(sinergym.utils.wrappers.MultiObjectiveReward method)</a>
 </li>
         <li><a href="pages/modules/sinergym.utils.wrappers.MultiObsWrapper.html#sinergym.utils.wrappers.MultiObsWrapper.step">(sinergym.utils.wrappers.MultiObsWrapper method)</a>
+</li>
+        <li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation.step">(sinergym.utils.wrappers.NormalizeObservation method)</a>
 </li>
       </ul></li>
       <li><a href="pages/modules/sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv.step_size">step_size (sinergym.envs.eplus_env.EplusEnv property)</a>

docs/compilation/main/pages/modules/sinergym.config.html

@@ -116,9 +116,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-config">
-<h1>sinergym.config<a class="headerlink" href="#sinergym-config" title="Link to this heading"></a></h1>
-<p id="module-sinergym.config">Modeling python objects about simulation (building, weather, etc).</p>
+  <section id="module-sinergym.config">
+<span id="sinergym-config"></span><h1>sinergym.config<a class="headerlink" href="#module-sinergym.config" title="Link to this heading"></a></h1>
+<p>Modeling python objects about simulation (building, weather, etc).</p>
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.config.modeling.html

@@ -120,9 +120,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-config-modeling">
-<h1>sinergym.config.modeling<a class="headerlink" href="#sinergym-config-modeling" title="Link to this heading"></a></h1>
-<p id="module-sinergym.config.modeling">Class and utilities for backend modeling in Python with Sinergym (extra params, weather_variability, building model modification and files management)</p>
+  <section id="module-sinergym.config.modeling">
+<span id="sinergym-config-modeling"></span><h1>sinergym.config.modeling<a class="headerlink" href="#module-sinergym.config.modeling" title="Link to this heading"></a></h1>
+<p>Class and utilities for backend modeling in Python with Sinergym (extra params, weather_variability, building model modification and files management)</p>
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.envs.eplus_env.html

@@ -120,9 +120,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-envs-eplus-env">
-<h1>sinergym.envs.eplus_env<a class="headerlink" href="#sinergym-envs-eplus-env" title="Link to this heading"></a></h1>
-<p id="module-sinergym.envs.eplus_env">Gymnasium environment for simulation with EnergyPlus.</p>
+  <section id="module-sinergym.envs.eplus_env">
+<span id="sinergym-envs-eplus-env"></span><h1>sinergym.envs.eplus_env<a class="headerlink" href="#module-sinergym.envs.eplus_env" title="Link to this heading"></a></h1>
+<p>Gymnasium environment for simulation with EnergyPlus.</p>
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.envs.html

@@ -116,9 +116,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-envs">
-<h1>sinergym.envs<a class="headerlink" href="#sinergym-envs" title="Link to this heading"></a></h1>
-<p id="module-sinergym.envs">Sinergym simulation environments.</p>
+  <section id="module-sinergym.envs">
+<span id="sinergym-envs"></span><h1>sinergym.envs<a class="headerlink" href="#module-sinergym.envs" title="Link to this heading"></a></h1>
+<p>Sinergym simulation environments.</p>
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.simulators.eplus.html

@@ -120,9 +120,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-simulators-eplus">
-<h1>sinergym.simulators.eplus<a class="headerlink" href="#sinergym-simulators-eplus" title="Link to this heading"></a></h1>
-<p id="module-sinergym.simulators.eplus">Class for connecting EnergyPlus with Python using pyenergyplus API.</p>
+  <section id="module-sinergym.simulators.eplus">
+<span id="sinergym-simulators-eplus"></span><h1>sinergym.simulators.eplus<a class="headerlink" href="#module-sinergym.simulators.eplus" title="Link to this heading"></a></h1>
+<p>Class for connecting EnergyPlus with Python using pyenergyplus API.</p>
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.simulators.html

@@ -116,9 +116,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-simulators">
-<h1>sinergym.simulators<a class="headerlink" href="#sinergym-simulators" title="Link to this heading"></a></h1>
-<p id="module-sinergym.simulators">Communication interface with simulators.</p>
+  <section id="module-sinergym.simulators">
+<span id="sinergym-simulators"></span><h1>sinergym.simulators<a class="headerlink" href="#module-sinergym.simulators" title="Link to this heading"></a></h1>
+<p>Communication interface with simulators.</p>
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.callbacks.html

@@ -130,9 +130,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-callbacks">
-<h1>sinergym.utils.callbacks<a class="headerlink" href="#sinergym-utils-callbacks" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.callbacks">Custom Callbacks for stable baselines 3 algorithms.</p>
+  <section id="module-sinergym.utils.callbacks">
+<span id="sinergym-utils-callbacks"></span><h1>sinergym.utils.callbacks<a class="headerlink" href="#module-sinergym.utils.callbacks" title="Link to this heading"></a></h1>
+<p>Custom Callbacks for stable baselines 3 algorithms.</p>
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.common.html

@@ -136,9 +136,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-common">
-<h1>sinergym.utils.common<a class="headerlink" href="#sinergym-utils-common" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.common">Common utilities.</p>
+  <section id="module-sinergym.utils.common">
+<span id="sinergym-utils-common"></span><h1>sinergym.utils.common<a class="headerlink" href="#module-sinergym.utils.common" title="Link to this heading"></a></h1>
+<p>Common utilities.</p>
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.constants.html

@@ -126,9 +126,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-constants">
-<h1>sinergym.utils.constants<a class="headerlink" href="#sinergym-utils-constants" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.constants">Constants used in whole project.</p>
+  <section id="module-sinergym.utils.constants">
+<span id="sinergym-utils-constants"></span><h1>sinergym.utils.constants<a class="headerlink" href="#module-sinergym.utils.constants" title="Link to this heading"></a></h1>
+<p>Constants used in whole project.</p>
 </section>
 
 

docs/compilation/main/pages/modules/sinergym.utils.controllers.html

@@ -131,9 +131,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-controllers">
-<h1>sinergym.utils.controllers<a class="headerlink" href="#sinergym-utils-controllers" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.controllers">Implementation of basic controllers.</p>
+  <section id="module-sinergym.utils.controllers">
+<span id="sinergym-utils-controllers"></span><h1>sinergym.utils.controllers<a class="headerlink" href="#module-sinergym.utils.controllers" title="Link to this heading"></a></h1>
+<p>Implementation of basic controllers.</p>
 <p class="rubric">Classes</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.env_checker.html

@@ -129,9 +129,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-env-checker">
-<h1>sinergym.utils.env_checker<a class="headerlink" href="#sinergym-utils-env-checker" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.env_checker">Env checker functionality, adapted from Stable-Baselines: <a class="reference external" href="https://github.com/DLR-RM/stable-baselines3">https://github.com/DLR-RM/stable-baselines3</a></p>
+  <section id="module-sinergym.utils.env_checker">
+<span id="sinergym-utils-env-checker"></span><h1>sinergym.utils.env_checker<a class="headerlink" href="#module-sinergym.utils.env_checker" title="Link to this heading"></a></h1>
+<p>Env checker functionality, adapted from Stable-Baselines: <a class="reference external" href="https://github.com/DLR-RM/stable-baselines3">https://github.com/DLR-RM/stable-baselines3</a></p>
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.evaluation.html

@@ -129,9 +129,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-evaluation">
-<h1>sinergym.utils.evaluation<a class="headerlink" href="#sinergym-utils-evaluation" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.evaluation">Custom policy evaluations for Evaluation Callbacks.</p>
+  <section id="module-sinergym.utils.evaluation">
+<span id="sinergym-utils-evaluation"></span><h1>sinergym.utils.evaluation<a class="headerlink" href="#module-sinergym.utils.evaluation" title="Link to this heading"></a></h1>
+<p>Custom policy evaluations for Evaluation Callbacks.</p>
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

docs/compilation/main/pages/modules/sinergym.utils.gcloud.html

@@ -133,9 +133,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils-gcloud">
-<h1>sinergym.utils.gcloud<a class="headerlink" href="#sinergym-utils-gcloud" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils.gcloud">Utilities to use Google Cloud Python API and Google Cloud API REST easier.</p>
+  <section id="module-sinergym.utils.gcloud">
+<span id="sinergym-utils-gcloud"></span><h1>sinergym.utils.gcloud<a class="headerlink" href="#module-sinergym.utils.gcloud" title="Link to this heading"></a></h1>
+<p>Utilities to use Google Cloud Python API and Google Cloud API REST easier.</p>
 <p class="rubric">Functions</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>

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

@@ -125,9 +125,9 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="sinergym-utils">
-<h1>sinergym.utils<a class="headerlink" href="#sinergym-utils" title="Link to this heading"></a></h1>
-<p id="module-sinergym.utils">Includes common utilities, controllers, rewards, wrappers and custom callbacks.</p>
+  <section id="module-sinergym.utils">
+<span id="sinergym-utils"></span><h1>sinergym.utils<a class="headerlink" href="#module-sinergym.utils" title="Link to this heading"></a></h1>
+<p>Includes common utilities, controllers, rewards, wrappers and custom callbacks.</p>
 <p class="rubric">Modules</p>
 <table class="autosummary longtable docutils align-default">
 <tbody>