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

Documentation Tweaks for contrib.alternative_solutions #3369

Closed
wants to merge 5 commits into from

Conversation

viens-code
Copy link
Contributor

Fixes # .

Adds documentation details to contrib.alternative_solutions

Summary/Motivation:

Adds documentation details to contrib.alternative_solutions

Changes proposed in this PR:

  • Adds citation to contrib/alternative_solutions/balas.py to original Balas 1972 paper "Canonical Cuts on the Unit Hypercube"
  • Adds example to documentation for alternative_solutions demonstrating how to use abs_opt_gap to limit generated solutions to those within a given optimality gap

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
@mrmundt
Copy link
Contributor

mrmundt commented Sep 16, 2024

@viens-code - Please install the most recent version of black into your environment and run black -S -C on your files.

@mrmundt
Copy link
Contributor

mrmundt commented Sep 16, 2024

@viens-code - black is still not your friend. Please make sure you have the most recent version installed and try again.

@emma58
Copy link
Contributor

emma58 commented Sep 16, 2024

@mrmundt @viens-code I think black passed--this one's a typo.

@mrmundt
Copy link
Contributor

mrmundt commented Sep 16, 2024

@viens-code - Whooops, you're right, sorry, I was looking at the last job. Fix the typo, commit, push, and it'll keep going!

@viens-code
Copy link
Contributor Author

Yeah, I think I figured out what were the issues with black.
Hopefully things work now.
Didn't expect it to spell check my comments "Cannonical" is apparently not the canonical spelling for that word

@jsiirola
Copy link
Member

@viens-code, can you make this PR against the doc-reorg branch instead on main? Merging this here would cause a bunch of merge conflicts with that effort.

@viens-code
Copy link
Contributor Author

Closed in favor of #3370 per @jsiirola request to move branch

@viens-code viens-code closed this Sep 17, 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