Merge pull request #1039 from fhswf/rtd_v2.0.0

RTD 2.0.0 #708
fhswf · Aug 12, 2024 · 5ec33c1 · 5ec33c1
2 parents 9ee0f07 + cb483a5
commit 5ec33c1
Show file tree

Hide file tree

Showing 78 changed files with 548 additions and 1,003 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ jobs:
       - name: Generate dependecies list
         run: |
           awk '/^[[]/{f=0} /full/{f=1;next} {sub(/^[ \t]+|[ \t]/, "")} f' setup.cfg | tr -d "<" | tr -d ">" | tr -s "==" "," > doc/rtd/content/01_welcome/sub/deps.txt
-          # awk '/^[[]/{f=0} /full/{f=1;next} {sub(/^[ \t]+|[ \t]/, "")} f' setup.cfg > requirements.txt
+#          awk '/^[[]/{f=0} /full/{f=1;next} {sub(/^[ \t]+|[ \t]/, "")} f' setup.cfg > requirements.txt
 
       - name: Commit files
         id: auto-commit-action

diff --git a/doc/rtd/content/03_machine_learning/mlpro_oa/main.rst b/doc/rtd/content/03_machine_learning/mlpro_oa/main.rst
@@ -2,7 +2,9 @@
 MLPro-OA - Online Adaptivity
 ============================
 
-This framework addresses topics of online machine learning and is currently in progress.
+This framework addresses topics of online machine learning and is already implemented and ready to be used by early adopters. The 
+documentation is still in preparation but the API description is already done. Just browse through the menu structure and follow 
+the links provided...
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/rtd/content/03_machine_learning/mlpro_oa/sub/03_oa_stream_processing.rst b/doc/rtd/content/03_machine_learning/mlpro_oa/sub/03_oa_stream_processing.rst
@@ -2,7 +2,7 @@
 Online Adaptive Stream Processing
 =================================
 
-Further descriptions coming soon...
+Description under contruction. Please consider the cross reference for first technical information.
 
 
 **Learn more**
@@ -15,5 +15,7 @@ Further descriptions coming soon...
 
 
 **Cross Reference**
-
-...
+  - :ref:`Howtos MPro-OA <target_appendix1_OA>`
+  - :ref:`API Reference: MLPro-OA <target_api_oa_streams>`
+  - :ref:`API Reference: MLPro-OA Pool of Objects <target_api_pool_oa_streams>`
+  - :ref:`Basics of stream processing in MLPro <target_bf_streams>`
diff --git a/...ices/appendix1/sub/mlpro_oa/01_oa_dsp.rst → ...ces/appendix1/sub/mlpro_oa/01_streams.rst b/...ices/appendix1/sub/mlpro_oa/01_oa_dsp.rst → ...ces/appendix1/sub/mlpro_oa/01_streams.rst
diff --git a/...1/sub/mlpro_oa/oa_dsp/howto_oa_pp_009.rst → .../sub/mlpro_oa/streams/howto_oa_pp_009.rst b/...1/sub/mlpro_oa/oa_dsp/howto_oa_pp_009.rst → .../sub/mlpro_oa/streams/howto_oa_pp_009.rst
diff --git a/...lpro_oa/oa_dsp/images/howto_oa_pp_009.gif → ...pro_oa/streams/images/howto_oa_pp_009.gif b/...lpro_oa/oa_dsp/images/howto_oa_pp_009.gif → ...pro_oa/streams/images/howto_oa_pp_009.gif
diff --git a/...ndices/appendix2/sub/core/01_mlpro.bf.rst → ...ndices/appendix2/sub/core/10_mlpro.bf.rst b/...ndices/appendix2/sub/core/01_mlpro.bf.rst → ...ndices/appendix2/sub/core/10_mlpro.bf.rst
diff --git a/...ndices/appendix2/sub/core/02_mlpro.sl.rst → ...ndices/appendix2/sub/core/20_mlpro.sl.rst b/...ndices/appendix2/sub/core/02_mlpro.sl.rst → ...ndices/appendix2/sub/core/20_mlpro.sl.rst
diff --git a/...ndices/appendix2/sub/core/03_mlpro.oa.rst → ...ndices/appendix2/sub/core/30_mlpro.oa.rst b/...ndices/appendix2/sub/core/03_mlpro.oa.rst → ...ndices/appendix2/sub/core/30_mlpro.oa.rst
diff --git a/...ndices/appendix2/sub/core/04_mlpro.rl.rst → ...ndices/appendix2/sub/core/40_mlpro.rl.rst b/...ndices/appendix2/sub/core/04_mlpro.rl.rst → ...ndices/appendix2/sub/core/40_mlpro.rl.rst
diff --git a/...ndices/appendix2/sub/core/05_mlpro.gt.rst → ...ndices/appendix2/sub/core/50_mlpro.gt.rst b/...ndices/appendix2/sub/core/05_mlpro.gt.rst → ...ndices/appendix2/sub/core/50_mlpro.gt.rst
diff --git a/doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/01_streams.rst b/doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/01_streams.rst
@@ -1,8 +1,8 @@
 .. _target_api_oa_streams:
-OA-STREAMS - Online Adaptive Stream Processing
-==============================================
+OA Stream Processing
+====================
 
-.. image:: images/01_environments/MLPro-OA-Proc_class_diagram.drawio.png
+.. image:: streams/images/MLPro-OA-Stream-Processing_class_diagram.drawio.png
    :scale: 50%
 
 .. automodule:: mlpro.oa.streams.basics

diff --git a/doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/02_systems.rst b/doc/rtd/content/99_appendices/appendix2/sub/core/mlpro_oa/02_systems.rst
@@ -1,9 +1,12 @@
 .. _target_api_oa_systems:
-OA-SYSTEMS - Online Adaptive Systems
-====================================
+OA Systems
+==========
 
-.. toctree::
-   :maxdepth: 2
-   :glob:
+.. image:: systems/images/MLPro-OA-Systems_OASystems.drawio.png
+   :scale: 50%
 
-   systems/*
+.. automodule:: mlpro.oa.systems.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
diff --git a/...d/content/99_appendices/appendix2/sub/core/mlpro_oa/streams/01_stream_basic.rst b/...d/content/99_appendices/appendix2/sub/core/mlpro_oa/streams/01_stream_basic.rst
diff --git a/...d/content/99_appendices/appendix2/sub/core/mlpro_oa/streams/02_stream_tasks.rst b/...d/content/99_appendices/appendix2/sub/core/mlpro_oa/streams/02_stream_tasks.rst
diff --git a/...x2/sub/core/mlpro_oa/streams/images/.$MLPro-OA-Stream-Processing_class_diagram.drawio.bkp b/...x2/sub/core/mlpro_oa/streams/images/.$MLPro-OA-Stream-Processing_class_diagram.drawio.bkp
diff --git a/...2/sub/core/mlpro_oa/streams/images/.$MLPro-OA-Stream-Processing_class_diagram.drawio.dtmp b/...2/sub/core/mlpro_oa/streams/images/.$MLPro-OA-Stream-Processing_class_diagram.drawio.dtmp
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2024-08-11T14:31:06.860Z" 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="eX0wdet53NV2b0WNfKTy" 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>