Machine Learning & Artificial Intelligence Plugin #995

bpaul4 · 2022-01-04T21:59:05Z

Building off FOQUS's existing plugin to load custom Pymodel scripts, this tool allows users to import Tensorflow Keras models into FOQUS nodes. As a first draft, the tool enables new flowsheet capabilities using the same UI as the Pymodel plugin:

Users can save Sequential or Functional API Keras models as H5 files, and import into FOQUS nodes for model prediction. The tool will create default variable labels and bounds as needed
Users can follow the documentation workflow and examples to create a CustomLayer class, and the plugin will extract any custom labels/bounds into the Node Editor
Users can specify whether the training utilized data normalization, and the tool will handle needed scaling/unscaling internally (only linear scaling is currently supported)

…bels

…l_ai_plugin_test

This reverts commit 141995c.

Add GUI tests for ML/AI plugin

bpaul4 · 2022-02-24T15:06:54Z

@lbianchi-lbl your tests and CI updates are very well written, and it appears to have resolved all remaining GitHub Actions issues - thank you for your continuous efforts on this task.

@anujad95 @jmorgan29 @MAZamarripa please provide any additional feedback you have on the Plugin code or the new tests so we may merge these updates soon; @anujad95 and I previously tested the tool on our local machines with no issues.

lbianchi-lbl

Following the discussion today during the dev call, we came to the conclusion that making the exception handling more specific could be a low-effort way to make unexpected errors more visible. I've left review comments where I think it would make sense to do this, as well as a few suggestions on the implementation.

lbianchi-lbl · 2022-03-01T21:20:45Z

foqus_lib/framework/graph/node.py

+    import tensorflow as tf
+
+    load = tf.keras.models.load_model
+except:


Suggested change

except:

except ImportError:

# if TensorFlow is not available, create a proxy function that will raise an exception

# whenever code tries to use `load()` at runtime

def load(*args, **kwargs):

raise RuntimeError(f"`load()` was called with args={args}, kwargs={kwargs} but `tensorflow` is not available")

lbianchi-lbl · 2022-03-01T21:28:08Z

foqus_lib/framework/graph/node.py

+        for i in range(np.shape(self.model.inputs[0])[1]):
+            try:
+                input_label = self.model.layers[1].input_labels[i]
+            except:


Suggestions to make exceptions more specific:

Use except MyExceptionType: instead of "bare except

Add a comment with more details on when that exception might occur (e.g. "this happens if the input labels in the model do not match those stored in the file" (just an example))

lbianchi-lbl · 2022-03-01T21:28:57Z

foqus_lib/framework/graph/node.py

+                input_min = 0  # not necessarily a good default
+            try:
+                input_max = self.model.layers[1].input_bounds[input_label][1]
+            except:


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:29:03Z

foqus_lib/framework/graph/node.py

+        for j in range(np.shape(self.model.outputs[0])[1]):
+            try:
+                output_label = self.model.layers[1].output_labels[j]
+            except:


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:29:11Z

foqus_lib/framework/graph/node.py

+                output_label = "z" + str(j + 1)
+            try:
+                output_min = self.model.layers[1].output_bounds[output_label][0]
+            except:


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:29:18Z

foqus_lib/framework/graph/node.py

+                output_min = 0  # not necessarily a good default
+            try:
+                output_max = self.model.layers[1].output_bounds[output_label][1]
+            except:


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:29:25Z

foqus_lib/framework/graph/node.py

+        # check if user passed a model for normalized data - FOQUS will automatically scale/un-scale
+        try:  # if attribute exists, user has specified a model form
+            self.normalized = self.model.layers[1].normalized
+        except:  # otherwise user did not pass a normalized model


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:30:00Z

foqus_lib/framework/graph/node.py

+                        str(self.modelName): getattr(module, str(self.modelName))
+                    },
+                )
+            except:  # try to load model without custom layer


TODO: make except clause more specific (see above for suggestions)

lbianchi-lbl · 2022-03-01T21:32:47Z

foqus_lib/framework/graph/node.py

+                )
+            except:  # try to load model without custom layer
+                self.model = load(str(self.modelName) + ".h5")
+            os.chdir(cwd)  # reset to original working directory


Resetting the working dir inside a finally block ensures that it is always restored, regardless of what exceptions are thrown in the previous lines.

Suggested change

os.chdir(cwd) # reset to original working directory

finally:

os.chdir(cwd) # reset to original working directory

lbianchi-lbl · 2022-03-01T21:34:26Z

foqus_lib/framework/graph/node.py

+            except:  # try to load model without custom layer
+                self.model = load(str(self.modelName) + ".h5")
+            os.chdir(cwd)  # reset to original working directory


See above for exception and os.chdir() handling

lbianchi-lbl

Thanks @bpaul4 for adding the more specific exceptions and especially the detailed messages, I think they're really helpful.

I've left two very minor corrections, and they're completely "take-it-or-leave-it", so feel free to dismiss them and I'm happy to approve either way.

lbianchi-lbl · 2022-03-02T19:02:51Z

foqus_lib/framework/graph/node.py

+    # if TensorFlow is not available, create a proxy function that will raise
+    # an exception whenever code tries to use `load()` at runtime
+    def load(*args, **kwargs):
+        raise RuntimeError(f"`load()` was called with args={args},"


Minor suggestion, but in retrospective ModuleNotFoundError would be a better fit than RuntimeError here.

lbianchi-lbl · 2022-03-02T19:07:09Z

foqus_lib/framework/graph/node.py

@@ -106,15 +109,33 @@ def __init__(self, model):
        for i in range(np.shape(self.model.inputs[0])[1]):
            try:
                input_label = self.model.layers[1].input_labels[i]
-            except:
+            except AttributeError:
+                logging.getLogger("foqus." + __name__).info(


I think these extended messages are great, they add lots of useful context both for users and other developers.

One minor suggestion: instead of repeating the logging.getLogger("foqus." + __name__) each time, you could create a logger object at the module level, e.g. _logger = logging.getLogger("foqus." + __name__) after the import statements on Line 40, and then use that object throughout the rest of the module, i.e. _logger.info(...)

bpaul4 · 2022-03-02T20:23:59Z

Thanks @lbianchi-lbl, I agree with your final two suggestions. I'll make those changes and push again for final approval.

lbianchi-lbl

Looks good!

lbianchi-lbl · 2022-03-03T15:42:22Z

I believe that the last round of reviews and changes covers what we discussed on Tuesday, so I'm going ahead and merge this in. Thanks to all those involved and @bpaul4 in particular for bringing this over the finish line!

bpaul4 and others added 14 commits October 27, 2021 11:31

ML_AI plugin first draft

1ee728c

Updated init/run methods, updated nodePanel/Ui for new model type

6ba10cf

Fixed typing error

5f4044c

Updated nodePanel and session methods for pymodel search

5c98bbc

Addressed pytest errors

a0a55eb

Added modelType, modelName and load_model connections to UI

937d02d

Keras object and layer import, redefined pymodel local variables

5f75eff

Fixed output variable indexing

760dced

Allow plugin to import models with new name, no custom layer or no la…

43f2c03

…bels

Resolving merge conflicts from master

22f695c

ML AI Plugin documentation first draft

987de2a

Added normalization functionality, examples, updated documentation

913775b

Minor documentation fixes

a993b53

Merge branch 'CCSI-Toolset:master' into ml_ai_plugin

d426155

bpaul4 requested review from jmorgan29, MAZamarripa, anujad95 and lbianchi-lbl January 4, 2022 21:59

bpaul4 self-assigned this Jan 4, 2022

bpaul4 added 5 commits January 5, 2022 14:13

Merge branch 'master' of https://github.com/CCSI-Toolset/FOQUS into m…

a7140be

…l_ai_plugin_test

Improvements from testing

064fd28

Running black from main directory

696ec0c

Minor fixes for pylint checks

a24f624

Merge branch 'ml_ai_plugin' of https://github.com/bpaul4/FOQUS into m…

b8614da

…l_ai_plugin_test

ksbeattie added Priority:Normal Normal Priority Issue or PR and removed Priority:Normal Normal Priority Issue or PR labels Jan 11, 2022

lbianchi-lbl added 2 commits February 15, 2022 18:00

Revert "Try waiting for signals instead of dealing with modals"

a46fa00

This reverts commit 141995c.

Try using open() instead of exec() for modal dialog

dd9beb8

bpaul4 marked this pull request as ready for review February 22, 2022 21:18

bpaul4 and others added 4 commits February 22, 2022 13:21

Merge branch 'master' into ml_ai_plugin

b9a8d39

Merge branch 'master' into ml_ai_plugin

359f1d9

Merge remote-tracking branch 'bpaul4/ml_ai_plugin' into ml_ai_plugin

98af321

Restore job dependency

45cd78d

bpaul4 changed the title ~~(draft) Machine Learning & Artificial Intelligence Plugin~~ Machine Learning & Artificial Intelligence Plugin Feb 23, 2022

Merge pull request #1 from lbianchi-lbl/ml_ai_plugin

bc32a0c

Add GUI tests for ML/AI plugin

lbianchi-lbl mentioned this pull request Mar 1, 2022

GUI tests documentation and performance improvements #957

Closed

lbianchi-lbl requested changes Mar 1, 2022

View reviewed changes

bpaul4 added 2 commits March 2, 2022 10:20

Improving exception handling

a4799af

Running black again

285df23

bpaul4 requested a review from lbianchi-lbl March 2, 2022 18:45

lbianchi-lbl reviewed Mar 2, 2022

View reviewed changes

lbianchi-lbl previously approved these changes Mar 2, 2022

View reviewed changes

Minor changes

25c6226

bpaul4 dismissed lbianchi-lbl’s stale review via 25c6226 March 2, 2022 20:35

Merge branch 'master' into ml_ai_plugin

71e9586

bpaul4 requested a review from lbianchi-lbl March 2, 2022 20:40

lbianchi-lbl approved these changes Mar 2, 2022

View reviewed changes

lbianchi-lbl merged commit a3fcb81 into CCSI-Toolset:master Mar 3, 2022

bpaul4 deleted the ml_ai_plugin branch August 18, 2023 16:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Machine Learning & Artificial Intelligence Plugin #995

Machine Learning & Artificial Intelligence Plugin #995

bpaul4 commented Jan 4, 2022

bpaul4 commented Feb 24, 2022

lbianchi-lbl left a comment

lbianchi-lbl Mar 1, 2022 •

edited

Loading

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl Mar 1, 2022

lbianchi-lbl left a comment

lbianchi-lbl Mar 2, 2022

lbianchi-lbl Mar 2, 2022

bpaul4 commented Mar 2, 2022

lbianchi-lbl left a comment

lbianchi-lbl commented Mar 3, 2022

-except:
+except ImportError:
+     # if TensorFlow is not available, create a proxy function that will raise an exception
+     # whenever code tries to use `load()` at runtime
+    def load(*args, **kwargs):
+        raise RuntimeError(f"`load()` was called with args={args}, kwargs={kwargs} but `tensorflow` is not available")

	os.chdir(cwd) # reset to original working directory
	finally:
	os.chdir(cwd) # reset to original working directory

Machine Learning & Artificial Intelligence Plugin #995

Machine Learning & Artificial Intelligence Plugin #995

Conversation

bpaul4 commented Jan 4, 2022

bpaul4 commented Feb 24, 2022

lbianchi-lbl left a comment

Choose a reason for hiding this comment

lbianchi-lbl Mar 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbianchi-lbl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpaul4 commented Mar 2, 2022

lbianchi-lbl left a comment

Choose a reason for hiding this comment

lbianchi-lbl commented Mar 3, 2022

lbianchi-lbl Mar 1, 2022 •

edited

Loading