update docs and comments

whoiszyc · Jun 7, 2021 · fe8a067 · fe8a067
1 parent e3bcc9e
commit fe8a067
Show file tree

Hide file tree

Showing 23 changed files with 910 additions and 3,169 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/function.doctree b/docs/build/doctrees/function.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/install.doctree b/docs/build/doctrees/install.doctree
diff --git a/docs/build/doctrees/tutorial.doctree b/docs/build/doctrees/tutorial.doctree
diff --git a/docs/build/html/_sources/function.rst.txt b/docs/build/html/_sources/function.rst.txt
@@ -4,51 +4,48 @@
 Main Functions
 *****************
 
-This chapter contains advanced topics on modeling and simulation and how they are implemented in ANDES.
-It aims to provide an in-depth explanation of how the ANDES framework is set up for symbolic modeling and
-numerical simulation. It also provides an example for interested users to implement customized DAE models.
+There are three major classes in ``IntelliHealer``:
 
-System
-=======
+- ``OutageManage``: formulate and solve restoration optimization problems
+- ``RestorationDisEnv``, ``RestorationDisEnv119``, ``RestorationDisEnvRL``: interact with agent for learning
+- ``Agent``: solve imitation and reinforcement learning problems
 
-Overview
---------
-System is the top-level class for organizing power system models and orchestrating calculations.
 
-.. autoclass:: gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL
-    :members:
-    :undoc-members:
-    :show-inheritance:
+OutageManage
+=============================================
 
 .. autoclass:: gym_power_res.envs.DS_pyomo.OutageManage
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. note::
-    `andes.System` is an alias of `andes.system.System`.
-
-
-Dynamic Imports
+Restoration Gym
+===================
 
-System dynamically imports groups, models, and routines at creation.
-To add new models, groups or routines, edit the corresponding file by adding entries following examples.
-
-.. autofunction:: project_dis_restoration.train_IL_BC_tieline.main_behavior_cloning
-    :noindex:
+.. autoclass:: gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnvRL
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
+.. autoclass:: gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-Code Generation
+.. autoclass:: gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisEnv119
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-Under the hood, all symbolically defined equations need to be generated into anonymous function calls for
-accelerating numerical simulations.
-This process is automatically invoked for the first time ANDES is run command line.
-It takes several seconds up to a minute to finish the generation.
+.. autoclass:: gym_power_res.envs.GYM_ENV_restoration_distribution.RestorationDisVarConEnv
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. note::
-    Code generation has been done if one has executed ``andes``, ``andes selftest``, or ``andes prepare``.
+Restoration Agent
+===================
 
-.. warning::
-    When models are modified (such as adding new models or changing equation strings), code generation needs
-    to be executed again for consistency. It can be more conveniently triggered from command line with
-    ``andes prepare -i``.
+.. autoclass:: project_dis_restoration.train_IL_BC_tieline.Agent
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -50,7 +50,8 @@ Features
 .. image:: /../../project_dis_restoration/results/plots/Hybrid_policy.png
    :width: 400
 
-- IntelliHealer provides an `OpenAI-Gym <https://gym.openai.com>`_ environment for distribution system restoration, which can be connected to `Stable-Baselines3 <https://stable-baselines3.readthedocs.io/en/master/?badge=master>`_, a state-of-the-art collection of reinforcement learning algorithms.
+- IntelliHealer provides an `OpenAI-Gym <https://gym.openai.com>`_ environment for distribution system restoration,
+  which can be connected to `Stable-Baselines3 <https://stable-baselines3.readthedocs.io/en/master/?badge=master>`_, a state-of-the-art collection of reinforcement learning algorithms.
   Currently, the Gym environment contains two test feeders: 33-node and 119-node system.
 
 - IntelliHealer provides distribution system optimization models built on `Pyomo <http://www.pyomo.org/documentation>`_,

diff --git a/docs/build/html/_sources/install.rst.txt b/docs/build/html/_sources/install.rst.txt
@@ -19,6 +19,7 @@ Before install ``IntelliHealer``, please install the following dependencies:
 - StableBaseline3 0.11.0a2
 - Pyomo 5.7
 - Cplex 1280
+- Networkx
 
 
 Performance Packages