From b24601cd5f87423c6733d1191fadbc036a1cbb09 Mon Sep 17 00:00:00 2001 From: randyh62 Date: Mon, 31 Aug 2026 14:12:31 -0700 Subject: [PATCH 1/2] Update based on Ram feedback --- docs_amd/index.rst | 2 +- docs_amd/install/install_rocopt.rst | 2 +- docs_amd/reference/python-api-reference.rst | 10 +++++----- docs_amd/what_is_rocopt.rst | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs_amd/index.rst b/docs_amd/index.rst index f8a7e1d369..90151e31da 100644 --- a/docs_amd/index.rst +++ b/docs_amd/index.rst @@ -9,7 +9,7 @@ rocOpt documentation ******************************************************************** rocOpt is part of the AMD Data Science toolkit, an open-source software collection for high-performance data science applications. -Forked from the NVIDIA RAPIDS® cuOpt project, rocOpt brings the same GPU-accelerated software library to the +Forked from the RAPIDS® cuOpt project, rocOpt brings the same GPU-accelerated software library to the :doc:`ROCm `/:doc:`HIP ` stack while preserving API compatibility. rocOpt is designed for large-scale decision and route optimization. For more information, see :doc:`What is rocOpt? ` diff --git a/docs_amd/install/install_rocopt.rst b/docs_amd/install/install_rocopt.rst index 016d5339bc..98a40f3856 100644 --- a/docs_amd/install/install_rocopt.rst +++ b/docs_amd/install/install_rocopt.rst @@ -37,7 +37,7 @@ Compatibility Matrix .. note:: - ROCm version compatibility: This release of rocOpt is built against ROCm 7.1.1 and is intended to run on ROCm 7.2.3. This configuration serves as a workaround for a build issue identified in ROCm 7.2.3. The issue has been fixed for future releases. + ROCm version compatibility: This release of rocOpt is built against ROCm 7.1.1 and is intended to run on ROCm 7.2.3. This configuration serves as a workaround for a build issue identified in ROCm 7.2.3. Option 1: Use a prebuilt Docker image ===================================== diff --git a/docs_amd/reference/python-api-reference.rst b/docs_amd/reference/python-api-reference.rst index 062e5353ac..5803852e52 100644 --- a/docs_amd/reference/python-api-reference.rst +++ b/docs_amd/reference/python-api-reference.rst @@ -1,18 +1,18 @@ .. meta:: - :description: Python API reference for rocopt, covering linear programming, quadratic programming, mixed integer linear programming, and vehicle routing problem classes and functions. + :description: Python API reference for rocOpt, covering linear programming, quadratic programming, mixed integer linear programming, and vehicle routing problem classes and functions. :keywords: rocopt, Python, API, LP, MILP, QP, VRP, routing, ROCm, optimization, cuopt ==================== Python API reference ==================== -This page documents the Python API for rocopt, covering both the ``libcuopt`` Python wrappers (Cython-based) and the ``cuopt`` Python package. The Python API provides access to linear programming (LP), mixed integer linear programming (MILP), quadratic programming (QP) solvers, and vehicle routing problem (VRP) solvers. +This page documents the Python API for rocOpt, covering both the ``libcuopt`` Python wrappers (Cython-based) and the ``cuopt`` Python package. The Python API provides access to linear programming (LP), mixed integer linear programming (MILP), quadratic programming (QP) solvers, and vehicle routing problem (VRP) solvers. For the corresponding C and C++ APIs, see :doc:`/reference/c-api-reference`. .. note:: - The Python API is built on Cython wrappers that call into the rocopt C++ solver libraries. The internal bridge modules (``cython_solve`` for LP and ``cython`` for routing) are not part of the public API and are not documented here. + The Python API is built on Cython wrappers that call into the rocOpt C++ solver libraries. The internal bridge modules (``cython_solve`` for LP and ``cython`` for routing) are not part of the public API and are not documented here. Linear programming ****************** @@ -21,7 +21,7 @@ The linear programming Python API provides classes and functions for defining an .. note:: - The source material available does not contain the full Python-level docstrings, class definitions, or function signatures for the LP Python API. The sections below describe the API surface based on the C++ types that the Python wrappers expose. Consult the installed package help (``help(cuopt)``) or the generated API docs shipped with rocopt for complete Python signatures and parameter details. + The source material available does not contain the full Python-level docstrings, class definitions, or function signatures for the LP Python API. The sections below describe the API surface based on the C++ types that the Python wrappers expose. Consult the installed package help (``help(cuopt)``) or the generated API docs shipped with rocOpt for complete Python signatures and parameter details. Optimization problem -------------------- @@ -132,7 +132,7 @@ Vehicle routing The vehicle routing Python API provides classes for defining and solving vehicle routing problems, including TSP, VRP, and pickup-and-delivery problems. These classes wrap the C++ routing API through Cython bindings. -For a complete walkthrough, see :doc:`../examples/rocopt-examples`. +For a complete walkthrough, see :ref:`rocopt-example`. DataModelView ------------- diff --git a/docs_amd/what_is_rocopt.rst b/docs_amd/what_is_rocopt.rst index b124fab76d..95eaa68309 100644 --- a/docs_amd/what_is_rocopt.rst +++ b/docs_amd/what_is_rocopt.rst @@ -14,7 +14,7 @@ mixed-integer linear programming (MILP), quadratic programming (QP), and vehicle problems containing millions of variables and constraints, returning near real-time results on AMD Instinct MI300X and MI355X GPUs through the ROCm software stack. -rocOpt is aligned with and API-compatible with NVIDIA cuOpt 25.10, so you can run +rocOpt is aligned with and API-compatible with cuOpt 25.10, so you can run existing cuOpt workloads and optimization pipelines on AMD Instinct GPUs without rewriting client code. From dce8f168c9983c6777904206ae1cc1b422e2d33e Mon Sep 17 00:00:00 2001 From: randyh62 Date: Mon, 31 Aug 2026 15:17:18 -0700 Subject: [PATCH 2/2] edit words --- docs_amd/what_is_rocopt.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs_amd/what_is_rocopt.rst b/docs_amd/what_is_rocopt.rst index 95eaa68309..b83b26aa91 100644 --- a/docs_amd/what_is_rocopt.rst +++ b/docs_amd/what_is_rocopt.rst @@ -48,7 +48,7 @@ the ROCm 7.2.3 runtime. This includes the following features: - Server API — serve optimization requests over HTTP with a cuOpt-compatible interface. -- rocOpt is built on the ROCm Data Science (ROCm-DS) stack — a HIP port of NVIDIA's +- rocOpt is built on the ROCm Data Science (ROCm-DS) stack — a HIP port cuOpt that maps RAPIDS-style dependencies to their ROCm equivalents (hipRAFT, hipMM, rocThrust, hipCUB, rocPRIM, hipSPARSE, hipBLAS, hipSOLVER) so workloads run on AMD Instinct hardware alongside other ROCm-DS libraries such as hipDF. @@ -63,6 +63,6 @@ the ROCm 7.2.3 runtime. This includes the following features: .. note:: - The Barrier (interior-point) LP solver depends on the NVIDIA cuDSS sparse direct + The Barrier (interior-point) LP solver depends on the cuDSS sparse direct solver, and has no ROCm equivalent in this release. Use PDLP for large LPs and dual simplex for smaller problems.