You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cuopt/source/cuopt-c/lp-milp/lp-milp-c-api.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,15 +48,15 @@ Certain constants are needed to define an optimization problem. These constants
48
48
Objective Sense Constants
49
49
-------------------------
50
50
51
-
These constants are used to define the objective sense in the `cuOptCreateProblem<lp-milp-c-api.html#c.cuOptCreateProblem>`_ and `cuOptCreateRangedProblem<lp-milp-c-api.html#c.cuOptCreateRangedProblem>`_ functions.
51
+
These constants are used to define the objective sense in the :c:func:`cuOptCreateProblem` and :c:func:`cuOptCreateRangedProblem` functions.
52
52
53
53
.. doxygendefine:: CUOPT_MINIMIZE
54
54
.. doxygendefine:: CUOPT_MAXIMIZE
55
55
56
56
Constraint Sense Constants
57
57
--------------------------
58
58
59
-
These constants are used to define the constraint sense in the `cuOptCreateProblem<lp-milp-c-api.html#c.cuOptCreateProblem>`_ and `cuOptCreateRangedProblem<lp-milp-c-api.html#c.cuOptCreateRangedProblem>`_ functions.
59
+
These constants are used to define the constraint sense in the :c:func:`cuOptCreateProblem` and :c:func:`cuOptCreateRangedProblem` functions.
60
60
61
61
.. doxygendefine:: CUOPT_LESS_THAN
62
62
.. doxygendefine:: CUOPT_GREATER_THAN
@@ -65,15 +65,15 @@ These constants are used to define the constraint sense in the `cuOptCreateProbl
65
65
Variable Type Constants
66
66
-----------------------
67
67
68
-
These constants are used to define the the variable type in the `cuOptCreateProblem<lp-milp-c-api.html#c.cuOptCreateProblem>`_ and `cuOptCreateRangedProblem<lp-milp-c-api.html#c.cuOptCreateRangedProblem>`_ functions.
68
+
These constants are used to define the the variable type in the :c:func:`cuOptCreateProblem` and :c:func:`cuOptCreateRangedProblem` functions.
69
69
70
70
.. doxygendefine:: CUOPT_CONTINUOUS
71
71
.. doxygendefine:: CUOPT_INTEGER
72
72
73
73
Infinity Constant
74
74
-----------------
75
75
76
-
This constant may be used to represent infinity in the `cuOptCreateProblem<lp-milp-c-api.html#c.cuOptCreateProblem>`_ and `cuOptCreateRangedProblem<lp-milp-c-api.html#c.cuOptCreateRangedProblem>`_ functions.
76
+
This constant may be used to represent infinity in the :c:func:`cuOptCreateProblem` and :c:func:`cuOptCreateRangedProblem` functions.
Copy file name to clipboardExpand all lines: docs/cuopt/source/cuopt-server/csp-guides/csp-aws.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ Step 1: Create an AWS VM with NVAIE Image
46
46
Step 2: Activate NVAIE Subscription
47
47
------------------------------------
48
48
49
-
Once connected to the VM, generate an identity token. Activate your NVIDIA AI Enterprise subscription using that identity token on NGC. Follow the instructions `here <https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/azure-ai-enterprise-vmi.html#accessing-the-nc-on-ngc>`__.
49
+
Once connected to the VM, generate an identity token. Activate your NVIDIA AI Enterprise subscription using that identity token on NGC. Follow the instructions `here <https://docs.nvidia.com/ai-enterprise/deployment/cloud/latest/azure-ai-enterprise-vmi.html#accessing-the-ngc-catalog-on-ngc>`__.
Copy file name to clipboardExpand all lines: docs/cuopt/source/cuopt-server/csp-guides/csp-azure.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,12 +56,12 @@ Step 1: Create an Azure VM with NVAIE Image
56
56
Step 2: Activate NVAIE Subscription
57
57
------------------------------------
58
58
59
-
Once connected to the VM, generate an identity token. Activate your NVIDIA AI Enterprise subscription using that identity token on NGC. Follow the instructions `here <https://docs.nvidia.com/ai-enterprise/deployment-guide-cloud/0.1.0/azure-ai-enterprise-vmi.html#accessing-the-nc-on-ngc>`__.
59
+
Once connected to the VM, generate an identity token. Activate your NVIDIA AI Enterprise subscription using that identity token on NGC. Follow the instructions `here <https://docs.nvidia.com/ai-enterprise/deployment/cloud/latest/azure-ai-enterprise-vmi.html#accessing-the-ngc-catalog-on-ngc>`__.
60
60
61
61
Step 3: Run cuOpt
62
62
------------------
63
63
64
-
To run cuOpt, you will need to log in to the NVIDIA Container Registry, pull the cuOpt container, and then run it. To test that it is successfully running, you can run a sample cuOpt request. This process is the same for deploying cuOpt on your own infrastructure. Refer `Self-Hosted Service Quickstart Guide </cuopt-server/quick-start.html#container-from-nvidia-ngc>`__.
64
+
To run cuOpt, you will need to log in to the NVIDIA Container Registry, pull the cuOpt container, and then run it. To test that it is successfully running, you can run a sample cuOpt request. This process is the same for deploying cuOpt on your own infrastructure. Refer :ref:`Self-Hosted Service Quickstart Guide <container-from-nvidia-ngc>`.
Copy file name to clipboardExpand all lines: docs/cuopt/source/cuopt-server/quick-start.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ After installation, you can verify that cuOpt Server is working correctly by run
104
104
The following example is for running the server locally. If you are using the container approach, you should comment out the server start and kill commands in the script below since the server is already running in the container.
105
105
106
106
The following example is testing with a simple routing problem constuctured as Json request and sent over HTTP to the server using ``curl``.This example is running server with few configuration options such as ``--ip`` and ``--port``.
107
-
Additional configuration options for server can be found in `Server CLI <server-api/server-cli.html>`_
107
+
Additional configuration options for server can be found in :doc:`Server CLI <server-api/server-cli>`.
108
108
109
109
110
110
Install jq and curl for basic HTTP requests and parsing JSON responses
Copy file name to clipboardExpand all lines: docs/cuopt/source/faq.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,11 +45,11 @@ General FAQ
45
45
46
46
.. dropdown:: Do I need a GPU to use cuOpt?
47
47
48
-
Yes, please refer to `system requirements <system-requirements.html>`_ for GPU specifications. You can acquire a cloud instance with a supported GPU and launch cuOpt; alternatively, you can launch it in your local machine if it meets the requirements.
48
+
Yes, please refer to :doc:`system requirements <system-requirements>` for GPU specifications. You can acquire a cloud instance with a supported GPU and launch cuOpt; alternatively, you can launch it in your local machine if it meets the requirements.
49
49
50
50
.. dropdown:: Does cuOpt use multiple GPUs/multi-GPUs/multi GPUs?
51
51
52
-
#. Yes, in cuOpt self-hosted server, a solver process per GPU can be configured to run multiple solvers. Requests are accepted in a round-robin queue. More details are available in `server api <cuopt-server/server-api/server-cli.html>`_.
52
+
#. Yes, in cuOpt self-hosted server, a solver process per GPU can be configured to run multiple solvers. Requests are accepted in a round-robin queue. More details are available in :doc:`server api <cuopt-server/server-api/server-cli>`.
53
53
#. There is no support for leveraging multiple GPUs to solve a single problem or oversubscribing a single GPU for multiple solvers.
54
54
55
55
.. dropdown:: The cuOpt Service is not starting: Issue with port?
@@ -249,7 +249,7 @@ Routing FAQ
249
249
250
250
#. cuOpt is stateless and cannot handle dynamic constraints directly, but this can be resolved with modeling.
251
251
#. Dynamic reoptimization is used when there is a change in the conditions of the operation such as a vehicle getting broken, a driver calling in sick, a road block, traffic, or a high-priority order coming in.
252
-
#. The problem is prepped in such a way that the packages that are already en route are assigned to only those vehicles, and new and old deliveries will be added to this problem. Please refer to example notebooks in `cuOpt Resources <resources.html>`__ to understand more about how to tackle this problem.
252
+
#. The problem is prepped in such a way that the packages that are already en route are assigned to only those vehicles, and new and old deliveries will be added to this problem. Please refer to example notebooks in :doc:`cuOpt Resources <resources>` to understand more about how to tackle this problem.
253
253
254
254
.. dropdown:: Does cuOpt take an initial solution?
Copy file name to clipboardExpand all lines: docs/cuopt/source/lp-features.rst
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ Warm Start
53
53
54
54
A warm starts allow a user to provide an initial solution to help PDLP converge faster. The initial ``primal`` and ``dual`` solutions can be specified by the user.
55
55
56
-
Alternatively, previously run solutions can be used to warm start a new solve to decrease solve time. `Examples <cuopt-server/lp-examples.html#warm-start>`_ are shared on the self-hosted page.
56
+
Alternatively, previously run solutions can be used to warm start a new solve to decrease solve time. :ref:`Examples <warm-start>` are shared on the self-hosted page.
57
57
58
58
PDLP Solver Mode
59
59
----------------
@@ -73,12 +73,12 @@ Method
73
73
Crossover
74
74
---------
75
75
76
-
Crossover allows you to obtain a high-quality basic solution from the results of a PDLP solve. More details can be found `here <lp-milp-settings.html#crossover>`__.
76
+
Crossover allows you to obtain a high-quality basic solution from the results of a PDLP solve. More details can be found :ref:`here <crossover>`.
77
77
78
78
79
79
Logging Callback
80
80
----------------
81
-
With logging callback, users can fetch server-side logs for additional debugs and to get details on solver process details. `Examples <cuopt-server/examples/lp-examples.html#logging-callback>`__ are shared on the self-hosted page.
81
+
With logging callback, users can fetch server-side logs for additional debugs and to get details on solver process details. :ref:`Examples <generic-example-with-normal-and-batch-mode>` are shared on the self-hosted page.
82
82
83
83
84
84
Infeasibility Detection
@@ -102,4 +102,4 @@ The user may specify a time limit to the solver. By default the solver runs unti
102
102
Batch Mode
103
103
----------
104
104
105
-
Users can submit a set of problems which will be solved in a batch. Problems will be solved at the same time in parallel to fully utilize the GPU. Checkout `self-hosted client <cuopt-server/examples/lp-examples.html#batch-mode>`_ example in thin client.
105
+
Users can submit a set of problems which will be solved in a batch. Problems will be solved at the same time in parallel to fully utilize the GPU. Checkout :ref:`self-hosted client <generic-example-with-normal-and-batch-mode>` example in thin client.
0 commit comments