Skip to content

Commit

Permalink
Documentation source update detected and pushed compilation build dir…
Browse files Browse the repository at this point in the history 
…ectory for Github Pages
  • Loading branch information
@AlejandroCN7 @github-actions
AlejandroCN7 authored and github-actions[bot] committed May 2, 2024
1 parent 6e87842 commit 5318e48
Show file tree
Hide file tree
Showing 1,121 changed files with 237,414 additions and 158,512 deletions.
2 changes: 1 addition & 1 deletion docs/compilation/main/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: ccaa442ce4593530ac48695f3c59bcb4
config: 137a891d2d5b45bed16d16e7680fc03b
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/compilation/main/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/index.doctree
View file
Binary file not shown.
131,910 changes: 79,115 additions & 52,795 deletions docs/compilation/main/.doctrees/nbsphinx/pages/notebooks/drl.ipynb
View file

Large diffs are not rendered by default.

Binary file modified docs/compilation/main/.doctrees/pages/API-reference.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/architecture.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/buildings.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/controllers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/deep-reinforcement-learning.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/environments.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/environments_registration.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/extra-configuration.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/gcloudAPI.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/github-actions.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/installation.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/introduction.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.modeling.ModelJSON.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.config.modeling.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.eplus_env.EplusEnv.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.envs.eplus_env.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.eplus.EnergyPlus.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.simulators.eplus.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.LoggerCallback.doctree
View file
Binary file not shown.
Binary file modified ...pilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.LoggerEvalCallback.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.callbacks.doctree
View file
Binary file not shown.
Binary file modified ...main/.doctrees/pages/modules/sinergym.utils.common.convert_conf_to_env_parameters.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.doctree
View file
Binary file not shown.
Binary file modified ...mpilation/main/.doctrees/pages/modules/sinergym.utils.common.eppy_element_to_dict.doctree
View file
Binary file not shown.
Binary file modified ...ion/main/.doctrees/pages/modules/sinergym.utils.common.export_schedulers_to_excel.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.common.get_delta_seconds.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.get_ids.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.get_record_keys.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.is_wrapped.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.common.json_to_actuators.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.json_to_meters.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.common.json_to_variables.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.ranges_getter.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.common.unwrap_wrapper.doctree
View file
Binary file not shown.
Binary file modified .../.doctrees/pages/modules/sinergym.utils.constants.DEFAULT_5ZONE_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ...trees/pages/modules/sinergym.utils.constants.DEFAULT_DATACENTER_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ...trees/pages/modules/sinergym.utils.constants.DEFAULT_OFFICEGRID_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ....doctrees/pages/modules/sinergym.utils.constants.DEFAULT_OFFICE_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ...doctrees/pages/modules/sinergym.utils.constants.DEFAULT_RADIANT_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ...n/.doctrees/pages/modules/sinergym.utils.constants.DEFAULT_SHOP_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified ...ctrees/pages/modules/sinergym.utils.constants.DEFAULT_WAREHOUSE_DISCRETE_FUNCTION.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.constants.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RBC5Zone.doctree
View file
Binary file not shown.
Binary file modified ...compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RBCDatacenter.doctree
View file
Binary file not shown.
Binary file modified .../main/.doctrees/pages/modules/sinergym.utils.controllers.RBCIncrementalDatacenter.doctree
View file
Binary file not shown.
Binary file modified ...pilation/main/.doctrees/pages/modules/sinergym.utils.controllers.RandomController.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.controllers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.env_checker.check_env.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.env_checker.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.evaluation.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.evaluation.evaluate_policy.doctree
View file
Binary file not shown.
Binary file modified .../.doctrees/pages/modules/sinergym.utils.gcloud.delete_instance_MIG_from_container.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.doctree
View file
Binary file not shown.
Binary file modified ...tion/main/.doctrees/pages/modules/sinergym.utils.gcloud.get_service_account_token.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.init_storage_client.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.read_from_bucket.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.gcloud.upload_to_bucket.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.CSVLogger.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.CustomFormatter.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.Logger.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.logger.WandBOutputFormat.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.logger.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.BaseReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.ExpReward.doctree
View file
Binary file not shown.
Binary file modified ...ompilation/main/.doctrees/pages/modules/sinergym.utils.rewards.HourlyLinearReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.LinearReward.doctree
View file
Binary file not shown.
Binary file modified ...lation/main/.doctrees/pages/modules/sinergym.utils.rewards.NormalizedLinearReward.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.rewards.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.DatetimeWrapper.doctree
View file
Binary file not shown.
Binary file modified ...n/main/.doctrees/pages/modules/sinergym.utils.wrappers.DiscreteIncrementalWrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.DiscretizeEnv.doctree
View file
Binary file not shown.
Binary file modified ...mpilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.IncrementalWrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.LoggerWrapper.doctree
View file
Binary file not shown.
Binary file modified ...ilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.MultiObjectiveReward.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.MultiObsWrapper.doctree
View file
Binary file not shown.
Binary file modified .../compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.NormalizeAction.doctree
View file
Binary file not shown.
Binary file modified ...ilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.NormalizeObservation.doctree
View file
Binary file not shown.
Binary file modified ...odules/sinergym.utils.wrappers.OfficeGridStorageSmoothingActionConstraintsWrapper.doctree
View file
Binary file not shown.
Binary file modified ...n/main/.doctrees/pages/modules/sinergym.utils.wrappers.PreviousObservationWrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/modules/sinergym.utils.wrappers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/basic_example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/change_environment.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/default_building_control.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/drl.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/getting_env_information.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/personalize_loggerwrapper.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/rule_controller_example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/notebooks/wrappers_examples.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/output.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/rewards.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/tests.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/usage-example.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/weathers.doctree
View file
Binary file not shown.
Binary file modified docs/compilation/main/.doctrees/pages/wrappers.doctree
View file
Binary file not shown.
6 changes: 6 additions & 0 deletions docs/compilation/main/_sources/pages/wrappers.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ However, *Sinergym* enhances its functionality with some additional features:
- The automatic calibration can be enabled or disabled as you interact with the environment, allowing the
calibration to remain static instead of adaptive.

In addition, this wrapper saves the values of mean and var in txt files in the
*Sinergym* output. This should be used in case of evaluating the model later.
An example of its use can be found in the use case :ref:`Loading a model`. It is
also important that normalization calibration update is deactivated during evaluation
processes.

These functionalities are crucial when evaluating models trained using this wrapper.
For more details, visit `#407 <https://github.com/ugr-sail/sinergym/issues/407>`__.

Expand Down
2 changes: 2 additions & 0 deletions docs/compilation/main/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,8 @@ <h2 id="C">C</h2>

<ul>
<li><a href="pages/modules/sinergym.utils.wrappers.LoggerWrapper.html#sinergym.utils.wrappers.LoggerWrapper.close">(sinergym.utils.wrappers.LoggerWrapper method)</a>
</li>
<li><a href="pages/modules/sinergym.utils.wrappers.NormalizeObservation.html#sinergym.utils.wrappers.NormalizeObservation.close">(sinergym.utils.wrappers.NormalizeObservation method)</a>
</li>
</ul></li>
</ul></td>
Expand Down
Binary file modified docs/compilation/main/objects.inv
View file
Binary file not shown.
18 changes: 12 additions & 6 deletions docs/compilation/main/pages/modules/sinergym.utils.wrappers.NormalizeObservation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,10 @@
<h1>sinergym.utils.wrappers.NormalizeObservation<a class="headerlink" href="#sinergym-utils-wrappers-normalizeobservation" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sinergym.utils.wrappers.</span></span><span class="sig-name descname"><span class="pre">NormalizeObservation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv" title="sinergym.envs.eplus_env.EplusEnv"><span class="pre">EplusEnv</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">epsilon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sinergym.utils.wrappers.</span></span><span class="sig-name descname"><span class="pre">NormalizeObservation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv" title="sinergym.envs.eplus_env.EplusEnv"><span class="pre">EplusEnv</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">epsilon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation" title="Link to this definition"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv" title="sinergym.envs.eplus_env.EplusEnv"><span class="pre">EplusEnv</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">epsilon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.__init__" title="Link to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="sinergym.envs.eplus_env.EplusEnv.html#sinergym.envs.eplus_env.EplusEnv" title="sinergym.envs.eplus_env.EplusEnv"><span class="pre">EplusEnv</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">automatic_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">epsilon</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">var</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.__init__" title="Link to this definition"></a></dt>
<dd><p>Initializes the NormalizationWrapper. Mean and var values can be None andbeing updated during interaction with environment.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand All @@ -178,8 +178,8 @@ <h1>sinergym.utils.wrappers.NormalizeObservation<a class="headerlink" href="#sin
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">class_name</span></code>()</p></td>
<td><p>Returns the class name of the wrapper.</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">close</span></code>()</p></td>
<td><p>Closes the wrapper and <code class="xref py py-attr docutils literal notranslate"><span class="pre">env</span></code>.</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#sinergym.utils.wrappers.NormalizeObservation.close" title="sinergym.utils.wrappers.NormalizeObservation.close"><code class="xref py py-obj docutils literal notranslate"><span class="pre">close</span></code></a>()</p></td>
<td><p>Close the environment and save normalization calibration.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#sinergym.utils.wrappers.NormalizeObservation.deactivate_update" title="sinergym.utils.wrappers.NormalizeObservation.deactivate_update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">deactivate_update</span></code></a>()</p></td>
<td><p>Deactivates the automatic update of the normalization wrapper.</p></td>
Expand Down Expand Up @@ -255,6 +255,12 @@ <h1>sinergym.utils.wrappers.NormalizeObservation<a class="headerlink" href="#sin
After calling this method, the normalization wrapper will update its calibration automatically.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation.close">
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.close" title="Link to this definition"></a></dt>
<dd><p>Close the environment and save normalization calibration.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation.deactivate_update">
<span class="sig-name descname"><span class="pre">deactivate_update</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.deactivate_update" title="Link to this definition"></a></dt>
Expand All @@ -269,7 +275,7 @@ <h1>sinergym.utils.wrappers.NormalizeObservation<a class="headerlink" href="#sin

<dl class="py property">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation.mean">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mean</span></span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.mean" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mean</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.mean" title="Link to this definition"></a></dt>
<dd><p>Returns the mean value of the observations.</p>
</dd></dl>

Expand Down Expand Up @@ -306,7 +312,7 @@ <h1>sinergym.utils.wrappers.NormalizeObservation<a class="headerlink" href="#sin

<dl class="py property">
<dt class="sig sig-object py" id="sinergym.utils.wrappers.NormalizeObservation.var">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">var</span></span><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.var" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">var</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float64</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#sinergym.utils.wrappers.NormalizeObservation.var" title="Link to this definition"></a></dt>
<dd><p>Returns the variance value of the observations.</p>
</dd></dl>

Expand Down
Loading

0 comments on commit 5318e48

Please sign in to comment.