Improved MindtPy Documentation by tarikLG · Pull Request #3 · tarikLG/pyomo

tarikLG · 2026-03-03T01:39:16Z

Fixes # .

Summary/Motivation:

Improves code documentation and maintainability of the MindtPy solver package by enhancing docstrings to comply with Pyomo documentation standards. This PR adds comprehensive module-level documentation, refines function and method docstrings with NumPy-style formatting, and ensures consistency across the codebase.

Changes proposed in this PR:

Added module-level docstrings to all MindtPy package files (solver implementations, configuration, utilities, and tests)
Enhanced function and method docstrings with clear, imperative summaries and proper parameter/return documentation
Converted docstring formatting to NumPy style for consistency with Pyomo standards
Improved docstrings for:
- Main solver interface methods (MindtPy.py)
- Base algorithm class and all handler methods (algorithm_base_class.py)
- Configuration helper functions (config_options.py)
- Cut generation functions (cut_generation.py)
- Strategy-specific implementations (OA, ECP, FP, GOA)
- Callback machinery (single_tree.py, tabu_list.py)
- Utility functions (util.py)
- All test model classes and test helper functions
Refined language to use imperative verbs (e.g., "Generate...", "Add...", "Handle...") instead of descriptive phrases
Added type annotations and parameter descriptions throughout

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:

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

…dtPy, add test case for this bug fixing

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Co-authored-by: Tarik Levent Guler <64302098+tarikLG@users.noreply.github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 40 out of 40 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyomo/contrib/mindtpy/util.py

pyomo/contrib/mindtpy/algorithm_base_class.py

pyomo/contrib/mindtpy/single_tree.py

…ency across MindtPy modules

Copilot

Pull request overview

Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyomo/contrib/mindtpy/algorithm_base_class.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bernalde

Good PR, I left a number of comments. Please address them and answer each one of them. Do not mark them as resolved as I will later look at them during the follow-up revision. Even if you find them unreasonable, do not just ignore them

pyomo/contrib/mindtpy/tests/eight_process_problem.py

pyomo/contrib/mindtpy/tests/feasibility_pump1.py

pyomo/contrib/mindtpy/tests/from_proposal.py

pyomo/contrib/mindtpy/tests/minlp2_simple.py

pyomo/contrib/mindtpy/tests/minlp3_simple.py

pyomo/contrib/mindtpy/feasibility_pump.py

bernalde · 2026-03-25T21:53:07Z

pyomo/contrib/mindtpy/feasibility_pump.py

@@ -75,4 +93,5 @@ def add_cuts(
        )

    def MindtPy_iteration_loop(self):


Shouldn't it be specific to the feaspump?

By this, I mean change the function name

bernalde · 2026-03-25T21:53:37Z

pyomo/contrib/mindtpy/global_outer_approximation.py


-        Call after solve fixed NLP subproblem.
-        Use the optimal primal bound of the relaxed problem to update the dual bound.
+        Call after solving a primal-feasible subproblem (typically fixed NLP).


Again, can this ever be a non-NLP?

pyomo/contrib/mindtpy/outer_approximation.py

pyomo/contrib/mindtpy/single_tree.py

Co-authored-by: David Bernal <dbernaln@purdue.edu>

Standardizes test model naming conventions for clarity and Python style, renaming MINLP example files and classes to lowercase and CamelCase formats. Removes redundant legacy test models, updates imports and references throughout the MindtPy test framework, and adds minor docstring improvements for better documentation consistency. Enhances maintainability by enforcing backward-compatible aliases where necessary and clarifying test model purposes. No functional solver logic is changed; only test model structure and integration are affected.

Corrects the indentation of class alias definitions to be outside the class scope, ensuring proper aliasing and adherence to Python conventions. No functional changes introduced.

Copilot

Pull request overview

Copilot reviewed 40 out of 40 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-06T00:16:24Z

pyomo/contrib/mindtpy/tests/unit_test.py


 from pyomo.environ import Var, Integers, ConcreteModel, Integers
 from pyomo.contrib.mindtpy.algorithm_base_class import _MindtPyAlgorithm


The from pyomo.environ import ... statement imports Integers twice. This is redundant and may trip some linters; please remove the duplicate name from the import list.

pyomo/contrib/mindtpy/single_tree.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

pyomo/contrib/mindtpy/tests/minlp_simple_grey_box.py

bernalde · 2026-04-08T20:22:07Z

pyomo/contrib/mindtpy/tests/minlp_simple.py

+
+
+# Backward-compatible alias.
+SimpleMINLP = MinlpSimple


I don't think we need these aliases. Let's remove them by checking tests across the whole pyomo to avoid breaking things elsewhere

I've gotten rid of the aliases

bernalde · 2026-04-08T20:32:22Z

pyomo/contrib/mindtpy/algorithm_base_class.py

@@ -474,6 +524,13 @@ def build_ordered_component_lists(self, model):
        )

    def add_cuts_components(self, model):


add_cut_and_feas_components

bernalde · 2026-04-08T20:33:55Z

pyomo/contrib/mindtpy/feasibility_pump.py

@@ -75,4 +93,5 @@ def add_cuts(
        )

    def MindtPy_iteration_loop(self):


By this, I mean change the function name

…tyPump2; enhance add_orthogonality_cuts function with lazy initialization of cut containers.

…s for clarity and consistency

…d MinlpSimple classes in test files.

…d MinlpSimple classes in test files. Rename test model classes for consistency Updates test model class names to standardize naming conventions across test files, improving clarity and consistency. Removes backward-compatible aliases as part of the cleanup.

… consistency

Merge main into polishing

chudling and others added 23 commits February 24, 2026 15:49

Polished documentation according to Numpy standard

fd68292

Added module-level docstrings

d5f4465

Fix no results returned when no discrete variables are present in Min…

9729414

…dtPy, add test case for this bug fixing

Integrate the test into existing tests

8265438

Black the format

51c99b6

update test_mindtpy_lp_nlp.py and delete test_mindtpy_no_discrete.py

f79f1ef

deleted: pyomo/contrib/mindtpy/tests/test_mindtpy_no_discrete.py

f3bbe3f

Update pyomo/contrib/mindtpy/algorithm_base_class.py

cb3f5bb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyomo/contrib/mindtpy/algorithm_base_class.py

fed0e9c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyomo/contrib/mindtpy/algorithm_base_class.py

6a45fa1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestion from @tarikLG

1011f82

Co-authored-by: Tarik Levent Guler <64302098+tarikLG@users.noreply.github.com>

Update pyomo/contrib/mindtpy/algorithm_base_class.py

1879bb9

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update mirror helper

5111c76

Delete the no_discrete test

db12f6e

Build a separate test for changes

d126350

Add copyright and black format for the new test file

e33172b

Update pyomo/contrib/mindtpy/tests/test_mindtpy_no_discrete.py

f5eeceb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyomo/contrib/mindtpy/tests/test_mindtpy_no_discrete.py

9906f9c

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyomo/contrib/mindtpy/algorithm_base_class.py

bf53d84

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update pyomo/contrib/mindtpy/tests/test_mindtpy_no_discrete.py

686db88

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Black the format of pyomo/pyomo/contrib/mindtpy/algorithm_base_class.py

bd9db66

Merge remote-tracking branch 'origin' into polishing

a921e8d

Formatted with black

ee31df2

tarikLG assigned tarikLG, bernalde, sergey-gusev94 and Copilot and unassigned bernalde, tarikLG and sergey-gusev94 Mar 4, 2026

tarikLG requested a review from Copilot March 25, 2026 19:29

Copilot started reviewing on behalf of tarikLG March 25, 2026 19:29 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

pyomo/contrib/mindtpy/util.py Show resolved Hide resolved

pyomo/contrib/mindtpy/algorithm_base_class.py Outdated Show resolved Hide resolved

pyomo/contrib/mindtpy/algorithm_base_class.py Outdated Show resolved Hide resolved

pyomo/contrib/mindtpy/single_tree.py Outdated Show resolved Hide resolved

tarikLG added 2 commits March 25, 2026 15:33

Update docstrings to replace "master MIP" with "main MIP" for consist…

ce47d15

…ency across MindtPy modules

Fix L2 distance formula in generate_norm2sq_objective_function docstring

8f7d725

tarikLG requested a review from Copilot March 25, 2026 19:35

Copilot started reviewing on behalf of tarikLG March 25, 2026 19:36 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

pyomo/contrib/mindtpy/algorithm_base_class.py Outdated Show resolved Hide resolved

Update pyomo/contrib/mindtpy/algorithm_base_class.py

57fb58a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bernalde changed the base branch from main to mindtpy-docs March 25, 2026 21:06

bernalde requested changes Mar 25, 2026

View reviewed changes

tarikLG and others added 3 commits April 5, 2026 19:16

Apply suggestion from @bernalde

191740a

Co-authored-by: David Bernal <dbernaln@purdue.edu>

Fixes indentation of backward-compatible aliases

b47ad5e

Corrects the indentation of class alias definitions to be outside the class scope, ensuring proper aliasing and adherence to Python conventions. No functional changes introduced.

tarikLG requested a review from Copilot April 6, 2026 00:13

Copilot started reviewing on behalf of tarikLG April 6, 2026 00:13 View session

Copilot AI reviewed Apr 6, 2026

View reviewed changes

tarikLG and others added 3 commits April 6, 2026 15:14

Update pyomo/contrib/mindtpy/single_tree.py

f3eaf00

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Remove duplicate import of Integers in unit test

57e9621

Merge remote-tracking branch 'origin' into polishing

1f2031e

tarikLG requested a review from bernalde April 8, 2026 17:52

bernalde requested changes Apr 8, 2026

View reviewed changes

tarikLG and others added 6 commits April 11, 2026 18:34

Rename parameter in build_model_external function

f0a9263

Remove backward-compatible aliases for FeasibilityPump1 and Feasibili…

927e445

…tyPump2; enhance add_orthogonality_cuts function with lazy initialization of cut containers.

Refactor MindtPy algorithm methods and update references in test file…

8ce1071

…s for clarity and consistency

Remove backward-compatible aliases for Minlp4Simple, Minlp5Simple, an…

58be5c7

…d MinlpSimple classes in test files.

Rename EightProcessFlowsheet to EightProcessProblem in test files for…

41cf1e4

… consistency

bernalde approved these changes Apr 14, 2026

View reviewed changes

Merge pull request #5 from Pyomo/main

1dc964a

Merge main into polishing

		@@ -75,4 +93,5 @@ def add_cuts(
		)

		def MindtPy_iteration_loop(self):


		from pyomo.environ import Var, Integers, ConcreteModel, Integers
		from pyomo.contrib.mindtpy.algorithm_base_class import _MindtPyAlgorithm

		@@ -474,6 +524,13 @@ def build_ordered_component_lists(self, model):
		)

		def add_cuts_components(self, model):

Conversation

tarikLG commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fixes # .

Summary/Motivation:

Changes proposed in this PR:

Legal Acknowledgement

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

bernalde left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bernalde Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

bernalde Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

bernalde Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bernalde Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

tarikLG Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

bernalde Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

bernalde Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

tarikLG commented Mar 3, 2026 •

edited

Loading