Skip to content

Mindtpy docs - #3964

Open
bernalde wants to merge 10 commits into
Pyomo:mainfrom
tarikLG:mindtpy-docs
Open

Mindtpy docs#3964
bernalde wants to merge 10 commits into
Pyomo:mainfrom
tarikLG:mindtpy-docs

Conversation

@bernalde

Copy link
Copy Markdown
Contributor

Fixes N/A.

Summary/Motivation:

This PR ports the MindtPy polishing work from tarikLG/pyomo#3 into Pyomo main.
It improves MindtPy docstrings, standardizes terminology and helper naming, preserves the no-discrete-variable solve behavior, and clarifies Feasibility Pump dispatch so strategy-specific iteration loops run through the intended path.

Local verification:

  • python -m black . --check --diff
  • python -m pytest -q -W ignore::Warning pyomo/contrib/mindtpy/tests

Changes proposed in this PR:

  • Add and refine MindtPy solver, algorithm, utility, and configuration docstrings using Pyomo documentation conventions.
  • Rename and standardize MindtPy test model files/classes for consistency, while preserving compatibility aliases where appropriate.
  • Refactor MindtPy cut/feasibility component setup naming and Feasibility Pump iteration dispatch for clearer control flow.
  • Add/update MindtPy tests covering the no-discrete-variable solve path and updated test model imports.

AI-Use Disclosure

  • AI tools contributed to the development of this PR

    • AI tools generated documentation (including the PR description/comments, code comments, and/or Sphinx documentation)
    • AI tools generated tests (baselines, examples, and/or code)
    • AI tools generated code (apart from tests)

    Review process (select ONE):

    • Rewritten: All AI-generated content was rewritten by me before being committed.
    • Reviewed/verified: I retained AI-generated content and verified it before committing. Verification included (as applicable):
      • Ran the code and fixed issues
      • Added and ran tests
      • Checked correctness/logic of code and tests
      • Checked for alignment with the contribution guide
      • Considered security implications
    • As-is: AI-generated content was commited directly to the repository

Notes for reviewers (optional): Please focus review on the MindtPy Feasibility Pump dispatch path, the no-discrete-variable behavior, and whether the renamed test models and compatibility aliases match Pyomo conventions.

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.

@bernalde

Copy link
Copy Markdown
Contributor Author

Tests are failing because of another contrib package (iis)

@bernalde

Copy link
Copy Markdown
Contributor Author

CI failed for failed download of MC++, GHJ, and Pypi. (Fortunately) it was other parts of the testing matrix than last time

@codecov

codecov Bot commented Sep 4, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 65.21739% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.94%. Comparing base (e099f64) to head (50e705d).

Files with missing lines Patch % Lines
pyomo/contrib/mindtpy/algorithm_base_class.py 60.00% 6 Missing ⚠️
pyomo/contrib/mindtpy/util.py 50.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3964      +/-   ##
==========================================
- Coverage   89.94%   89.94%   -0.01%     
==========================================
  Files         917      917              
  Lines      109261   109276      +15     
==========================================
+ Hits        98276    98289      +13     
- Misses      10985    10987       +2     
Flag Coverage Δ
builders 29.12% <21.73%> (+<0.01%) ⬆️
default 86.14% <65.21%> (?)
expensive 35.10% <21.73%> (?)
linux 87.67% <65.21%> (-1.98%) ⬇️
linux_other 87.67% <65.21%> (-0.01%) ⬇️
oldsolvers 27.55% <21.73%> (-0.04%) ⬇️
osx 83.12% <65.21%> (-0.01%) ⬇️
win 85.44% <65.21%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants