BF: Basics of closed-loop control #1046

doc/rtd/content/02_basic_functions/mlpro_bf/sub/layer3_application_support/04_control.rst

@@ -0,0 +1,20 @@
+.. _target_bf_control:
+Closed-loop Control
+===================
+
+...
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   control/*
+
+
+**Cross Reference**
+
+- :ref:`API Reference BF-Control <target_api_bf_control>`
+- :ref:`API Reference BF-Control Pool Objects <target_pool_bf_control>`
+- :ref:`BF-Systems - Basics of State-based Systems <target_bf_systems>`

doc/rtd/content/03_machine_learning/mlpro_oa/sub/05_oa_control.rst

@@ -0,0 +1,22 @@
+.. _target_oa_control:
+Online Adaptive Control
+=======================
+
+Further descriptions coming soon...
+
+
+**Learn more**
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   oa_control/*
+
+
+**Cross Reference**
+
+- :ref:`Howtos OA-Control <target_howto_oa_control>`
+- :ref:`API Reference OA-Control <target_api_oa_control>`
+- :ref:`API Reference OA-Control Pool Objects <target_api_pool_oa_control>`
+- :ref:`BF-Control - Basics of Closed-loop Control <target_bf_control>`

doc/rtd/content/99_appendices/appendix1/sub/mlpro_bf/layer3_application_support/04_control.rst

@@ -0,0 +1,8 @@
+Closed-loop Control
+===================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   control/*      

doc/rtd/content/99_appendices/appendix1/sub/mlpro_oa/03_control.rst

@@ -0,0 +1,9 @@
+.. _target_howto_oa_control:
+Online Adaptive Control
+=======================
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   control/* 

doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_bf/layer3_application_support/05_control.rst

@@ -0,0 +1,12 @@
+.. _target_api_bf_control:
+BF-CONTROL - Closed-loop Control
+================================
+
+.. image:: images/MLPro-BF-Control_class_diagram.drawio.png
+   :scale: 50%
+
+.. automodule:: mlpro.bf.control.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:

doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/03_control.rst

@@ -0,0 +1,12 @@
+.. _target_api_oa_control:
+OA Control
+==========
+
+.. image:: control/images/MLPro-OA-Control.drawio.png
+   :scale: 50%
+
+.. automodule:: mlpro.oa.control.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:

doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/control/images/MLPro-OA-Control_class_diagram.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2024-08-11T14:31:04.131Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/20.7.4 Chrome/106.0.5249.199 Electron/21.3.3 Safari/537.36" etag="7Db_ZHueusMjEtbRuxTG" version="20.7.4" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7V1bd6I6FP41rtNz1tLFRSk+eutlxl7tTGf6wooQlBYIE6Ct8+tPAgFBotKKjtNquyqEkMv+vr2THTZpTe45r6cYeNMLZEC7JgnGa03u1yRJUttN8kVTZnGKKMlKnDLBlsHS5gkj6zdkiQJLDS0D+rmMAUJ2YHn5RB25LtSDXBrAGL3ks5nIztfqgQksJIx0YBdT7y0jmLKOyUk36IUzaE2mSdVKi3XZAUlu1hV/Cgz0kkmSBzW5hxEK4iPntQdtKr5EMPfns3t7+KScfrnxf4Fv3a93l9/rcWEnb7kl7QOGbvDuoi97TfTUvvDb96p90wzML/bDST3tWzBLJAYNIkB2inAwRRPkAnswT+1iFLoGpMUK5GyeZ4iQRxJFkvgIg2DG2ADCAJGkaeDY7KqJ3KCHbISjGuWTE4F8SDp0jQ7FnCSPbaQ/xUknlp3cWFIQTGA+CrHOekWg0y7qBpbvv33/oSNHnF1pSb4A4AkMVkhJZGShosnQisn5FCIHBnhGMmBog8B6znMPMApP0nxzlMgBA4oP2qpmPwM7ZDVdde6A/1SjaJKmyiIV5tHYbPgBhsDxG6PoO85D6hTIJcduROr+b4EA/ovl2MCFDKiECzI5B7Y1ccmxTuQPCXrdZ4gDi2hbh10IKAO6+tSyjSGYoZBK1Q+A/pScdacIW79JsSDBlFzGAaNKU8jlGNE7Gc0w9Eme6wR6MU0aAj9geXRk28DzrXHUYJrFIdBabhcFAXKSgnLsTZU6bgpGT6mdiJhKuJdhqgGgauppzswVRVfh2KRXmPRO8nea0Ydcn2BgWHCB//TzZnpT2cPXlXxkV5VjpuaJFW+z85e5SZQFljbNWENZFZZzmFV3S8w2cCdE5Gl9pLB8fc1ifaLCqU9S8tUBm9DMBQHsUtD8guakXS2lTKYxuxaD+27fvDY179fpTd3o1aV2QZt62t3P60GtJ9U6AtUpmij8c9WpUwX6p6AvBIQgoxs2NIOlmuF7QLfcyTDK02/OU26ZEGgSIveadsTKqWUY0I1YG4AAxMSmvPWQ5QaRlFpd8kva2RMarVqrTxW81RXn5+SXZseEcS6hLbAibkGiNS+Qag6HdSutznrWMdQ5oHNJtgh6ZXZSKiBbwM62IjuXGZuKNmANsA6BKBoWGZJ30SBYFwtoy0W0ZQ6yNhhD+xr5VmAhWj6O8y4g/qdAVZRyoKqbY/rUtr413SYIhZkmzsbWTXdYZ3OcLKaaZrlWoGlHscJ6mgscGKltJ8Iapyp8iQjYdPxLx8i5jm9w4GmY2D+oOYBK8GJIrUSjp912Lk8H2t3Z7aDT30qtwABpN8dkTp328w6H2+nnODRNiDU66qY1U+YlFQtbqfXZ8kOig5k6c709Aba/ne7aaEImD5O0piGaEFyHV6daZzjcQo3//edpTy9kxkIGOqE4L/vbx5nsrN+AJgjtbRqq42Y5QyUK7c1N1UvPmCDTmz3W23LYEUeP7qjPMVVEY73giHaX2Cw/SPl8Tk76FvF+IxoQ5IU64dYkFg9j+4EMG5BBVOWSc5Hjzcnw9dpTz64fu1/Gr2fuhdJxH69U3rgVsUHzMDz6dIjXqPQFodfbIubpEtQu5p8QPT1eW8aZftZyTgeDwan74yvHT9cWLIDmwpecFQCuDmPjfyBE5YSQS85dt0aIpUYAQ9INH2aIES/EHoixE2Io0u6IwR0dllkKzUN+cBgetgK6qu4O9B7G2lT4ct9H47uHm689/Bp+5SxPkD4i7ES+joZcjRgFlw0W0aFGiouWb6t2PKo6SNqJxo/0WU7qrpmNKN1vDOjXwbnZmLyyWNK7SdbgNiFvU68/WOeDQHSNh+vuzPTDqwveUJZhb0za9BSnPKAP1RqX8/SPTgVmyZas7ldEhlZJMkitzclg6l++j+Wz28H0+HKkP3ecV/iLQ4YCqBOMQq8ogTc930ifEjPcatnnsLznHgn7ly9IN9s8OUkVaA1XUMVxnphyOyFN1MGEN8qvEMUmJGIQxXOeJPjJg/YkTcxeTmYKcdHjHBJJLlphPS6G6qbY9F6LRQzhBLpGlIOVhRdLJ3IYc9Li/iw0pHBzmZR1kjHNvGTW9VThdXRl/3h9IWbG5dbG2klrwpPxUTQ4RoN25ujf5Q1gvV3bCy5c5Bs41Cy6Y9+LxVFMWtatXLZz2jkPowmGvl+q2EqTouqJllgGiJ6C7LYBtxAY1IoEiPwJ6eJyKrMY9rcRNK+6y5B6I//ephVV6GEuJdd4EATYGodBtEBP7KMkEGs5RQZ1XKpD6TJaKvHCsW3p1DbPKz2Jq0sQG9N2WI5nQ4eGKRhvtkpVAvpO+HhVrBRzxiilNZGy2vmmLGSoBpsImBPLnUJsReJeB9IU0L5b/iJMZBDGcDks1WpCrgtaQbaVoslrgvY2HWHsJ9NWMv+JhJXI8yTb9v1RgKJIhfd0Oc+rTPf3gVpL5FCVkS3bWL7/lIlpKOVKvUyJlEfEe6LFvGBA0/KxUgXHRlGisL1CMBSTzUJ0lbkkIqroFax0Mtb7Rdn5vdputLOf5i6n+8UVnj70YBTIJNBZzQJwnPDHDIjL4kISNIcL19O4lLLxK/lQyyj0L/YyROnNKK2NlGQI1kVFkhsi8cOSj5pz2eqSmISgZVBtiQ2hKSrzDwfV1gpQWXOuURy8kLBJaEiCKpBBU41+2rmWiJLQEARZEFvqMfmrCAvRnXGwKStyzptCLa0WIaSgtiTpmP6IyXPqktXEsarrq2kvBOAg0/Rh7hZCNTDL5GArIEvFIwsNJYNTu60sNnxBX+IK3h2sx2OXXFCo83h4oBplYuTsr04JB50q6pQsNWS1qQgyUQPyt7kdlVpdy1s1apbBYJV+VcX55vrFtT8YsU28jL2O2DZVHerciO2x2mq2aIGciOx0brIumrvyuUtOb+T5R1q7kik0svlluai+i8z/u4O5eXJurdeVTxTxu9KcvOHp+Hu4VkH8L7f5ysEabmINTVPiW0NDGSstZV+toSg1pHZ2cnKwhiV05fhgDddRUSlNxb20hurBGm73bb59tIbE5jTk44wnfnywhiV0pfie38EaLjEnf4E15L3K2S4AuoN32YlE8ewHvb/RSk5/Zq/1X1nh8dmstmQxnUUJbfEdePmqVz+xR9O733LbQuaD/fvBTsxP9h34VWFJu38Fnr9vgfgnsH73vgXw1QoyHCFnPxNSkOM5Q+jJLEuXdxBr+/zY0R4J71qlVqX8iKTIuWXpQv6msDL/xsvYq2Sa28DhHuGnKEhxzSYO83zzjRzSmw+bOXy+zRyUsps5SML65fu/aI7HmwGoRc1imzlkt3FItOUzbOWw0v7s5VYO3BbzAmc/7+S9GlD/9FYOUgHTT7uVg24D39fI8IWjYKW4j1edEUv4EJtHHHZT+CMvHFVjK8ruptCuYAC4/S7ehi+jsHU/+tH9Nrt86Hd5+74Aw9ACop/xu0b0iLB5caMzj75fH+fzY7Lblv+530CrhhBiMgvdxZSAP9crTgF2styzxtUv//ZXWbecv22ZXPTLVyFbsVteDPQRFxxpsZ34DWsCbSrbyK0YHEZGUOLcAmyhdV51ku/gQH8+B1oUSu8UUiIA7u/xoLnLeMUnihwHOtGWz+BAr7Y1e+lB85tcIo7wE7nQFcG6Qx+av+rO2TkkdaLp9NdBBkx1l54Qn+viqj/QRucXH8Sx1Ge6DTXbcqzd7ET429q3nQg/sTdTkR6X9W8Tp2MTRb77PtRPyezs+jl8mg2wcDWRBM4Cpw+D0Ds6ILshsmJrh7t+cW10MfBEi7HNGOgKd/XhmeBKi1+2H2tVdi81d4v7XsWuWtyb7APTD6wgq3fCqkpFEqu2TkWUbalIEjyQ992T5XCOux5d2itn/QMEO+6js5663IyrrSS+Yx1XP76rLh4iGrN8W21YNglprMijI6fzfxYUk2D+T5fkwf8=</diagram></mxfile>

doc/rtd/content/99_appendices/appendix2/sub/pool/mlpro_bf/03_bf_control.rst

@@ -0,0 +1,9 @@
+.. _target_pool_bf_control:
+BF-CONTROL - Closed-loop Control
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   bf_control/*

doc/rtd/content/99_appendices/appendix2/sub/pool/mlpro_oa/30_control.rst

@@ -0,0 +1,9 @@
+.. _target_api_pool_oa_control:
+OA Control
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   control/*

src/mlpro/bf/control/basics.py

@@ -0,0 +1,136 @@
+## -------------------------------------------------------------------------------------------------
+## -- Project : MLPro - The integrative middleware framework for standardized machine learning
+## -- Package : mlpro.bf.control
+## -- Module  : basics.py
+## -------------------------------------------------------------------------------------------------
+## -- History :
+## -- yyyy-mm-dd  Ver.      Auth.    Description
+## -- 2024-08-31  0.0.0     DA       Creation 
+## -------------------------------------------------------------------------------------------------
+
+"""
+Ver. 0.0.0 (2024-08-31)
+
+This module provides ...
+"""
+
+
+# from mlpro.bf.various import *
+
+
+
+
+## -------------------------------------------------------------------------------------------------
+## -------------------------------------------------------------------------------------------------
+class Example:
+    """
+    The __init__ method should be documented in the class level docstring and the docstring itself
+    should not go beyond 100 characters length (within the dash separator). Sections inside the 
+    docstring can be seperated like the reStructuredText format.
+    
+    Parameters are documented in the Parameters section.
+    Public attributes of classes are documented inisde Attributes section.
+    Returns attronites are documented in the Returns section.
+    
+    A few examples of data types: int / str / bool / list of str / tuple of int / float / None / dict.
+    If the parameters have default values, you should add "TYPE, optional" as part of the type
+    and "The default is ...." as part of the description.
+    
+    .. _Further_formatting_information: 
+        https://numpydoc.readthedocs.io/en/latest/format.html
+    
+    Notes
+    -----
+        The content inside the section should be indented. 
+    
+    Parameters
+    ----------
+    p_arg1 : str
+        Explanation of the first parameter.
+    p_arg2 : bool
+        Explanation of the second parameter. The default is True.
+        
+    Attributes
+    ----------
+    C_MY_CONSTANT = 'My static value'
+        Explanation of the public constant C_MY_CONSTANT.
+
+    """
+
+    attr1 = None
+
+## -------------------------------------------------------------------------------------------------
+    def __init__( self, 
+                  p_arg1 : str, 
+                  p_arg2 : bool = True ):
+
+        self.attr1 = p_arg1
+        pass
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method(self, p_arg1):
+        """
+        Example on how to document return type. 
+        
+        Notes
+        -----
+            The name of the return value is required for better understanding 
+            of the code. The return value is parsed similarly as parameters 
+            value, meaning that multiple return value is also possible.
+        
+        Parameters
+        ----------
+        p_arg1 : TYPE
+            explanation of the first parameter.
+                
+        Returns
+        -------
+        p_arg1: TYPE
+            Description of the returned value.
+        """
+        return p_arg1
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method_no_return(self, p_arg1):
+        """
+        Example on how to document return type. 
+        
+        Notes
+        -----
+            When there is no item to be returned, the return section is omitted.
+        
+        Parameters
+        ----------
+        p_arg1 : TYPE
+            explanation of the first parameter.
+                
+        """
+        return 
+
+
+
+
+
+## -------------------------------------------------------------------------------------------------
+## -------------------------------------------------------------------------------------------------
+class Example2:
+    """
+    ...
+
+    """
+
+## -------------------------------------------------------------------------------------------------
+    def __init__(self, p_arg1, p_arg2):
+        pass
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method(self, p_arg1):
+        """
+        """
+        pass
+
+
+

src/mlpro/oa/control/basics.py

@@ -0,0 +1,136 @@
+## -------------------------------------------------------------------------------------------------
+## -- Project : MLPro - The integrative middleware framework for standardized machine learning
+## -- Package : mlpro.oa.control
+## -- Module  : basics.py
+## -------------------------------------------------------------------------------------------------
+## -- History :
+## -- yyyy-mm-dd  Ver.      Auth.    Description
+## -- 2024-08-31  0.0.0     DA       Creation 
+## -------------------------------------------------------------------------------------------------
+
+"""
+Ver. 0.0.0 (2024-08-31)
+
+This module provides ...
+"""
+
+
+# from mlpro.bf.various import *
+
+
+
+
+## -------------------------------------------------------------------------------------------------
+## -------------------------------------------------------------------------------------------------
+class Example:
+    """
+    The __init__ method should be documented in the class level docstring and the docstring itself
+    should not go beyond 100 characters length (within the dash separator). Sections inside the 
+    docstring can be seperated like the reStructuredText format.
+    
+    Parameters are documented in the Parameters section.
+    Public attributes of classes are documented inisde Attributes section.
+    Returns attronites are documented in the Returns section.
+    
+    A few examples of data types: int / str / bool / list of str / tuple of int / float / None / dict.
+    If the parameters have default values, you should add "TYPE, optional" as part of the type
+    and "The default is ...." as part of the description.
+    
+    .. _Further_formatting_information: 
+        https://numpydoc.readthedocs.io/en/latest/format.html
+    
+    Notes
+    -----
+        The content inside the section should be indented. 
+    
+    Parameters
+    ----------
+    p_arg1 : str
+        Explanation of the first parameter.
+    p_arg2 : bool
+        Explanation of the second parameter. The default is True.
+        
+    Attributes
+    ----------
+    C_MY_CONSTANT = 'My static value'
+        Explanation of the public constant C_MY_CONSTANT.
+
+    """
+
+    attr1 = None
+
+## -------------------------------------------------------------------------------------------------
+    def __init__( self, 
+                  p_arg1 : str, 
+                  p_arg2 : bool = True ):
+
+        self.attr1 = p_arg1
+        pass
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method(self, p_arg1):
+        """
+        Example on how to document return type. 
+        
+        Notes
+        -----
+            The name of the return value is required for better understanding 
+            of the code. The return value is parsed similarly as parameters 
+            value, meaning that multiple return value is also possible.
+        
+        Parameters
+        ----------
+        p_arg1 : TYPE
+            explanation of the first parameter.
+                
+        Returns
+        -------
+        p_arg1: TYPE
+            Description of the returned value.
+        """
+        return p_arg1
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method_no_return(self, p_arg1):
+        """
+        Example on how to document return type. 
+        
+        Notes
+        -----
+            When there is no item to be returned, the return section is omitted.
+        
+        Parameters
+        ----------
+        p_arg1 : TYPE
+            explanation of the first parameter.
+                
+        """
+        return 
+
+
+
+
+
+## -------------------------------------------------------------------------------------------------
+## -------------------------------------------------------------------------------------------------
+class Example2:
+    """
+    ...
+
+    """
+
+## -------------------------------------------------------------------------------------------------
+    def __init__(self, p_arg1, p_arg2):
+        pass
+
+
+## -------------------------------------------------------------------------------------------------
+    def example_method(self, p_arg1):
+        """
+        """
+        pass
+
+
+