Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs_amd/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <rocm:index>`/:doc:`HIP <hip:index>` stack while preserving API compatibility.

rocOpt is designed for large-scale decision and route optimization. For more information, see :doc:`What is rocOpt? <what_is_rocopt>`
Expand Down
2 changes: 1 addition & 1 deletion docs_amd/install/install_rocopt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=====================================
Expand Down
10 changes: 5 additions & 5 deletions docs_amd/reference/python-api-reference.rst
Original file line number Diff line number Diff line change
@@ -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
******************
Expand All @@ -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
--------------------
Expand Down Expand Up @@ -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
-------------
Expand Down
6 changes: 3 additions & 3 deletions docs_amd/what_is_rocopt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand All @@ -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.