Temporary fix of User Interaction data passing (#120)

* Temporary fix of GUI output * DOC: fix wrong Python version, warnings when building docs * FIX: replace basic_usage with loop_demo in user_guide.rst --------- Co-authored-by: Teemu Ruokolainen <[email protected]>
AaltoPML · Dec 8, 2023 · e55900b · e55900b
1 parent d6830e5
commit e55900b
Show file tree

Hide file tree

Showing 8 changed files with 146 additions and 9 deletions.
diff --git a/docs/source/development.md b/docs/source/development.md
@@ -3,7 +3,7 @@
 ## Clone repository
 
 To get started with development, clone the VAI-lab repository and change directory
-```bash,
+```bash
 git clone https://github.com/AaltoPML/VAI-lab.git && cd VAI-lab
 ```
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,7 +19,6 @@ Contents
    Installation <installation>
    User Guide <user_guide>
    Development <development>
-   Documentation <documentation>   
    Contributing <contributing>
 
 
diff --git a/docs/source/installation.md b/docs/source/installation.md
@@ -2,7 +2,7 @@
 
 ## Requirements
 
-- Python 3.10+
+- Python 3.11+
 
 ## Install from PyPi
 
@@ -18,7 +18,7 @@ conda env create --name vai-lab python=3.10 pip && conda activate vai-lab && pyt
 ## Install from source 
 
 Clone this repository and change directory
-```bash,
+```bash
 git clone https://github.com/AaltoPML/VAI-lab.git && cd VAI-lab
 ```
 Install into a [virtual environment](https://docs.python.org/3/library/venv.html)

diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -55,7 +55,7 @@ Pre-made `examples <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/ex
 Some basic use-cases are provided among many others:
  - `user_feedback_demo.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/user_feedback_demo.xml>`_ Demonstrates manual image classification of chest X-rays
  - `canvas_demo.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/canvas_demo.xml>`_ Launches the canvas state-action pair visualiser and editor
- - `regression_demo.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/regression_demo.xml>`_ Demonstrates simple linear regression on a small set of sample data
+ - `regression_demo.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/ridge_regression_demo.xml>`_ Demonstrates simple linear regression on a small set of sample data
 
 Launching examples:
 ^^^^^^^^^^^^^^^^^^^
@@ -197,7 +197,7 @@ Loops
 
 Loop tags are used to iterate over a given set of modules until a condition is met. Loops can be nested and named.  
 
-See `basic_operation.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/basic_operation.xml>`_ for full example.
+See `loop_demo.xml <https://github.com/AaltoPML/VAI-lab/tree/main/src/vai_lab/examples/xml_files/loop_demo.xml>`_ for full example.
 Current options:
 
  - ``type``: what variety of loop will this be: ``for``, ``while``, ``manual`` (user defined stopping condition on-the-fly)

diff --git a/src/vai_lab/Core/vai_lab_core.py b/src/vai_lab/Core/vai_lab_core.py
@@ -69,7 +69,6 @@ def _execute_module(self, specs):
         self._load_data(specs, specs["name"])
         mod.set_options(specs)
         if specs["name"] == 'User Interaction':
-            mod._load_plugin(specs["plugin"]["plugin_name"])
             mod.set_data_in(self.data[specs["name"]])
         else:
             mod._load_plugin(self.data[specs["name"]])
@@ -79,7 +78,11 @@ def _execute_module(self, specs):
                 + "processing..."
               )
         mod.launch()
-        self.data[specs["name"]] = mod.get_result()
+
+        if type(mod.get_result()) is Data:
+            self.data[specs["name"]] = mod.get_result()
+        else:
+            self.data[specs["name"]].import_existing_data(specs["name"], self.data)
 
     def _execute_loop(self, specs):
         if  hasattr(self,"_execute_{}_loop".format(specs["type"])):

diff --git a/src/vai_lab/GUI/GUI_core.py b/src/vai_lab/GUI/GUI_core.py
@@ -1,6 +1,7 @@
 from vai_lab.Data.xml_handler import XML_handler
 from vai_lab._import_helper import import_plugin_absolute
 from vai_lab._types import DataInterface, PluginSpecsInterface, DictT
+from vai_lab.Data.Data_core import Data
 
 from typing import Any
 import tkinter as tk
@@ -165,4 +166,4 @@ def get_result(self):
         This is due to the way this module is constructed, it cycles through plugins, 
         which is useful for the startpage, but complicates things when running
         UserInterface plugins"""
-        return self.output_data
+        return self.output_data[-1] #self.output_data[-1][0]
diff --git a/src/vai_lab/examples/xml_files/loop_demo.xml b/src/vai_lab/examples/xml_files/loop_demo.xml
@@ -0,0 +1,58 @@
+<pipeline>
+    <Initialiser name="Initialiser">
+        <relationships>
+            <child name="User Interaction" />
+        </relationships>
+        <coordinates>
+            [(350.0, 50), 0, {}]
+        </coordinates>
+        <inputdata>
+            <X file="./examples/state-action/X_data.csv" />
+        </inputdata>
+    </Initialiser>
+    <loop type="For" condition="2" name="loop0">
+        <relationships>
+            <child name="User Interaction" />
+        </relationships>
+        <coordinates>
+            (129.0, 193.0, 547.0, 514.0)
+        </coordinates>
+        <UserInteraction name="User Interaction">
+            <inputdata>
+                <X module="Initialiser" />
+            </inputdata>
+            <relationships>
+                <parent name="Initialiser" />
+                <parent name="loop0" />
+                <child name="Output" />
+            </relationships>
+            <coordinates>
+                [(350.0, 350.0), 2, {0: 'd0-u2'}]
+            </coordinates>
+            <plugin type="CanvasInput">
+                <options />
+            </plugin>
+        </UserInteraction>
+    </loop>
+    <Output name="Output">
+        <inputdata>
+            <X module="User Interaction" />
+        </inputdata>
+        <relationships>
+            <parent name="User Interaction" />
+        </relationships>
+        <coordinates>
+            [(350.0, 650), 1, {2: 'd2-u1'}]
+        </coordinates>
+        <plugin type="Output">
+            <options>
+                <outdata>
+                    User Interaction
+                </outdata>
+                <outpath>
+                     .\examples\results\output.pkl
+                </outpath>
+            </options>
+        </plugin>
+    </Output>
+</pipeline>
diff --git a/src/vai_lab/examples/xml_files/ridge_regression_demo.xml b/src/vai_lab/examples/xml_files/ridge_regression_demo.xml
@@ -0,0 +1,76 @@
+<pipeline>
+    <Initialiser name="Initialiser">
+        <relationships>
+            <child name="Modelling" />
+        </relationships>
+        <coordinates>
+            [(350.0, 50), 0, {}]
+        </coordinates>
+        <inputdata>
+            <X file="./examples/supervised_regression/X_tr.csv" />
+            <Y file="./examples/supervised_regression/Y_tr.csv" />
+            <X_test file="./examples/supervised_regression/X_tst.csv" />
+            <Y_test file="./examples/supervised_regression/Y_tst.csv" />
+        </inputdata>
+    </Initialiser>
+    <Modelling name="Modelling">
+        <inputdata>
+            <X module="Initialiser" />
+        </inputdata>
+        <relationships>
+            <parent name="Initialiser" />
+            <child name="Output" />
+        </relationships>
+        <coordinates>
+            [(350.0, 350.0), 2, {0: 'd0-u2'}]
+        </coordinates>
+        <plugin type="RidgeRegression">
+            <options>
+                <alpha>
+                     0.02
+                </alpha>
+            </options>
+            <method type="fit">
+                <options>
+                    <X>
+                         X
+                    </X>
+                    <y>
+                         Y
+                    </y>
+                </options>
+            </method>
+            <method type="score">
+                <options>
+                    <X>
+                         X_test
+                    </X>
+                    <y>
+                         Y_test
+                    </y>
+                </options>
+            </method>
+        </plugin>
+    </Modelling>
+    <Output name="Output">
+        <inputdata>
+            <X module="Modelling" />
+        </inputdata>
+        <relationships>
+            <parent name="Modelling" />
+        </relationships>
+        <coordinates>
+            [(350.0, 650), 1, {2: 'd2-u1'}]
+        </coordinates>
+        <plugin type="Output">
+            <options>
+                <outdata>
+                    Modelling
+                </outdata>
+                <outpath>
+                     .\examples\results\output.pkl
+                </outpath>
+            </options>
+        </plugin>
+    </Output>
+</pipeline>