Skip to content

Fix documentation structure and fine tune explanations #16

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.

Sign up for GitHub

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

Jump to bottom
Merged
rgsl888prabhu merged 63 commits into from
May 27, 2025
Merged

Fix documentation structure and fine tune explanations #16

rgsl888prabhu merged 63 commits into from
May 27, 2025

Conversation

@rgsl888prabhu
Copy link
Collaborator

@rgsl888prabhu rgsl888prabhu commented May 19, 2025

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-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
chris-maes
chris-maes reviewed May 19, 2025
View reviewed changes
chris-maes
chris-maes approved these changes May 19, 2025
View reviewed changes
Copy link
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
Contributor

rg20 commented May 20, 2025

/ok to test 1574827

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 21, 2025

@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
Collaborator Author

rgsl888prabhu commented May 23, 2025

/ok to test ca877bc

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 23, 2025

/ok to test 8e02ff8

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 23, 2025

/ok to test 79e1bb0

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 24, 2025

/ok to test 09f7ad8

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 27, 2025

/ok to test 8755199

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 27, 2025

/ok to test b61959e

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 27, 2025

/ok to test 3edc36a

@rgsl888prabhu
Copy link
Collaborator Author

rgsl888prabhu commented May 27, 2025

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

rgsl888prabhu
rgsl888prabhu commented May 27, 2025
View reviewed changes
python/libcuopt/libcuopt/_cli_wrapper.py
@@ -0,0 +1,27 @@
# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES.
Copy link
Collaborator Author

@rgsl888prabhu rgsl888prabhu May 27, 2025

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.

chris-maes
chris-maes approved these changes May 27, 2025
View reviewed changes
Copy link
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tmckayus tmckayus tmckayus approved these changes

@rg20 rg20 rg20 approved these changes

@chris-maes chris-maes chris-maes approved these changes

@Kh4ster Kh4ster Awaiting requested review from Kh4ster Kh4ster is a code owner automatically assigned from NVIDIA/cuopt-engine-codeowners

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

25.05

Development

Successfully merging this pull request may close these issues.

4 participants

@rgsl888prabhu @rg20 @chris-maes @tmckayus