Highlighted sections for documentation todos

Author: EvertBunschoten

Documentation/source/documentation/datamining/variablegrouping.rst

@@ -20,3 +20,14 @@ Process Diagram
 
 # TODO: describe affinity selection algorithm 
 
+.. _grouping_method_parameters:
+
+Grouping Algorithm Settings 
+---------------------------
+
+# TODO: setters for selection algorithm parameters 
+
+Input-Output Settings
+---------------------
+
+# TODO: methods for accessing group information 

Documentation/source/documentation/machinelearning/FGM.rst

@@ -1,8 +1,40 @@
 .. _mlp_fgm:
 
+.. sectionauthor:: Evert Bunschoten 
+
+
 Machine learning methods for FGM 
 ================================
 
 .. important::
 
-    Documentation in development 
+    Documentation in development 
+
+.. _mlp_fgm_general_process: 
+
+Process Diagram 
+---------------
+
+# TODO: process diagram 
+
+# TODO: describe process on training ML-FGM networks from scratch 
+
+.. _mlp_fgm_loss_function:
+
+Physics-Informed Training Loss Function 
+---------------------------------------
+
+
+# TODO: list variables for which PI terms are defined.
+
+# TODO: formulation of PI penalty functions 
+
+# TODO: modulation of PI penalty terms compared to data-fitting loss 
+
+.. _mlp_fgm_input_output: 
+
+Training Progress and Output:
+-----------------------------
+
+# TODO: describe which files are saved: plots along flamelets, lambda values, thermochemical properties in chemical equilibrium 
+

Documentation/source/documentation/machinelearning/NICFD.rst

@@ -1,8 +1,52 @@
 .. _mlp_nicfd:
 
+.. sectionauthor:: Evert Bunschoten 
+
+
 Machine learning methods for NICFD
 ==================================
 
 .. important::
 
-    Documentation in development 
+    Documentation in development 
+
+.. _mlp_nicfd_general_process: 
+
+Process Diagram 
+---------------
+
+# TODO: process diagram 
+
+# TODO: describe process on training EEoS-PINN networks from scratch 
+
+
+.. _mlp_nicfd_traindata_scaling:
+
+Pre-Processing 
+--------------
+
+# TODO: distinction between state variables and train variables 
+
+# TODO: Setters for scaling methods: distinction between state variables and training variable(s)
+
+
+
+.. _mlp_nicfd_loss_function:
+
+Physics-Informed Training Loss Function 
+---------------------------------------
+
+
+# TODO: Describe entropy-based equation of state
+
+# TODO: Jacobi-based loss function
+
+.. _mlp_nicfd_input_output: 
+
+Training Progress and Output:
+-----------------------------
+
+# TODO: describe which files are saved: thermodynamic state data plots, training loss functions for state variables. 
+
+
+

Documentation/source/documentation/machinelearning/general.rst

@@ -0,0 +1,56 @@
+.. _mlp_general:
+
+.. sectionauthor:: Evert Bunschoten 
+
+General Machine Learning Methods
+================================
+
+.. important::
+
+    Documentation in development 
+
+
+Process Diagram 
+---------------
+
+# TODO: process diagram of general data-fitting process
+
+# TODO: describe general data-fitting training method 
+
+.. _trainmethods:
+
+Training Methods
+----------------
+
+# TODO: describe difference between tensorflowfit and custom trainer 
+
+
+.. _traindata_scaling:
+
+Pre-Processing 
+--------------
+
+# TODO: methods for specifying the controlling variables and training variables.
+
+# TODO: Setters for scaling methods 
+
+
+.. _mlhyperparams: 
+
+Hyper-Parameters:
+-----------------
+
+# TODO:  refer to :ref:`configuration settings <MACHINELEARNING>` for information on machine learning settings 
+
+
+.. _mlinputoutput:
+
+Training Progress and Output:
+-----------------------------
+
+# TODO: describe how training progress can be tracked
+
+
+# TODO: describe which information is saved and where 
+
+

Documentation/source/documentation/machinelearning/hpoptimization.rst

@@ -1,8 +1,12 @@
 .. _hpoptimization:
 
+.. sectionauthor:: Evert Bunschoten 
+
+
 Hyper-Parameter Optimization
 ============================
 
 .. important::
 
-    Documentation in development 
+    Documentation in development 
+

Documentation/source/documentation/machinelearning/index.rst

@@ -2,6 +2,7 @@ Machine Learning Methods
 ========================
 
 .. toctree::
+   general
    FGM
    NICFD
    hpoptimization