Skip to content

Comments

Adds ONNX Surrogate support from OMLT#1308

Merged
andrewlee94 merged 27 commits intoIDAES:mainfrom
avdudchenko:onnx_surrogate
Nov 4, 2024
Merged

Adds ONNX Surrogate support from OMLT#1308
andrewlee94 merged 27 commits intoIDAES:mainfrom
avdudchenko:onnx_surrogate

Conversation

@avdudchenko
Copy link
Contributor

@avdudchenko avdudchenko commented Dec 21, 2023

Fixes

This adds ONNX surrogate model object and slightly refactors the current Keras surrogate model to support multiple omlt model types.

Summary/Motivation:

Currently, if one generates a NN model using PyTorch, or any other method for use in IDAES and depended project (e.g. WaterTAP) we must export the model to ONNX format, and then to keras format to use in IDAES, which makes little sense.

This PR adds native support to onnx model format provided through OMLT.

Changes proposed in this PR:

-move out part of Keras functions into omlt_surrogate_base.py to enable simple support for multiple omlt import types
-adds ONNXSurrogate object that can load onnx model directly in IDAES flowsheet block

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@avdudchenko avdudchenko marked this pull request as ready for review December 21, 2023 06:22
@ksbeattie ksbeattie added WaterTAP Priority:Normal Normal Priority Issue or PR labels Dec 21, 2023
@avdudchenko avdudchenko changed the title Addes ONNX Surrogate support from OMLT Adds ONNX Surrogate support from OMLT Jan 4, 2024
@avdudchenko avdudchenko requested a review from eslickj as a code owner January 4, 2024 19:41
@avdudchenko avdudchenko requested a review from ksbeattie as a code owner January 4, 2024 22:51
@codecov
Copy link

codecov bot commented Jan 25, 2024 •
edited
Loading

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (d45e2ad) 77.43% compared to head (7ba2ba6) 77.43%.

Files Patch % Lines
idaes/core/surrogate/onnx_surrogate.py 78.26% 7 Missing and 8 partials ⚠️
idaes/core/surrogate/omlt_base_surrogate_class.py 94.64% 1 Missing and 2 partials ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1308   +/-   ##
=======================================
  Coverage   77.43%   77.43%           
=======================================
  Files         390      392    +2     
  Lines       63758    63844   +86     
  Branches    11737    11749   +12     
=======================================
+ Hits        49373    49440   +67     
- Misses      11841    11852   +11     
- Partials     2544     2552    +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ksbeattie ksbeattie requested review from rundxdi and removed request for andrewlee94, bpaul4, eslickj, ksbeattie and lbianchi-lbl February 8, 2024 19:52
@ksbeattie
Copy link
Member

ksbeattie commented Jun 13, 2024

@avdudchenko @rundxdi now would be a good time to get this on the Aug release, if you can find a reviewer for it

@ksbeattie ksbeattie requested review from Robbybp and removed request for carldlaird September 5, 2024 18:18
@codecov-commenter
Copy link

codecov-commenter commented Sep 5, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 85.71429% with 18 lines in your changes missing coverage. Please review.

Project coverage is 76.98%. Comparing base (0e05ed1) to head (1084f5c).

Files with missing lines Patch % Lines
idaes/core/surrogate/onnx_surrogate.py 77.94% 7 Missing and 8 partials ⚠️
idaes/core/surrogate/omlt_base_surrogate_class.py 94.44% 1 Missing and 2 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1308      +/-   ##
==========================================
- Coverage   76.98%   76.98%   -0.01%     
==========================================
  Files         382      384       +2     
  Lines       61913    61995      +82     
  Branches    10130    10136       +6     
==========================================
+ Hits        47665    47728      +63     
- Misses      11848    11859      +11     
- Partials     2400     2408       +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ksbeattie
Copy link
Member

ksbeattie commented Sep 26, 2024

@avdudchenko, this is now on the Nov 2024 release board. Can progress be picked up on this now?

@ksbeattie ksbeattie requested a review from bpaul4 October 10, 2024 18:37
@ksbeattie
Copy link
Member

ksbeattie commented Oct 10, 2024 •
edited
Loading

@OOAmusat, @bpaul4, @rundxdi can you review or finish your review?

@ksbeattie ksbeattie requested a review from OOAmusat October 10, 2024 18:44
rundxdi
rundxdi approved these changes Oct 10, 2024
View reviewed changes
Copy link
Contributor

@rundxdi rundxdi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finalizing my review -- looks good at this point

bpaul4
bpaul4 approved these changes Oct 10, 2024
View reviewed changes
Copy link
Contributor

@bpaul4 bpaul4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the changes implemented here are good. Not critical to fix, there are a few places in the ONNX file that refer to "keras" instead of "onnx".

@dangunter
Copy link
Member

dangunter commented Oct 17, 2024 •
edited
Loading

@avdudchenko Can you look at the test failures and see if they can be fixed?
Also could you address Brandon's comments

@andrewlee94 andrewlee94 merged commit 2e5a9a4 into IDAES:main Nov 4, 2024
@lbianchi-lbl lbianchi-lbl mentioned this pull request Nov 22, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rundxdi rundxdi rundxdi approved these changes

@bpaul4 bpaul4 bpaul4 approved these changes

@dallan-keylogic dallan-keylogic Awaiting requested review from dallan-keylogic dallan-keylogic is a code owner

@Robbybp Robbybp Awaiting requested review from Robbybp

@OOAmusat OOAmusat Awaiting requested review from OOAmusat

@agarciadiego agarciadiego Awaiting requested review from agarciadiego agarciadiego is a code owner

Assignees

@avdudchenko avdudchenko

Labels

Priority:Normal Normal Priority Issue or PR WaterTAP

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@avdudchenko @ksbeattie @codecov-commenter @dangunter @rundxdi @bpaul4 @andrewlee94 @lbianchi-lbl