Skip to content

Update README and Docs for version and broken links #56

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

Merged
rgsl888prabhu merged 6 commits into from
May 31, 2025
Merged

Update README and Docs for version and broken links #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
18ec814
fix typo
rgsl888prabhu May 29, 2025
960fa04
fix license metadata
rgsl888prabhu May 29, 2025
2a564dc
push update to docs
rgsl888prabhu May 30, 2025
1530292
update README.md
rgsl888prabhu May 30, 2025
02bfbd3
fix faq
rgsl888prabhu May 30, 2025
1e9da6d
Merge branch 'branch-25.05' into update_docs_25_05
rgsl888prabhu May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ on the major version of CUDA available in your environment:
For CUDA 12.x:

```bash
pip install --extra-index-url=https://pypi.nvidia.com cuopt-server-cu12==25.5 cuopt-sh-client==25.5 nvidia-cuda-runtime-cu12==12.8.*
pip install --extra-index-url=https://pypi.nvidia.com cuopt-server-cu12==25.5.* cuopt-sh-client==25.5.* nvidia-cuda-runtime-cu12==12.8.*
```

### Conda
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
master_doc = "index"

# General information about the project.
project = "cuopt"
project = "NVIDIA cuOpt"
copyright = f"2021-{datetime.datetime.today().year}, NVIDIA Corporation"
author = "NVIDIA Corporation"

Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-c/quick-start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This wheel is a Python wrapper around the C++ library and eases installation and

# This is a deprecated module and no longer used, but it shares the same name for the CLI, so we need to uninstall it first if it exists.
pip uninstall cuopt-thin-client
pip install --extra-index-url=https://pypi.nvidia.com libcuopt-cu12==25.5.* nvidia-cuda-runtime-cu12==12.8.0
pip install --extra-index-url=https://pypi.nvidia.com libcuopt-cu12==25.5.* nvidia-cuda-runtime-cu12==12.8.*


Conda
Expand Down
4 changes: 2 additions & 2 deletions docs/cuopt/source/cuopt-server/quick-start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For CUDA 12.x:

.. code-block:: bash
pip install --extra-index-url=https://pypi.nvidia.com cuopt-server-cu12==25.05.* cuopt-sh-client==25.05.* nvidia-cuda-runtime-cu12==12.8.*
pip install --extra-index-url=https://pypi.nvidia.com cuopt-server-cu12==25.5.* cuopt-sh-client==25.5.* nvidia-cuda-runtime-cu12==12.8.*
Conda
Expand Down Expand Up @@ -227,4 +227,4 @@ Example Response:
"total_solve_time": 0.10999655723571777
},
"reqId": "afea72c2-6c76-45ce-bcf7-0d55049f32e4"
}
}
2 changes: 1 addition & 1 deletion docs/cuopt/source/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ General FAQ

.. dropdown:: How to get a NVAIE license?

Please refer to `NVIDIA NVAIE <https://www.nvidia.com/en-us/technologies/ai-enterprise/nvaie/>`_ for more information.
Please refer to `NVIDIA NVAIE <https://www.nvidia.com/en-us/data-center/products/ai-enterprise/>`_ for more information.

.. dropdown:: How to access NGC registry?

Expand Down