Skip to content

normalize MILP to MIP in documentation - #1655

Merged
rapids-bot[bot] merged 2 commits into
NVIDIA:mainfrom
tmckayus:milptomip
Aug 3, 2026
Merged

normalize MILP to MIP in documentation#1655
rapids-bot[bot] merged 2 commits into
NVIDIA:mainfrom
tmckayus:milptomip

Conversation

@tmckayus

@tmckayus tmckayus commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

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

leave a few references changed separately in NVIDIA#1653
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 954050e2-4068-438d-99ee-51be864ec0d8

📥 Commits

Reviewing files that changed from the base of the PR and between 482c63c and 212caf2.

📒 Files selected for processing (4)
  • docs/cuopt/source/cuopt-c/mip/mip-examples.rst
  • docs/cuopt/source/cuopt-cli/index.rst
  • docs/cuopt/source/cuopt-server/examples/routing-examples.rst
  • docs/cuopt/source/faq.rst
🚧 Files skipped from review as they are similar to previous changes (3)
  • docs/cuopt/source/cuopt-cli/index.rst
  • docs/cuopt/source/cuopt-c/mip/mip-examples.rst
  • docs/cuopt/source/cuopt-server/examples/routing-examples.rst

📝 Walkthrough

Walkthrough

The 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.

Changes

MIP terminology updates

Layer / File(s) Summary
Overview and release-note terminology
README.md, RELEASE-NOTES.md
Overview, API support lists, datasets, improvements, and bug-fix entries now use MIP terminology.
Core solver documentation
docs/cuopt/source/convex-settings.rst, docs/cuopt/source/milp-features.rst, docs/cuopt/source/mip-settings.rst, docs/cuopt/source/faq.rst, docs/cuopt/source/hidden/limitations.rst, docs/cuopt/source/resources.rst
Solver settings, feature descriptions, FAQs, limitations, and resource titles now use MIP terminology.
C, Python, and CLI examples
docs/cuopt/source/cuopt-c/..., docs/cuopt/source/cuopt-python/..., docs/cuopt/source/cuopt-cli/...
Example headings, comments, messages, quick-start text, and warmstart notes now use MIP terminology.
Server examples and cross-references
docs/cuopt/source/cuopt-server/...
Server guides and scripts update MIP terminology, applicability notes, cross-references, and copyright ranges.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: iroy30, chris-maes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the documentation terminology change from MILP to MIP.
Description check ✅ Passed The description directly explains the documentation terminology normalization and notes the references deferred to another pull request.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between fe77a49 and 482c63c.

📒 Files selected for processing (32)
  • README.md
  • RELEASE-NOTES.md
  • docs/cuopt/source/convex-settings.rst
  • docs/cuopt/source/cuopt-c/convex/examples/Makefile
  • docs/cuopt/source/cuopt-c/mip/examples/milp_mps_example.c
  • docs/cuopt/source/cuopt-c/mip/examples/simple_milp_example.c
  • docs/cuopt/source/cuopt-c/mip/mip-examples.rst
  • docs/cuopt/source/cuopt-c/quick-start.rst
  • docs/cuopt/source/cuopt-cli/examples/lp/examples/basic_lp_example.sh
  • docs/cuopt/source/cuopt-cli/examples/milp/examples/basic_milp_example.sh
  • docs/cuopt/source/cuopt-cli/index.rst
  • docs/cuopt/source/cuopt-python/convex/convex-examples.rst
  • docs/cuopt/source/cuopt-python/convex/examples/pdlp_warmstart_example.py
  • docs/cuopt/source/cuopt-python/mip/examples/simple_milp_example.py
  • docs/cuopt/source/cuopt-python/mip/mip-examples.rst
  • docs/cuopt/source/cuopt-python/quick-start.rst
  • docs/cuopt/source/cuopt-server/examples/lp-examples.rst
  • docs/cuopt/source/cuopt-server/examples/lp/examples/batch_mode_example.sh
  • docs/cuopt/source/cuopt-server/examples/lp/examples/warmstart_example.py
  • docs/cuopt/source/cuopt-server/examples/lp/examples/warmstart_example.sh
  • docs/cuopt/source/cuopt-server/examples/milp-examples.rst
  • docs/cuopt/source/cuopt-server/examples/milp/examples/abort_job_example.py
  • docs/cuopt/source/cuopt-server/examples/milp/examples/abort_job_example.sh
  • docs/cuopt/source/cuopt-server/examples/milp/examples/basic_milp_example.py
  • docs/cuopt/source/cuopt-server/examples/milp/examples/basic_milp_example.sh
  • docs/cuopt/source/cuopt-server/examples/milp/examples/incumbent_callback_example.py
  • docs/cuopt/source/cuopt-server/examples/routing-examples.rst
  • docs/cuopt/source/faq.rst
  • docs/cuopt/source/hidden/limitations.rst
  • docs/cuopt/source/milp-features.rst
  • docs/cuopt/source/mip-settings.rst
  • docs/cuopt/source/resources.rst

Comment thread docs/cuopt/source/cuopt-c/mip/mip-examples.rst
Comment thread docs/cuopt/source/cuopt-cli/index.rst Outdated
Comment thread docs/cuopt/source/cuopt-server/examples/routing-examples.rst Outdated
Comment thread docs/cuopt/source/faq.rst Outdated
@tmckayus tmckayus added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Aug 3, 2026
@tmckayus tmckayus self-assigned this Aug 3, 2026
@tmckayus tmckayus added this to the 26.08 milestone Aug 3, 2026

@cwilkinson76 cwilkinson76 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Doc changes all look good, but do the files with "milp" in the filename need to be renamed to "mip"?

@tmckayus

tmckayus commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

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

@tmckayus
tmckayus requested a review from chris-maes August 3, 2026 19:29
@tmckayus

tmckayus commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

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.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown

CI Test Summary

✅ All 13 test job(s) passed. (2 skipped)

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

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

Agree, lets work on a follow-up PR in next release since this might break.

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

/merge

@rapids-bot
rapids-bot Bot merged commit 7d08d5b into NVIDIA:main Aug 3, 2026
76 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants