Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@whoiszyc
whoiszyc committed Jun 7, 2021
1 parent 69df814 commit 119490b
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 88 deletions.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/function.doctree
View file
Binary file not shown.
1 change: 0 additions & 1 deletion docs/build/html/_sources/function.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. _function:

*****************
Main Functions
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/autoapi/gym_power_res/envs/DS_pyomo/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headli
<tr class="row-odd"><td><p><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.SolutionDict" title="gym_power_res.envs.DS_pyomo.SolutionDict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SolutionDict</span></code></a></p></td>
<td><p>Solution dictionary is an ordered dictionary that stores the optimization results</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage" title="gym_power_res.envs.DS_pyomo.OutageManage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OutageManage</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../../../../function.html#gym_power_res.envs.DS_pyomo.OutageManage" title="gym_power_res.envs.DS_pyomo.OutageManage"><code class="xref py py-obj docutils literal notranslate"><span class="pre">OutageManage</span></code></a></p></td>
<td><p>Distribution system restoration class</p></td>
</tr>
</tbody>
Expand Down
8 changes: 4 additions & 4 deletions docs/build/html/autoapi/gym_power_res/envs/GYM_ENV_restoration_distribution/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,16 +172,16 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headli
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnvRL</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../../../../function.html#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnvRL</span></code></a></p></td>
<td><p>Restoration env for StableBaseline3 (reinforcement learning algorithm collections)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnv</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../../../../function.html#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnv</span></code></a></p></td>
<td><p>Restoration env for imitation learning</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnv119</span></code></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../../../../function.html#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisEnv119</span></code></a></p></td>
<td><p>Restoration env for imitation learning</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisVarConEnv</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../../../../function.html#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv" title="gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RestorationDisVarConEnv</span></code></a></p></td>
<td><p>Restoration env with tieline and reactive power dispatch control</p></td>
</tr>
</tbody>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/autoapi/project_dis_restoration/train_IL_BC_tieline/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headli
<tr class="row-odd"><td><p><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.DictList" title="project_dis_restoration.train_IL_BC_tieline.DictList"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictList</span></code></a></p></td>
<td><p>dict() -&gt; new empty dictionary</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent" title="project_dis_restoration.train_IL_BC_tieline.Agent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Agent</span></code></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../../../function.html#project_dis_restoration.train_IL_BC_tieline.Agent" title="project_dis_restoration.train_IL_BC_tieline.Agent"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Agent</span></code></a></p></td>
<td><p>Intelligent agent to interact with the restoration environment</p></td>
</tr>
</tbody>
Expand Down
82 changes: 3 additions & 79 deletions docs/build/html/function.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@

<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About" href="about.html" />
<link rel="prev" title="Tutorial" href="tutorial.html" />
<link rel="search" title="Search" href="search.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -90,79 +88,9 @@


<p class="caption"><span class="caption-text">IntelliHealer Manual</span></p>
<ul class="current">
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Main Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#outagemanage">OutageManage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#restoration-gym">Restoration Gym</a></li>
<li class="toctree-l2"><a class="reference internal" href="#restoration-agent">Restoration Agent</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage">OutageManage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.BasePower">BasePower</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.BigM">BigM</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.FicFlowBigM">FicFlowBigM</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.data_preparation">data_preparation</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.epsilon">epsilon</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.get_solution_2d">get_solution_2d</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.solve_load_pickup">solve_load_pickup</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.solve_load_pickup_varcon">solve_load_pickup_varcon</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.solve_network_restoration">solve_network_restoration</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.DS_pyomo.OutageManage.solve_network_restoration_varcon">solve_network_restoration_varcon</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL">RestorationDisEnvRL</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.close">close</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.dict2list">dict2list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.metadata">metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.render">render</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.reset">reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.seed">seed</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL.step">step</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv">RestorationDisEnv</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.close">close</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.dict2list">dict2list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.metadata">metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.render">render</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.reset">reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.seed">seed</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv.step">step</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119">RestorationDisEnv119</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.close">close</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.dict2list">dict2list</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.metadata">metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.render">render</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.reset">reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.seed">seed</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119.step">step</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv">RestorationDisVarConEnv</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.close">close</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.metadata">metadata</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.render">render</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.reset">reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.seed">seed</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.step">step</a></li>
<li class="toctree-l4"><a class="reference internal" href="#gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv.view_grid">view_grid</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent">Agent</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.convert_action">convert_action</a></li>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.get_expert_policy">get_expert_policy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.load_profile">load_profile</a></li>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.policy">policy</a></li>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.run_test">run_test</a></li>
<li class="toctree-l4"><a class="reference internal" href="#project_dis_restoration.train_IL_BC_tieline.Agent.run_train">run_train</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="autoapi/index.html">API Reference</a></li>
</ul>
Expand Down Expand Up @@ -233,7 +161,7 @@
<div itemprop="articleBody">

<div class="section" id="main-functions">
<span id="function"></span><h1>Main Functions<a class="headerlink" href="#main-functions" title="Permalink to this headline"></a></h1>
<h1>Main Functions<a class="headerlink" href="#main-functions" title="Permalink to this headline"></a></h1>
<p>There are three major classes in <code class="docutils literal notranslate"><span class="pre">IntelliHealer</span></code>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">OutageManage</span></code>: formulate and solve restoration optimization problems</p></li>
Expand Down Expand Up @@ -794,10 +722,6 @@ <h2>Restoration Agent<a class="headerlink" href="#restoration-agent" title="Perm

</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="about.html" class="btn btn-neutral float-right" title="About" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="tutorial.html" class="btn btn-neutral float-left" title="Tutorial" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>

<hr/>

Expand Down
Binary file modified docs/build/html/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/source/function.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
.. _function:

*****************
Main Functions
Expand Down

0 comments on commit 119490b

Please sign in to comment.