Skip to content

Alternative Solutions documentation add#3370

Merged
blnicho merged 11 commits intoPyomo:doc-reorgfrom
viens-code:main
Oct 15, 2024
Merged

Alternative Solutions documentation add#3370
blnicho merged 11 commits intoPyomo:doc-reorgfrom
viens-code:main

Conversation

@viens-code
Copy link
Copy Markdown
Contributor

Fixes # .

Adds more documentation for contrib/alternative_solutions

Summary/Motivation:

Adds more documentation for contrib/alternative_solutions

Changes proposed in this PR:

  • Provides paper citation for contrib/alternative_solutions/balas.py
  • Adds optimality gap Knapsack examples to alternative_solutions documentation

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.

Adding citation to original Balas work on hypercube cuts as core reference for no-good cuts methodology
Added a knapsack example showing how to use abs_opt_gap to restrict what solutions are returned to the user based on optimality gaps
@viens-code
Copy link
Copy Markdown
Contributor Author

@mrmundt What needs to be done to get this past pending with Jenkins?

@mrmundt
Copy link
Copy Markdown
Contributor

mrmundt commented Sep 23, 2024

@viens-code the conflicts need to be resolved first

@viens-code
Copy link
Copy Markdown
Contributor Author

Ah, ok.
Looks like Pyomo/pyomo:doc-reorg doesn't have contributed_packages in it yet in OnlineDocs
So what was supposed to be a couple tweaks to alternative_solutions is introducing all the old docs

@jsiirola
Copy link
Copy Markdown
Member

AOS is still there. As part of the reorg it moved to explanation/analysis/alternative_solutions.rst

Copy link
Copy Markdown
Member

@jsiirola jsiirola left a comment

Choose a reason for hiding this comment

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

Overall this looks good. A couple minor formatting changes to suppress build warnings

@mrmundt
Copy link
Copy Markdown
Contributor

mrmundt commented Oct 8, 2024

@viens-code - Hello! We are planning to cut a patch release on Monday - do you think you will be able to look at this again before then?

@blnicho blnicho self-requested a review October 15, 2024 18:52
@blnicho blnicho merged commit 5293720 into Pyomo:doc-reorg Oct 15, 2024
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.

4 participants