Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OMLT documentation #1185

Merged
merged 9 commits into from May 25, 2023
Merged

OMLT documentation #1185

merged 9 commits into from May 25, 2023

Conversation

agarciadiego
Copy link
Contributor

Summary/Motivation:

Changes proposed in this PR:

  • Adds documentation for OMLT keras surrogates

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.

@agarciadiego agarciadiego self-assigned this May 15, 2023
@agarciadiego agarciadiego marked this pull request as draft May 15, 2023 19:37
@agarciadiego agarciadiego added the documentation Documentations comments and requests label May 15, 2023
@codecov
Copy link

codecov bot commented May 15, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.01 ⚠️

Comparison is base (45e12e4) 76.80% compared to head (a411f56) 76.80%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1185      +/-   ##
==========================================
- Coverage   76.80%   76.80%   -0.01%     
==========================================
  Files         390      390              
  Lines       61723    61723              
  Branches    11376    11376              
==========================================
- Hits        47408    47405       -3     
- Misses      11854    11858       +4     
+ Partials     2461     2460       -1     

see 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@agarciadiego agarciadiego marked this pull request as ready for review May 15, 2023 22:20
@agarciadiego
Copy link
Contributor Author

@bpaul4 @MAZamarripa you have more experience using this tool. Let me know if I'm missing an option that a user would require to have in the documentation

@adowling2
Copy link
Contributor

@Xinhe-Chen Any feedback on this documentation?

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.

Thank you @agarciadiego for contributing this documentation. The pages look nice, I left a few comments and minor suggestions.

@Xinhe-Chen
Copy link
Contributor

@Xinhe-Chen Any feedback on this documentation?

I will review it later today or tomorrow.

Copy link
Member

@MAZamarripa MAZamarripa left a comment

Choose a reason for hiding this comment

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

Looks good to me
Bonus if we add an example "how to scale inputs/outputs."

@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label May 18, 2023
@ksbeattie
Copy link
Member

@Xinhe-Chen, any news? We'd like to get this in the May release, which we hope to create the RC for next week.

@agarciadiego agarciadiego requested a review from bpaul4 May 22, 2023 15:56
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.

Everything works and looks great. Thanks!

Copy link
Contributor

@Xinhe-Chen Xinhe-Chen left a comment

Choose a reason for hiding this comment

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

This PR looks good to me! Thank you for your effort!

@lbianchi-lbl lbianchi-lbl linked an issue May 25, 2023 that may be closed by this pull request
@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) May 25, 2023 18:51
@lbianchi-lbl lbianchi-lbl merged commit 74cd75e into IDAES:main May 25, 2023
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentations comments and requests Priority:Normal Normal Priority Issue or PR
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

OMLT/Keras Documentation For New API
7 participants