Surrogates API Documentation

[bpaul4]

Fixes

Summary/Motivation:

Changes proposed in this PR:

• New documentation for surrogates API (ALAMO, PySMO, Keras) Python wrappers
• This new documentation will be the default, and the old ALAMO/PySMO documentation will be removed

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.

[bpaul4]

I decided to keep the old ALAMO documentation for now, since some more advanced capabilities such as custom constraints and confidence intervals are not yet supported in the new API. @andrewlee94 if you have the time, I would appreciate your thoughts/feedback on this first pass at the ALAMO documentation and what to do about the old documentation and modules.

[andrewlee94]

@bpaul4 I haven't had a chance to look at the new stuff yet, but get rid of the old ALAMO docs - they are no longer supported, so even if they have additional features they aren't of any use.

[codecov[bot]]

Codecov Report

Base: 70.22% // Head: 70.24% // Increases project coverage by +0.01% :tada:

Coverage data is based on head (a38c429) compared to base (9b1ca96). Patch has no changes to coverable lines.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #943      +/-   ##
==========================================
+ Coverage   70.22%   70.24%   +0.01%     
==========================================
  Files         398      398              
  Lines       65667    65667              
  Branches    12122    12122              
==========================================
+ Hits        46116    46127      +11     
+ Misses      17201    17196       -5     
+ Partials     2350     2344       -6     

Impacted Files	Coverage Δ
idaes/ver.py	61.53% <0.00%> (-4.62%)	:arrow_down:
...roperties/general_helmholtz/helmholtz_functions.py	91.67% <0.00%> (+0.13%)	:arrow_up:
idaes/core/surrogate/pysmo/kriging.py	85.21% <0.00%> (+0.70%)	:arrow_up:
idaes/core/dmf/codesearch.py	100.00% <0.00%> (+0.72%)	:arrow_up:
idaes/core/dmf/dmfbase.py	74.84% <0.00%> (+0.85%)	:arrow_up:
idaes/core/dmf/util.py	55.55% <0.00%> (+1.19%)	:arrow_up:
idaes/commands/util/download_bin.py	51.14% <0.00%> (+2.29%)	:arrow_up:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[bpaul4]

@carldlaird @OOAmusat would you be able to provide content for the OMLT/Keras and PySMO index pages? If you have time, I would appreciate your thoughts on the new doctree structure, as well.

[bpaul4]

@andrewlee94 once I've addressed your comments above (will do that today), the landing page and ALAMO/PySMO sections will be complete. I'll clean up the OMLT placeholder page so it looks presentable in lieu of detailed content.

[bpaul4]

Thank you @OOAmusat and @andrewlee94 for your contributions. I'll continue to coordinate with @carldlaird to complete the OMLT pages for a future update.

[andrewlee94]

@bpaul4 Could you please create a new issue for the OMLT docs, and assign @carldlaird to it (and yourself if appropriate).