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/cuopt/source/cuopt-c/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ NVIDIA cuOpt supports a C API for GPU-accelerated optimization that enables user
:name: LP, QP and MILP Optimization
:titlesonly:

LP, QP and MILP <lp-qp-milp/index.rst>
LP, QP and MILP <numerical-optimization/index.rst>
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This section contains details on the cuOpt LP/QP/MILP C API.
:name: LP/QP/MILP
:titlesonly:

lp-qp-milp-c-api.rst
../../lp-qp-milp-settings.rst
numerical-optimization-c-api.rst
../../numerical-optimization-settings.rst
lp-qp-example.rst
milp-examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LP/QP C API Examples
Example With Data
-----------------

This example demonstrates how to use the LP solver in C. More details on the API can be found in :doc:`C API <lp-qp-milp-c-api>`.
This example demonstrates how to use the LP solver in C. More details on the API can be found in :doc:`C API <numerical-optimization-c-api>`.

The example code is available at ``examples/cuopt-c/lp/simple_lp_example.c`` (:download:`download <examples/simple_lp_example.c>`):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ MILP C API Examples
Example With Data
-----------------

This example demonstrates how to use the MILP solver in C. More details on the API can be found in :doc:`C API <lp-qp-milp-c-api>`.
This example demonstrates how to use the MILP solver in C. More details on the API can be found in :doc:`C API <numerical-optimization-c-api>`.

The example code is available at ``../lp-milp/examples/simple_milp_example.c`` (:download:`download <examples/simple_milp_example.c>`):

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ When you are done with a solve you should destroy a `cuOptSolverSettings` object

Setting Parameters
------------------
The following functions are used to set and get parameters. You can find more details on the available parameters in the :doc:`LP/MILP settings <../../lp-qp-milp-settings>` section.
The following functions are used to set and get parameters. You can find more details on the available parameters in the :doc:`LP/MILP settings <../../numerical-optimization-settings>` section.

.. doxygenfunction:: cuOptSetParameter
.. doxygenfunction:: cuOptGetParameter
Expand All @@ -156,7 +156,7 @@ The following functions are used to set and get parameters. You can find more de
Parameter Constants
-------------------

These constants are used as parameter names in the :c:func:`cuOptSetParameter`, :c:func:`cuOptGetParameter`, and similar functions. For more details on the available parameters, see the :doc:`LP/MILP settings <../../lp-qp-milp-settings>` section.
These constants are used as parameter names in the :c:func:`cuOptSetParameter`, :c:func:`cuOptGetParameter`, and similar functions. For more details on the available parameters, see the :doc:`LP/MILP settings <../../numerical-optimization-settings>` section.

.. LP/MIP parameter string constants
.. doxygendefine:: CUOPT_ABSOLUTE_DUAL_TOLERANCE
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-cli/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ This will display the complete list of command-line arguments and their usage:
:language: text
:linenos:

Please refer to :doc:`../lp-qp-milp-settings` for more details on default values and other options.
Please refer to :doc:`../numerical-optimization-settings` for more details on default values and other options.
8 changes: 4 additions & 4 deletions docs/cuopt/source/cuopt-grpc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ Where to find examples
Python (LP / QP / MILP)
-----------------------

* :doc:`../cuopt-python/lp-qp-milp/lp-qp-milp-examples` — runnable Python samples (LP, QP, MILP). With ``CUOPT_REMOTE_HOST`` and ``CUOPT_REMOTE_PORT`` set on the client, solves go to the remote server automatically.
* :doc:`../cuopt-python/numerical-optimization/numerical-optimization-examples` — runnable Python samples (LP, QP, MILP). With ``CUOPT_REMOTE_HOST`` and ``CUOPT_REMOTE_PORT`` set on the client, solves go to the remote server automatically.

C API (LP / QP / MILP)
----------------------

* :doc:`../cuopt-c/lp-qp-milp/lp-qp-example` — LP and QP C examples.
* :doc:`../cuopt-c/lp-qp-milp/milp-examples` — MILP C examples.
* :doc:`../cuopt-c/numerical-optimization/lp-qp-example` — LP and QP C examples.
* :doc:`../cuopt-c/numerical-optimization/milp-examples` — MILP C examples.

Compile and run these programs with the same exports in the shell; ``solve_lp`` / ``solve_mip`` use gRPC when both remote variables are set (see :doc:`../cuopt-c/lp-qp-milp/lp-qp-milp-c-api` for API reference).
Compile and run these programs with the same exports in the shell; ``solve_lp`` / ``solve_mip`` use gRPC when both remote variables are set (see :doc:`../cuopt-c/numerical-optimization/numerical-optimization-c-api` for API reference).

``cuopt_cli``
-------------
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-grpc/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ To solve **locally** with the same file:

More options (time limits, relaxation): :doc:`../cuopt-cli/quick-start` and :doc:`examples`.

**C API** — With the same environment variables set, call ``solve_lp`` / ``solve_mip`` as in :doc:`../cuopt-c/lp-qp-milp/lp-qp-milp-c-api`.
**C API** — With the same environment variables set, call ``solve_lp`` / ``solve_mip`` as in :doc:`../cuopt-c/numerical-optimization/numerical-optimization-c-api`.

More patterns (MPS variants, custom gRPC): :doc:`examples`.

Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-python/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ This section contains details on the cuOpt Python package.
:name: LP, QP and MILP API
:titlesonly:

LP, QP and MILP <lp-qp-milp/index.rst>
LP, QP and MILP <numerical-optimization/index.rst>
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ This section contains details on the cuOpt linear programming, quadratic program
:name: LP, QP and MILP
:titlesonly:

lp-qp-milp-api.rst
lp-qp-milp-examples.rst
numerical-optimization-api.rst
numerical-optimization-examples.rst
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-server/examples/lp-examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ Use a :class:`~cuopt.linear_programming.data_model.DataModel` built with
:func:`~cuopt.linear_programming.io.Read` as input to ``get_LP_solve``;
the client dispatches on the file extension (``.mps`` / ``.qps`` vs ``.lp``,
including ``.gz`` / ``.bz2`` compressed variants). For solver settings see
:doc:`LP/QP/MILP parameters <../../lp-qp-milp-settings>`.
:doc:`LP/QP/MILP parameters <../../numerical-optimization-settings>`.

MPS format
~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/cuopt-server/server-api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ This section contains details on Server options supported and open-api specifica

server-cli.rst
../../open-api.rst
../../lp-qp-milp-settings.rst
../../numerical-optimization-settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LP, QP, and MILP Settings


This page describes the parameter settings available for cuOpt's LP, QP, and MILP solvers. These parameters are set as :ref:`parameter constants <parameter-constants>` in case of C API and in case of Server Thin client as raw strings.
Please refer to examples in :doc:`C </cuopt-c/lp-qp-milp/index>` and :doc:`Server Thin client </cuopt-server/index>` for more details.
Please refer to examples in :doc:`C </cuopt-c/numerical-optimization/index>` and :doc:`Server Thin client </cuopt-server/index>` for more details.

.. note::
When setting parameters in thin client solver settings, remove ``CUOPT_`` from the parameter name and convert to lowercase. For example, ``CUOPT_TIME_LIMIT`` would be set as ``time_limit``.
Expand Down
2 changes: 1 addition & 1 deletion docs/cuopt/source/transition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Parameter/option statuses are listed below, they express how each of these optio

**Removed** - These features were deprecated in a previous release and completely removed in this one.

For all solver_configs fields, see the LP/QP/MILP settings guide :doc:`lp-qp-milp-settings` or the service openapi spec :doc:`open-api`.
For all solver_configs fields, see the LP/QP/MILP settings guide :doc:`numerical-optimization-settings` or the service openapi spec :doc:`open-api`.

Changes to solver_configs.tolerances
------------------------------------
Expand Down
Loading