Merge pull request #1143 from fhswf/final_changes_v2.0.0

Final changes in v2.0.0 (7)
fhswf · Feb 28, 2025 · a707caa · a707caa
2 parents a31b993 + fd35fd0
commit a707caa
Show file tree

Hide file tree

Showing 73 changed files with 522 additions and 1,191 deletions.
diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_bf/10_layer0_elementary.rst b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_bf/10_layer0_elementary.rst
@@ -1,5 +1,5 @@
 .. _target_api_bf_l0:
-Layer 0 - Elementary Functions
+Layer 0 - Elementary functions
 ==============================
 
 .. toctree::

diff --git a/.../content/99_appendices/appendix2/sub/mlpro_bf/40_layer3_application_support.rst b/.../content/99_appendices/appendix2/sub/mlpro_bf/40_layer3_application_support.rst
@@ -1,5 +1,5 @@
 .. _target_api_bf_l3:
-Layer 3 - Application Support
+Layer 3 - Application support
 =============================
 
 .. toctree::

diff --git a/...rtd/content/99_appendices/appendix2/sub/mlpro_bf/50_layer4_machine_learning.rst b/...rtd/content/99_appendices/appendix2/sub/mlpro_bf/50_layer4_machine_learning.rst
@@ -1,5 +1,5 @@
 .. _target_api_bf_l4:
-Layer 4 - Machine Learning
+Layer 4 - Machine learning
 ==========================
 
 .. toctree::

diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/10_dg.rst b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/10_dg.rst
@@ -1,6 +1,6 @@
 .. _target_api_gt_dg:
-Dynamic Games
-=======================
+MLPro-GT-DynamicGames - Dynamic games
+=====================================
 
 .. image:: images/MLPro-GT_class_diagram.drawio.png
    :scale: 50%

diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/20_native.rst b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/20_native.rst
@@ -1,6 +1,6 @@
 .. _target_api_gt_native:
-Native GT
-=======================
+MLPro-GT-Native - Native game theory
+====================================
 
 .. image:: images/MLPro-GT-Native_class_diagram.drawio.png
    :scale: 50%

diff --git a/.../content/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT-Native_class_diagram.drawio b/.../content/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT-Native_class_diagram.drawio
diff --git a/...pendices/appendix2/sub/mlpro_gt/images/MLPro-GT-Native_class_diagram.drawio.png b/...pendices/appendix2/sub/mlpro_gt/images/MLPro-GT-Native_class_diagram.drawio.png
diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT_class_diagram.drawio b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT_class_diagram.drawio
@@ -1,6 +1,6 @@
-<mxfile host="Electron" modified="2023-09-25T09:09:57.393Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.7.5 Chrome/114.0.5735.289 Electron/25.8.1 Safari/537.36" etag="t94_so88YHJGF0YCU8_P" version="21.7.5" type="device">
+<mxfile host="Electron" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/26.0.16 Chrome/132.0.6834.196 Electron/34.2.0 Safari/537.36" version="26.0.16">
   <diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
-    <mxGraphModel dx="1687" dy="1125" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="2336" pageHeight="1654" math="0" shadow="0">
+    <mxGraphModel dx="2884" dy="1237" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="2336" pageHeight="1654" math="0" shadow="0">
       <root>
         <mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
         <mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
@@ -161,7 +161,7 @@
         <mxCell id="txXCzBs2dMcAB43p3r7v-26" value="C_NAME = &#39;GT&#39;" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="txXCzBs2dMcAB43p3r7v-25" vertex="1">
           <mxGeometry y="26" width="260" height="26" as="geometry" />
         </mxCell>
-        <mxCell id="GUk3ROs5eLHXGbxJfvZo-4" value="C_CLS_RESULTS = GTTrainingResults" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" vertex="1" parent="txXCzBs2dMcAB43p3r7v-25">
+        <mxCell id="GUk3ROs5eLHXGbxJfvZo-4" value="C_CLS_RESULTS = GTTrainingResults" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="txXCzBs2dMcAB43p3r7v-25" vertex="1">
           <mxGeometry y="52" width="260" height="26" as="geometry" />
         </mxCell>
         <mxCell id="txXCzBs2dMcAB43p3r7v-27" value="" style="line;html=1;strokeWidth=1;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" parent="txXCzBs2dMcAB43p3r7v-25" vertex="1">
@@ -199,7 +199,7 @@
         <mxCell id="txXCzBs2dMcAB43p3r7v-37" value="compute_action(p_state:State,&#xa;                           p_action_leaders=False): Action" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="txXCzBs2dMcAB43p3r7v-30" vertex="1">
           <mxGeometry y="346" width="280" height="44" as="geometry" />
         </mxCell>
-        <mxCell id="txXCzBs2dMcAB43p3r7v-38" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endArrow=classic;endFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="txXCzBs2dMcAB43p3r7v-39" target="txXCzBs2dMcAB43p3r7v-30" edge="1">
+        <mxCell id="txXCzBs2dMcAB43p3r7v-38" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;endArrow=block;endFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="txXCzBs2dMcAB43p3r7v-39" target="txXCzBs2dMcAB43p3r7v-30" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
         <mxCell id="txXCzBs2dMcAB43p3r7v-39" value="GTMultiPlayer_SG&#xa;(MultiPlayer)" style="swimlane;fontStyle=3;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=38;horizontalStack=0;resizeParent=1;resizeLast=0;collapsible=1;marginBottom=0;rounded=0;shadow=1;strokeWidth=1;fillColor=#dae8fc;strokeColor=#6c8ebf;swimlaneFillColor=#ffffff;gradientColor=#FFFFFF;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
@@ -222,18 +222,18 @@
         <mxCell id="txXCzBs2dMcAB43p3r7v-44" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0.482;entryY=1.007;entryDx=0;entryDy=0;entryPerimeter=0;endArrow=block;endFill=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="txXCzBs2dMcAB43p3r7v-40" target="txXCzBs2dMcAB43p3r7v-23" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
-        <mxCell id="GUk3ROs5eLHXGbxJfvZo-0" value="GTTrainingResults (rl.RLTrainingResults)" style="swimlane;fontStyle=3;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeLast=0;collapsible=1;marginBottom=0;rounded=0;shadow=1;strokeWidth=1;fillColor=#dae8fc;strokeColor=#6c8ebf;gradientColor=#ffffff;swimlaneFillColor=#ffffff;" vertex="1" parent="WIyWlLk6GJQsqaUBKTNV-1">
+        <mxCell id="GUk3ROs5eLHXGbxJfvZo-0" value="GTTrainingResults (rl.RLTrainingResults)" style="swimlane;fontStyle=3;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeLast=0;collapsible=1;marginBottom=0;rounded=0;shadow=1;strokeWidth=1;fillColor=#dae8fc;strokeColor=#6c8ebf;gradientColor=#ffffff;swimlaneFillColor=#ffffff;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
           <mxGeometry x="810" y="757" width="260" height="70" as="geometry">
             <mxRectangle x="230" y="140" width="160" height="26" as="alternateBounds" />
           </mxGeometry>
         </mxCell>
-        <mxCell id="GUk3ROs5eLHXGbxJfvZo-1" value="C_NAME = &#39;GT&#39;" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" vertex="1" parent="GUk3ROs5eLHXGbxJfvZo-0">
+        <mxCell id="GUk3ROs5eLHXGbxJfvZo-1" value="C_NAME = &#39;GT&#39;" style="text;align=left;verticalAlign=top;spacingLeft=4;spacingRight=4;overflow=hidden;rotatable=0;points=[[0,0.5],[1,0.5]];portConstraint=eastwest;" parent="GUk3ROs5eLHXGbxJfvZo-0" vertex="1">
           <mxGeometry y="26" width="260" height="26" as="geometry" />
         </mxCell>
-        <mxCell id="GUk3ROs5eLHXGbxJfvZo-2" value="" style="line;html=1;strokeWidth=1;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" vertex="1" parent="GUk3ROs5eLHXGbxJfvZo-0">
+        <mxCell id="GUk3ROs5eLHXGbxJfvZo-2" value="" style="line;html=1;strokeWidth=1;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;" parent="GUk3ROs5eLHXGbxJfvZo-0" vertex="1">
           <mxGeometry y="52" width="260" height="8" as="geometry" />
         </mxCell>
-        <mxCell id="GUk3ROs5eLHXGbxJfvZo-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="txXCzBs2dMcAB43p3r7v-28" target="GUk3ROs5eLHXGbxJfvZo-1">
+        <mxCell id="GUk3ROs5eLHXGbxJfvZo-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;endArrow=block;endFill=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="txXCzBs2dMcAB43p3r7v-28" target="GUk3ROs5eLHXGbxJfvZo-1" edge="1">
           <mxGeometry relative="1" as="geometry" />
         </mxCell>
       </root>

diff --git a/...t/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT_class_diagram.drawio.png b/...t/99_appendices/appendix2/sub/mlpro_gt/images/MLPro-GT_class_diagram.drawio.png
diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_oa/01_streams.rst b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_oa/01_streams.rst
@@ -1,6 +1,6 @@
 .. _target_api_oa_streams:
-Online-adaptive data stream processing
-======================================
+MLPro-OA-Streams - Online-adaptive data stream processing
+=========================================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/doc/rtd/content/99_appendices/appendix2/sub/mlpro_oa/02_systems.rst.off b/doc/rtd/content/99_appendices/appendix2/sub/mlpro_oa/02_systems.rst.off
@@ -1,6 +1,6 @@
 .. _target_api_oa_systems:
-Online-adaptive state-based systems
-===================================
+MLPro-OA-Systems - Online-adaptive state-based systems
+======================================================
 
 .. toctree::
    :maxdepth: 2

diff --git a/...nomaly_detection/30_anomaly_detectors.rst → ...mlpro_oa/streams/30_anomaly_detection.rst b/...nomaly_detection/30_anomaly_detectors.rst → ...mlpro_oa/streams/30_anomaly_detection.rst
@@ -2,35 +2,26 @@
 Anomaly detection
 =================
 
-.. image:: images/MLPro-OA-Anomaly-Detectors_class_diagram.drawio.png
+.. image:: 30_anomaly_detection/images/MLPro-OA-Anomaly-Detectors_class_diagram.drawio.png
    :scale: 50%
 
 
-Template for anomaly detectors
-------------------------------
-
 .. automodule:: mlpro.oa.streams.tasks.anomalydetectors.basics
    :members:
    :undoc-members:
    :private-members:
    :show-inheritance:
 
 
-Template for anomalies
-----------------------
-
 .. automodule:: mlpro.oa.streams.tasks.anomalydetectors.anomalies.basics
    :members:
    :undoc-members:
    :private-members:
    :show-inheritance:
 
 
-Concrete anomalies and algorithms
----------------------------------
-
 .. toctree::
    :maxdepth: 2
    :glob:
 
-   anomaly_detectors/*
+   30_anomaly_detection/*
diff --git a/...ces/appendix2/sub/mlpro_oa/streams/30_anomaly_detection/10_common_anomalies.rst b/...ces/appendix2/sub/mlpro_oa/streams/30_anomaly_detection/10_common_anomalies.rst
diff --git a/...dices/appendix2/sub/mlpro_oa/streams/30_anomaly_detection/10_instance_based.rst b/...dices/appendix2/sub/mlpro_oa/streams/30_anomaly_detection/10_instance_based.rst
@@ -0,0 +1,28 @@
+.. _target_api_oa_stream_tasks_ad_ib:
+Instance-based anomalies and detectors
+======================================
+
+
+.. image:: 10_instance_based/images/MLPro-OA-Anomaly-Detectors-IB_class_diagram.drawio.png
+   :scale: 50%
+
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.instancebased.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.anomalies.instancebased.basics
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+
+   10_instance_based/*
diff --git a/...mlpro_oa/streams/30_anomaly_detection/10_instance_based/10_common_anomalies.rst b/...mlpro_oa/streams/30_anomaly_detection/10_instance_based/10_common_anomalies.rst
@@ -0,0 +1,23 @@
+.. _target_api_oa_stream_tasks_ad_common_anomalies:
+Common anomalies
+================
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.anomalies.instancebased.point
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.anomalies.instancebased.group
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
+
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.anomalies.instancebased.contextual
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance:
diff --git a/...lpro_oa/streams/30_anomaly_detection/10_instance_based/20_common_algorithms.rst b/...lpro_oa/streams/30_anomaly_detection/10_instance_based/20_common_algorithms.rst
@@ -0,0 +1,9 @@
+.. _target_api_oa_stream_tasks_ad_common_algorithms:
+Common algorithms
+================= 
+
+.. automodule:: mlpro.oa.streams.tasks.anomalydetectors.instancebased.detectors_point_group
+   :members:
+   :undoc-members:
+   :private-members:
+   :show-inheritance: