normalize MILP to MIP in documentation - #1655
Conversation
leave a few references changed separately in NVIDIA#1653
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (3)
📝 WalkthroughWalkthroughThe PR replaces MILP terminology with MIP across documentation, release notes, solver references, and C, Python, CLI, and Server examples. It also updates selected copyright ranges. No APIs or solver behavior change. ChangesMIP terminology updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/cuopt/source/cuopt-c/mip/mip-examples.rst`:
- Around line 1-8: Update the embedded output in the MIP C API example
documentation to replace the outdated “Creating and solving simple LP
problem...” text with the current “Creating and solving simple MIP problem...”
output emitted by simple_milp_example.c. Preserve all other output and
formatting unchanged.
In `@docs/cuopt/source/cuopt-cli/index.rst`:
- Line 4: Update the cuopt_cli description to identify the supported solvers as
LP/QP/MIP solvers, while preserving the existing accepted input formats and
dispatch behavior. Verify the wording remains consistent with the C and Python
quick-start documentation.
In `@docs/cuopt/source/cuopt-server/examples/routing-examples.rst`:
- Line 280: Update the aborting-cli cross-reference sentence in the MIP Example
documentation to read “Please refer to the :ref:`aborting-cli` in the MIP
examples for more details.”
In `@docs/cuopt/source/faq.rst`:
- Around line 434-436: In the MIP solver limitations entry, restore the phrase
“bits in an integer” by adding the missing article before “integer”; leave the
surrounding limitation text unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b25724ad-87cb-4fdf-8065-c4934e30dad2
📒 Files selected for processing (32)
README.mdRELEASE-NOTES.mddocs/cuopt/source/convex-settings.rstdocs/cuopt/source/cuopt-c/convex/examples/Makefiledocs/cuopt/source/cuopt-c/mip/examples/milp_mps_example.cdocs/cuopt/source/cuopt-c/mip/examples/simple_milp_example.cdocs/cuopt/source/cuopt-c/mip/mip-examples.rstdocs/cuopt/source/cuopt-c/quick-start.rstdocs/cuopt/source/cuopt-cli/examples/lp/examples/basic_lp_example.shdocs/cuopt/source/cuopt-cli/examples/milp/examples/basic_milp_example.shdocs/cuopt/source/cuopt-cli/index.rstdocs/cuopt/source/cuopt-python/convex/convex-examples.rstdocs/cuopt/source/cuopt-python/convex/examples/pdlp_warmstart_example.pydocs/cuopt/source/cuopt-python/mip/examples/simple_milp_example.pydocs/cuopt/source/cuopt-python/mip/mip-examples.rstdocs/cuopt/source/cuopt-python/quick-start.rstdocs/cuopt/source/cuopt-server/examples/lp-examples.rstdocs/cuopt/source/cuopt-server/examples/lp/examples/batch_mode_example.shdocs/cuopt/source/cuopt-server/examples/lp/examples/warmstart_example.pydocs/cuopt/source/cuopt-server/examples/lp/examples/warmstart_example.shdocs/cuopt/source/cuopt-server/examples/milp-examples.rstdocs/cuopt/source/cuopt-server/examples/milp/examples/abort_job_example.pydocs/cuopt/source/cuopt-server/examples/milp/examples/abort_job_example.shdocs/cuopt/source/cuopt-server/examples/milp/examples/basic_milp_example.pydocs/cuopt/source/cuopt-server/examples/milp/examples/basic_milp_example.shdocs/cuopt/source/cuopt-server/examples/milp/examples/incumbent_callback_example.pydocs/cuopt/source/cuopt-server/examples/routing-examples.rstdocs/cuopt/source/faq.rstdocs/cuopt/source/hidden/limitations.rstdocs/cuopt/source/milp-features.rstdocs/cuopt/source/mip-settings.rstdocs/cuopt/source/resources.rst
cwilkinson76
left a comment
There was a problem hiding this comment.
Doc changes all look good, but do the files with "milp" in the filename need to be renamed to "mip"?
Thanks @cwilkinson76 I'll take a look at that. They shouldn't affect labels, etc but it might be better to rename them |
@cwilkinson76 maybe better to leave renames to post-release to make sure we don't break links etc. "milp" isn't wrong, just slightly inconsistent in that case. |
CI Test Summary✅ All 13 test job(s) passed. (2 skipped) |
Agree, lets work on a follow-up PR in next release since this might break. |
|
/merge |
We refer to both MILP and MIP in the documentation, so we decided to normalize around MIP everywhere.
Left a few references changed separately in #1653