diff --git a/README.md b/README.md index 16142346a..1043a1298 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ -NVIDIA® cuOpt™ is a GPU-accelerated optimization engine that excels in mixed integer linear programming (MILP), linear programming (LP), quadratic programming (QP), and vehicle routing problems (VRP). It enables near real-time solutions for large-scale LPs with millions of variables and constraints, and MIPs with hundreds of thousands of variables. cuOpt offers easy integration into existing modeling languages and seamless deployment across hybrid and multi-cloud environments. +NVIDIA® cuOpt™ is a GPU-accelerated optimization engine that excels in linear programming (LP), quadratic programming (QP), and vehicle routing problems (VRP), with support for quadratically constrained quadratic programming (QCQP) (beta), second-order cone programming (SOCP) (beta), and mixed integer linear programming (MILP) (beta). It enables near real-time solutions for large-scale LPs with millions of variables and constraints. cuOpt offers easy integration into existing modeling languages and seamless deployment across hybrid and multi-cloud environments. The core engine is written in C++ and wrapped with a C API, Python API and Server API. @@ -28,18 +28,24 @@ cuOpt supports the following APIs: - C API support - Linear Programming (LP) - - Mixed Integer Linear Programming (MILP) - Quadratic Programming (QP) + - Quadratically Constrained Quadratic Programming (QCQP) (beta) + - Second-Order Cone Programming (SOCP) (beta) + - Mixed Integer Linear Programming (MILP) (beta) - C++ API support - cuOpt is written in C++ and includes a native C++ API. However, we do not provide documentation for the C++ API at this time. We anticipate that the C++ API will change significantly in the future. Use it at your own risk. - Python support - Routing (TSP, VRP, and PDP) - - Linear Programming (LP), Mixed Integer Linear Programming (MILP) and Quadratic Programming (QP) - - Algebraic modeling Python API allows users to easily build constraints and objectives + - Linear Programming (LP) + - Quadratic Programming (QP) + - Quadratically Constrained Quadratic Programming (QCQP) (beta) + - Second-Order Cone Programming (SOCP) (beta) + - Mixed Integer Linear Programming (MILP) (beta) + - Algebraic modeling Python API allows users to easily build constraints and objectives - Server support - Linear Programming (LP) - - Mixed Integer Linear Programming (MILP) - Routing (TSP, VRP, and PDP) + - Mixed Integer Linear Programming (MILP) (beta) This repo is also hosted as a [COIN-OR](http://github.com/coin-or/cuopt/) project. diff --git a/docs/cuopt/source/convex-features.rst b/docs/cuopt/source/convex-features.rst index 63fb6bee2..a24a929eb 100644 --- a/docs/cuopt/source/convex-features.rst +++ b/docs/cuopt/source/convex-features.rst @@ -41,7 +41,7 @@ The convex optimization solvers for Linear Programming (LP), Quadratic Programmi - .. note:: - QCQP/SOCP is currently only supported in CVXPY. We hope to add support for QCQP/SOCP in other modeling languages soon. + QCQP/SOCP support is currently in **beta**, and is only supported in CVXPY among modeling languages. We hope to add support for QCQP/SOCP in other modeling languages soon. - **C API**: A native C API that provides direct low-level access to cuOpt's convex optimization solvers, enabling integration into any application or system that can interface with C. diff --git a/docs/cuopt/source/cuopt-python/mip/index.rst b/docs/cuopt/source/cuopt-python/mip/index.rst index 97ef5711a..ee62b3e14 100644 --- a/docs/cuopt/source/cuopt-python/mip/index.rst +++ b/docs/cuopt/source/cuopt-python/mip/index.rst @@ -1,6 +1,8 @@ MIP (Mixed Integer Programming) ================================ +.. note:: Support for mixed integer linear programming is currently in **beta**. + This section contains details on the cuOpt MIP Python API. .. toctree:: diff --git a/docs/cuopt/source/introduction.rst b/docs/cuopt/source/introduction.rst index bea1a3515..cd2f39242 100644 --- a/docs/cuopt/source/introduction.rst +++ b/docs/cuopt/source/introduction.rst @@ -2,7 +2,7 @@ Introduction ========================== -**NVIDIA® cuOpt™** is a GPU-accelerated optimization library that solves `Mixed Integer Linear Programming (MILP) `_, `Linear Programming (LP) `_, `Quadratic Programming (QP) `_, and `Vehicle Routing Problems (VRP) `_. It enables solutions for large-scale problems with millions of variables and constraints, offering seamless deployment across hybrid and multi-cloud environments. +**NVIDIA® cuOpt™** is a GPU-accelerated optimization library that solves `Linear Programming (LP) `_, `Quadratic Programming (QP) `_, and `Vehicle Routing Problems (VRP) `_, with support for `Quadratically Constrained Quadratic Programming (QCQP) `_ (beta), `Second-Order Cone Programming (SOCP) `_ (beta), and `Mixed Integer Linear Programming (MILP) `_ (beta). It enables solutions for large-scale problems with millions of variables and constraints, offering seamless deployment across hybrid and multi-cloud environments. Using accelerated computing, NVIDIA® cuOpt optimizes operations research and logistics by enabling better, faster decisions. @@ -76,8 +76,10 @@ cuOpt includes three LP solving methods: All three algorithms can be run concurrently on both GPU and CPU, with the fastest solution returned automatically. -Mixed Integer Linear Programming (MILP) -========================================= +Mixed Integer Linear Programming (MILP) (Beta) +============================================== + +.. note:: Support for mixed integer linear programming is currently in **beta**. A **Mixed Integer Linear Program** is a variant of a Linear Program where some of the variables are restricted to take on only integer values, while other variables can vary continuously. NVIDIA cuOpt uses a hybrid GPU/CPU method: running primal heuristics on the GPU and improving the dual bound on the CPU.