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

Add Pyomo.DOE to contrib #2294

Merged
merged 199 commits into from
Jan 30, 2023
Merged

Add Pyomo.DOE to contrib #2294

merged 199 commits into from
Jan 30, 2023

Conversation

jialuw96
Copy link
Contributor

@jialuw96 jialuw96 commented Feb 21, 2022

Fixes # .

Summary/Motivation: Contribute model-based design of experiments framework to Pyomo

Tasks to complete before merging:

Legal Acknowledgement

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

  1. I agree my contributions are submitted under the BSD license.
  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.

jialuw96 and others added 30 commits August 1, 2021 15:22
fix an error in the doc string of get_dfds_dcds()
…dating these functions cannot make get_dsdp() work in this repo.
…ng as it is in sensitivity toolbox repo, it cannot work for Pyomo.DAE model, but can work with analytical models.
…o. As long as it is in sensitivity toolbox repo, it cannot work for Pyomo.DAE model, but can work with analytical models."

This reverts commit ce6295a.
… Only updating these functions cannot make get_dsdp() work in this repo."

This reverts commit 0cc407e.
Copy link
Member

@blnicho blnicho left a comment

Choose a reason for hiding this comment

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

I found lots of typos and have a few other minor suggestions but this is getting really close.

doc/OnlineDocs/contributed_packages/doe/doe.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/doe/doe.rst Outdated Show resolved Hide resolved
doc/OnlineDocs/contributed_packages/doe/doe.rst Outdated Show resolved Hide resolved
pyomo/contrib/doe/__init__.py Outdated Show resolved Hide resolved
pyomo/contrib/doe/scenario.py Outdated Show resolved Hide resolved
pyomo/contrib/doe/fim_doe_tutorial.ipynb Outdated Show resolved Hide resolved
pyomo/contrib/doe/fim_doe_tutorial.ipynb Outdated Show resolved Hide resolved
pyomo/contrib/doe/fim_doe_tutorial.ipynb Show resolved Hide resolved
pyomo/contrib/doe/fim_doe_tutorial.ipynb Outdated Show resolved Hide resolved
pyomo/contrib/doe/fim_doe_tutorial.ipynb Show resolved Hide resolved
@jialuw96
Copy link
Contributor Author

@blnicho This PR is ready for review. Thank you!

@blnicho
Copy link
Member

blnicho commented Jan 25, 2023

@jialuw96 I'm still seeing errors in the ReadtheDocs build with some of the autoclass commands. This is the output:

WARNING: autodoc: failed to import class 'fim_doe.DesignOfExperiments' from module 'pyomo.contrib.doe'; the following exception was raised:
No module named 'pyomo.contrib.doe.fim_doe'
/home/docs/checkouts/readthedocs.org/user_builds/pyomo/checkouts/2294/pyomo/contrib/doe/measurements.py:docstring of pyomo.contrib.doe.measurements.Measurements.__init__:4: WARNING: Definition list ends without a blank line; unexpected unindent.
WARNING: autodoc: failed to import class 'FIM_result' from module 'pyomo.contrib.doe'; the following exception was raised:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/util/inspect.py", line 376, in safe_getattr
    return getattr(obj, name, *defargs)
AttributeError: module 'pyomo.contrib.doe' has no attribute 'FIM_result'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/importer.py", line 98, in import_object
    obj = attrgetter(obj, mangled_name)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/__init__.py", line 306, in get_attr
    return autodoc_attrgetter(self.env.app, obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/__init__.py", line 2804, in autodoc_attrgetter
    return safe_getattr(obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/util/inspect.py", line 392, in safe_getattr
    raise AttributeError(name) from exc
AttributeError: FIM_result

WARNING: autodoc: failed to import class 'Grid_Search_Result' from module 'pyomo.contrib.doe'; the following exception was raised:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/util/inspect.py", line 376, in safe_getattr
    return getattr(obj, name, *defargs)
AttributeError: module 'pyomo.contrib.doe' has no attribute 'Grid_Search_Result'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/importer.py", line 98, in import_object
    obj = attrgetter(obj, mangled_name)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/__init__.py", line 306, in get_attr
    return autodoc_attrgetter(self.env.app, obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/ext/autodoc/__init__.py", line 2804, in autodoc_attrgetter
    return safe_getattr(obj, name, *defargs)
  File "/home/docs/checkouts/readthedocs.org/user_builds/pyomo/envs/2294/lib/python3.7/site-packages/sphinx/util/inspect.py", line 392, in safe_getattr
    raise AttributeError(name) from exc
AttributeError: Grid_Search_Result

Copy link
Member

@adowling2 adowling2 left a comment

Choose a reason for hiding this comment

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

Looking forward to further improves per #2610

@blnicho blnicho merged commit 449180c into Pyomo:main Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants