Update cuOpt MIP positioning

[Sylendran95]

Updates README and documentation copy to clarify cuOpt MIP beta positioning, the current focus on GPU-accelerated primal heuristics for fast feasible solutions, and hybrid GPU/CPU workflows.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

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: 14db4e3b-406d-41ac-ba68-4b97eed1ba63

📥 Commits

Reviewing files that changed from the base of the PR and between cef1eee and 7edc3da.

📒 Files selected for processing (8)

• README.md
• docs/cuopt/source/cuopt-c/mip/index.rst
• docs/cuopt/source/cuopt-cli/index.rst
• docs/cuopt/source/cuopt-python/mip/index.rst
• docs/cuopt/source/faq.rst
• docs/cuopt/source/introduction.rst
• docs/cuopt/source/milp-features.rst
• docs/cuopt/source/mip-settings.rst

✅ Files skipped from review due to trivial changes (6)

• docs/cuopt/source/cuopt-cli/index.rst
• docs/cuopt/source/cuopt-c/mip/index.rst
• docs/cuopt/source/mip-settings.rst
• docs/cuopt/source/introduction.rst
• docs/cuopt/source/cuopt-python/mip/index.rst
• README.md

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/cuopt/source/faq.rst
• docs/cuopt/source/milp-features.rst

---

📝 Walkthrough

Walkthrough

Update docs to mark cuOpt MIP as beta and emphasize GPU-accelerated primal heuristics in hybrid GPU/CPU workflows across README, core MILP docs, feature/settings, language bindings, and an FAQ.

Changes

cuOpt MIP Beta and GPU Primal Heuristics Messaging

Layer / File(s)	Summary
Product messaging and core MILP conceptual documentation README.md, docs/cuopt/source/introduction.rst	Expanded README product paragraph; introduction.rst MILP beta note replaced with expanded text including a Mixed Integer Linear Program definition and a rewritten hybrid GPU/CPU workflow that frames GPU primal heuristics as improving the primal bound early and CPU algorithms as improving the dual bound.
Feature availability and MIP settings documentation docs/cuopt/source/milp-features.rst, docs/cuopt/source/mip-settings.rst	Updated Availability text to mark MIP as beta and describe GPU-accelerated primal heuristics focus; fixed grammar ("provide" → "provides"); added MIP-specific introductory paragraph in mip-settings describing beta status and heuristic emphasis.
API language-specific documentation docs/cuopt/source/cuopt-c/mip/index.rst, docs/cuopt/source/cuopt-cli/index.rst, docs/cuopt/source/cuopt-python/mip/index.rst	Inserted consistent beta-status notes and GPU-accelerated primal-heuristics descriptions across C, CLI, and Python docs.
User FAQ for MIP solver usage docs/cuopt/source/faq.rst	Added FAQ "How do I run the MIP solver with cuOpt?" describing usage via Python/C/CLI/server APIs, MIP beta status, GPU-accelerated primal heuristics for early feasible-solution finding, and that proving optimality is still under active development.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• NVIDIA/cuopt#1384: Prior PR that updates MILP/MIP documentation to mark MIP as beta with similar GPU-primal-heuristic messaging.

Suggested labels

doc, non-breaking

Suggested reviewers

• Iroy30
• tmckayus
• rgsl888prabhu

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly and clearly summarizes the main change: updating documentation to clarify cuOpt MIP positioning across multiple files.
Description check	✅ Passed	The description accurately covers the changeset, explaining that the PR updates README and documentation to clarify MIP beta positioning, GPU-accelerated primal heuristics, and hybrid workflows.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[chris-maes]

See offline discussion.

[coderabbitai]

🧹 Nitpick comments (2)

docs/cuopt/source/faq.rst (1)

425-433: ⚡ Quick win

Remove redundant sentence for consistency with canonical source.

Lines 431-432 add an extra sentence ("These GPU algorithms are designed to improve the quality of feasible solutions early in the solve.") not present in the canonical wording from introduction.rst. This sentence restates what was already conveyed about GPU-accelerated primal heuristics finding high-quality feasible solutions quickly.

✂️ Proposed fix to match canonical introduction.rst wording

 You can run the cuOpt MIP solver through the Python, C, CLI, or server APIs
by providing a model with integer or binary variables. The cuOpt MIP solver
is in **beta** and under active development. The solver currently excels at
finding high-quality feasible solutions quickly with GPU-accelerated primal
- heuristics. These GPU algorithms are designed to improve the quality of- feasible solutions early in the solve. Proving feasible solutions optimal+ heuristics. Proving feasible solutions optimal
remains under active development.

Based on learnings, the .rst files under docs/cuopt/source/ are the canonical source for published docs; introduction.rst establishes the standard beta/GPU-heuristics messaging that other pages should mirror.

🤖 Prompt for 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.
In `@docs/cuopt/source/faq.rst` around lines 425 - 433, Remove the redundant
sentence "These GPU algorithms are designed to improve the quality of feasible
solutions early in the solve." from the FAQ entry so the wording matches the
canonical phrasing in introduction.rst; locate the paragraph in the MIP solver
FAQ where it currently follows the sentence about "GPU-accelerated primal
heuristics" and delete that extra sentence to avoid restating the same point.

docs/cuopt/source/milp-features.rst (1)

8-12: ⚡ Quick win

Remove redundant sentence for consistency with canonical source.

Lines 10-11 add an extra sentence not present in the canonical wording from introduction.rst. This sentence restates what the previous sentence already conveys about GPU-accelerated primal heuristics finding high-quality feasible solutions quickly.

✂️ Proposed fix to match canonical introduction.rst wording

 The cuOpt MIP solver is in **beta** and under active development. The solver
currently excels at finding high-quality feasible solutions quickly with
-GPU-accelerated primal heuristics. These GPU algorithms are designed to improve-the quality of feasible solutions early in the solve. Proving feasible solutions+GPU-accelerated primal heuristics. Proving feasible solutions
optimal remains under active development.

Based on learnings, the .rst files under docs/cuopt/source/ are the canonical source for published docs; introduction.rst establishes the standard beta/GPU-heuristics messaging that other pages should mirror.

🤖 Prompt for 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.
In `@docs/cuopt/source/milp-features.rst` around lines 8 - 12, Remove the
redundant sentence that restates the GPU-accelerated heuristics message: delete
the sentence "These GPU algorithms are designed to improve the quality of
feasible solutions early in the solve." from milp-features content so the
paragraph matches the canonical wording in introduction.rst and keeps only the
line about GPU-accelerated primal heuristics finding high-quality feasible
solutions quickly followed by "Proving feasible solutions optimal remains under
active development."

🤖 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.
Nitpick comments:
In `@docs/cuopt/source/faq.rst`:
- Around line 425-433: Remove the redundant sentence "These GPU algorithms are
designed to improve the quality of feasible solutions early in the solve." from
the FAQ entry so the wording matches the canonical phrasing in introduction.rst;
locate the paragraph in the MIP solver FAQ where it currently follows the
sentence about "GPU-accelerated primal heuristics" and delete that extra
sentence to avoid restating the same point.
In `@docs/cuopt/source/milp-features.rst`:
- Around line 8-12: Remove the redundant sentence that restates the
GPU-accelerated heuristics message: delete the sentence "These GPU algorithms
are designed to improve the quality of feasible solutions early in the solve."
from milp-features content so the paragraph matches the canonical wording in
introduction.rst and keeps only the line about GPU-accelerated primal heuristics
finding high-quality feasible solutions quickly followed by "Proving feasible
solutions optimal remains under active development."

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1a18a6d7-24ad-49f6-a492-6c5a61c0a9f0

📥 Commits

Reviewing files that changed from the base of the PR and between f91c749 and b97ec5e.

📒 Files selected for processing (8)

• README.md
• docs/cuopt/source/cuopt-c/mip/index.rst
• docs/cuopt/source/cuopt-cli/index.rst
• docs/cuopt/source/cuopt-python/mip/index.rst
• docs/cuopt/source/faq.rst
• docs/cuopt/source/introduction.rst
• docs/cuopt/source/milp-features.rst
• docs/cuopt/source/mip-settings.rst

✅ Files skipped from review due to trivial changes (4)

• docs/cuopt/source/cuopt-c/mip/index.rst
• docs/cuopt/source/cuopt-cli/index.rst
• README.md
• docs/cuopt/source/mip-settings.rst

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/cuopt/source/introduction.rst

[chris-maes]

LGTM. Thanks @Sylendran95 !

[ramakrishnap-nv]

/ok to test 7edc3da

[cwilkinson76]

LGTM

[ramakrishnap-nv]

/merge