Documentation source update detected and pushed compilation build dir…

…ectory for Github Pages
ugr-sail · Nov 10, 2022 · a0ee490 · a0ee490
1 parent 867c732
commit a0ee490
Show file tree

Hide file tree

Showing 92 changed files with 344 additions and 319 deletions.
diff --git a/docs/compilation/doctrees/environment.pickle b/docs/compilation/doctrees/environment.pickle
diff --git a/docs/compilation/doctrees/pages/environments.doctree b/docs/compilation/doctrees/pages/environments.doctree
diff --git a/docs/compilation/doctrees/pages/modules/sinergym.utils.common.ranges_getter.doctree b/docs/compilation/doctrees/pages/modules/sinergym.utils.common.ranges_getter.doctree
diff --git a/docs/compilation/doctrees/pages/wrappers.doctree b/docs/compilation/doctrees/pages/wrappers.doctree
diff --git a/docs/compilation/html/_sources/pages/environments.rst.txt b/docs/compilation/html/_sources/pages/environments.rst.txt
@@ -228,6 +228,12 @@ This allows for a **dynamic definition** of these spaces. Let's see the fields r
   `variables <https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/variables>`__ 
   folder of the project (*RDD* file). 
 
+  .. note:: In case a new observation variable is added to the default ones for an environment, care must be 
+            taken in case 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.
+
 - **observation_space**: Definition of the observation space following the **OpenAI gym standard**. 
   This space is used to represent all the observations variables that we have previously 
   defined. Remember that the **year, month, day and hour** are added by *Sinergym* later, 

diff --git a/docs/compilation/html/_sources/pages/wrappers.rst.txt b/docs/compilation/html/_sources/pages/wrappers.rst.txt
@@ -45,4 +45,8 @@ An usage of these wrappers could be the next:
 .. warning:: The order of wrappers if you are going to use several at the same time is really important.
              The correct order is **Normalization - Logger - MultiObs** and subsets (for example, *Normalization* - *Multiobs* is valid).
 
+.. warning:: If you add new observation variables to the environment than the default ones, you have 
+             to update the **value range dictionary** in `sinergym/sinergym/utils/constants.py <https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/constants.py>`__ 
+             so that normalization can be applied correctly. Otherwise, you will encounter bug `#249 <https://github.com/ugr-sail/sinergym/issues/249>`__.
+
 .. note:: For more information about *Sinergym* Logger, visit :ref:`Logger`.
diff --git a/docs/compilation/html/_static/css/badge_only.css b/docs/compilation/html/_static/css/badge_only.css
diff --git a/docs/compilation/html/_static/css/theme.css b/docs/compilation/html/_static/css/theme.css
diff --git a/docs/compilation/html/genindex.html b/docs/compilation/html/genindex.html
@@ -84,8 +84,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Index</li>
+      <li><a href="index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Index</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>

diff --git a/docs/compilation/html/index.html b/docs/compilation/html/index.html
@@ -86,8 +86,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="#" class="icon icon-home"></a> &raquo;</li>
-      <li>Welcome to <strong>sinergym</strong>!</li>
+      <li><a href="#" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Welcome to <strong>sinergym</strong>!</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/API-reference.html b/docs/compilation/html/pages/API-reference.html
@@ -92,8 +92,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>API reference</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">API reference</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/API-reference.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/controllers.html b/docs/compilation/html/pages/controllers.html
@@ -87,8 +87,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Controllers</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Controllers</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/controllers.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/deep-reinforcement-learning.html b/docs/compilation/html/pages/deep-reinforcement-learning.html
@@ -95,8 +95,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Deep Reinforcement Learning Integration</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Deep Reinforcement Learning Integration</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/deep-reinforcement-learning.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/environments.html b/docs/compilation/html/pages/environments.html
@@ -106,8 +106,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Environments</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Environments</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/environments.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -721,14 +721,23 @@ <h3>Maximum Episode Data Stored in Sinergym Output<a class="headerlink" href="#m
 <h3>Observation/action spaces<a class="headerlink" href="#observation-action-spaces" title="Permalink to this heading"></a></h3>
 <p>Structure of observation and action space is defined in Environment constructor directly.
 This allows for a <strong>dynamic definition</strong> of these spaces. Let's see the fields required to do it:</p>
-<ul class="simple">
+<ul>
 <li><p><strong>observation_variables</strong>: List of observation variables that simulator is going to process like an observation.
 These variables names must follow the structure <code class="docutils literal notranslate"><span class="pre">&lt;variable_name&gt;(&lt;zone_name&gt;)</span></code> in order to register
 them correctly. <em>Sinergym</em> will check for you that the variable names are correct with respect to
 the building you are trying to simulate (<em>IDF</em> file).
 To do this, it will look at the list found in the
 <a class="reference external" href="https://github.com/ugr-sail/sinergym/tree/main/sinergym/data/variables">variables</a>
-folder of the project (<em>RDD</em> file).</p></li>
+folder of the project (<em>RDD</em> file).</p>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>In case a new observation variable is added to the default ones for an environment, care must be
+taken in case normalization is to be done. This is because you have to update
+the dictionary of ranges of values available in <a class="reference external" href="https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/constants.py">constants.py</a> as discussed in
+issue <a class="reference external" href="https://github.com/ugr-sail/sinergym/issues/249">#249</a>. You can use the range_getter function of <a class="reference external" href="https://github.com/ugr-sail/sinergym/blob/main/sinergym/utils/common.py">common.py</a> to get these
+ranges automatically from a experiment output folder.</p>
+</div>
+</li>
 <li><p><strong>observation_space</strong>: Definition of the observation space following the <strong>OpenAI gym standard</strong>.
 This space is used to represent all the observations variables that we have previously
 defined. Remember that the <strong>year, month, day and hour</strong> are added by <em>Sinergym</em> later,

diff --git a/docs/compilation/html/pages/extra-configuration.html b/docs/compilation/html/pages/extra-configuration.html
@@ -91,8 +91,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Extra Configuration in Sinergym simulations</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Extra Configuration in Sinergym simulations</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/extra-configuration.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/gcloudAPI.html b/docs/compilation/html/pages/gcloudAPI.html
@@ -108,8 +108,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Sinergym with Google Cloud</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Sinergym with Google Cloud</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/gcloudAPI.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/github-actions.html b/docs/compilation/html/pages/github-actions.html
@@ -92,8 +92,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Github Actions</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Github Actions</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/github-actions.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/installation.html b/docs/compilation/html/pages/installation.html
@@ -100,8 +100,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Installation</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Installation</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/installation.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/introduction.html b/docs/compilation/html/pages/introduction.html
@@ -85,8 +85,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>&lt;no title&gt;</li>
+      <li><a href="../index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">&lt;no title&gt;</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/pages/introduction.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/modules/sinergym.envs.eplus_env.EplusEnv.html b/docs/compilation/html/pages/modules/sinergym.envs.eplus_env.EplusEnv.html
@@ -98,11 +98,11 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../API-reference.html">API reference</a> &raquo;</li>
-          <li><a href="sinergym.envs.html">sinergym.envs</a> &raquo;</li>
-          <li><a href="sinergym.envs.eplus_env.html">sinergym.envs.eplus_env</a> &raquo;</li>
-      <li>sinergym.envs.eplus_env.EplusEnv</li>
+      <li><a href="../../index.html" class="icon icon-home"></a></li>
+          <li class="breadcrumb-item"><a href="../API-reference.html">API reference</a></li>
+          <li class="breadcrumb-item"><a href="sinergym.envs.html">sinergym.envs</a></li>
+          <li class="breadcrumb-item"><a href="sinergym.envs.eplus_env.html">sinergym.envs.eplus_env</a></li>
+      <li class="breadcrumb-item active">sinergym.envs.eplus_env.EplusEnv</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../../_sources/pages/modules/sinergym.envs.eplus_env.EplusEnv.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/modules/sinergym.envs.eplus_env.html b/docs/compilation/html/pages/modules/sinergym.envs.eplus_env.html
@@ -98,10 +98,10 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../API-reference.html">API reference</a> &raquo;</li>
-          <li><a href="sinergym.envs.html">sinergym.envs</a> &raquo;</li>
-      <li>sinergym.envs.eplus_env</li>
+      <li><a href="../../index.html" class="icon icon-home"></a></li>
+          <li class="breadcrumb-item"><a href="../API-reference.html">API reference</a></li>
+          <li class="breadcrumb-item"><a href="sinergym.envs.html">sinergym.envs</a></li>
+      <li class="breadcrumb-item active">sinergym.envs.eplus_env</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../../_sources/pages/modules/sinergym.envs.eplus_env.rst.txt" rel="nofollow"> View page source</a>
       </li>

diff --git a/docs/compilation/html/pages/modules/sinergym.envs.html b/docs/compilation/html/pages/modules/sinergym.envs.html
@@ -95,9 +95,9 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../API-reference.html">API reference</a> &raquo;</li>
-      <li>sinergym.envs</li>
+      <li><a href="../../index.html" class="icon icon-home"></a></li>
+          <li class="breadcrumb-item"><a href="../API-reference.html">API reference</a></li>
+      <li class="breadcrumb-item active">sinergym.envs</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../../_sources/pages/modules/sinergym.envs.rst.txt" rel="nofollow"> View page source</a>
       </li>