Skip to content

Fix documentation structure and fine tune explanations#16

Merged
rgsl888prabhu merged 63 commits intoNVIDIA:branch-25.05from
rgsl888prabhu:add_comments_on_docs
May 27, 2025
Merged

Fix documentation structure and fine tune explanations#16
rgsl888prabhu merged 63 commits intoNVIDIA:branch-25.05from
rgsl888prabhu:add_comments_on_docs

Conversation

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator

This is an update to doc after refactoring it to add C and Python API. And address missing items and fixing few structures.

@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner May 19, 2025 15:49
@rgsl888prabhu rgsl888prabhu requested a review from tmckayus May 19, 2025 15:49
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented May 19, 2025

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.

@rg20 rg20 added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels May 19, 2025
@rg20 rg20 removed the improvement Improves an existing functionality label May 19, 2025
Copy link
Copy Markdown
Contributor

@chris-maes chris-maes left a comment

Choose a reason for hiding this comment

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

LGTM

@chris-maes chris-maes added this to the 25.05 milestone May 19, 2025
@rg20
Copy link
Copy Markdown
Contributor

rg20 commented May 20, 2025

/ok to test 1574827

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

@chris-maes can you please elaborate more on this suggestion

The optimization problem for cuOptCreateRangeProblem looks different than the optimization problem for cuOptCreateProblem. These should be consistent. I would probably go for the one that say "x_i  integer for some i" rather than using math.

@rgsl888prabhu rgsl888prabhu requested a review from a team as a code owner May 22, 2025 01:55
@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test ca877bc

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test 8e02ff8

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test 79e1bb0

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test 09f7ad8

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test 8755199

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test b61959e

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

/ok to test 3edc36a

@rgsl888prabhu
Copy link
Copy Markdown
Collaborator Author

@rg20 @chris-maes @tmckayus May I get your reviews, I might open a new PR for adderssing VDR/VPR reviews.

@@ -0,0 +1,27 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@tmckayus I had to add this since cuopt_cli was getting added under /libcuopt/bin/ and PATH was not able to pick it up, and adding it under PATH was causing it to loose link to dependent libraries. This fixes the issue. This acts like a wrapper around it with same name and resides in the traditional PATH so it is readily available after installation.

Copy link
Copy Markdown
Contributor

@chris-maes chris-maes left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for all your hard work on this @rgsl888prabhu

@rgsl888prabhu rgsl888prabhu merged commit 0364ba5 into NVIDIA:branch-25.05 May 27, 2025
56 checks passed
jieyibi pushed a commit to yining043/cuopt that referenced this pull request Mar 26, 2026
* Address review comments

* Add cli.rst

* Cleanup CLI docs

* Fix warnings and errors

* Move commandline interface two levels up

* Fix review comments

* Adding changes from Andrew to add versions and adding link to cli

* Update lp-milp-c-api.rst

* changes for project.json and typedef header fix

* Update cli-examples.rst

* Update introduction.rst

* Updates to faq.rst, introduction.rst, lp-features.rst, lp-milp-settings.rst, milp-features.rst, release-notes.rst, routing-features.rst

* features and release notes

* update

* fix container path

* fix container path

* Move thirdparty files to directory and  clean it

* Update introduction.rst

* Update brev details and add project.json

* Changes to make cuOptCreateProblem consistent with cuOptCreateRangedProblem

* deprecate cuda 11 support

* Add rapids logger to rpath

* Add cli test

* fix issues

* add a sample mps file for test

* fix tests in docs

* pre-commit changes

* remove third party modeling languges for now from docs

* Remove modeling language details

* fix doc

* update doc

* Update introduction.rst

* Update release-notes.rst

* Update lp-features.rst

* Update lp-example.rst

* Update milp-examples.rst

* Update cli-examples.rst

* Update lp-features.rst

* Update milp-features.rst

* Update lp-features.rst

* Update milp-features.rst

* Update introduction.rst

* Update introduction.rst

* add cli to bin

* update intro

* APTH

* disable cli test inwheels

* Add cli support

* Add path for testing

---------

Co-authored-by: Rajesh Gandham <rgandham@nvidia.com>
Co-authored-by: Chris Maes <cmaes@nvidia.com>
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.

4 participants