Skip to content

Commit 0908ab9

Browse files
committed
fix links
1 parent 13a2c2b commit 0908ab9

File tree

10 files changed

+23
-17
lines changed

10 files changed

+23
-17
lines changed

docs/cuopt/source/cuopt-c/lp-milp/lp-example.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ LP C API Examples
55
Example With Data
66
-----------------
77

8-
This example demonstrates how to use the LP solver in C. More details on the API can be found in `C API <lp-milp-c-api.html>`_.
8+
This example demonstrates how to use the LP solver in C. More details on the API can be found in :doc:`C API <lp-milp-c-api>`.
99

1010
Copy the code below into a file called ``lp_example.c``:
1111

docs/cuopt/source/cuopt-c/lp-milp/lp-milp-c-api.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ Certain constants are needed to define an optimization problem. These constants
4848
Objective Sense Constants
4949
-------------------------
5050

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.
5252

5353
.. doxygendefine:: CUOPT_MINIMIZE
5454
.. doxygendefine:: CUOPT_MAXIMIZE
5555

5656
Constraint Sense Constants
5757
--------------------------
5858

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.
6060

6161
.. doxygendefine:: CUOPT_LESS_THAN
6262
.. doxygendefine:: CUOPT_GREATER_THAN
@@ -65,15 +65,15 @@ These constants are used to define the constraint sense in the `cuOptCreateProbl
6565
Variable Type Constants
6666
-----------------------
6767

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.
6969

7070
.. doxygendefine:: CUOPT_CONTINUOUS
7171
.. doxygendefine:: CUOPT_INTEGER
7272

7373
Infinity Constant
7474
-----------------
7575

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.
7777

7878
.. doxygendefine:: CUOPT_INFINITY
7979

docs/cuopt/source/cuopt-c/lp-milp/milp-examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ MILP C API Examples
55
Example With Data
66
-----------------
77

8-
This example demonstrates how to use the MILP solver in C. More details on the API can be found in `C API <lp-milp-c-api.html>`_.
8+
This example demonstrates how to use the MILP solver in C. More details on the API can be found in :doc:`C API <lp-milp-c-api>`.
99

1010
Copy the code below into a file called ``milp_example.c``:
1111

docs/cuopt/source/cuopt-server/csp-guides/csp-aws.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Step 1: Create an AWS VM with NVAIE Image
4646
Step 2: Activate NVAIE Subscription
4747
------------------------------------
4848

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>`__.
5050

5151
Step 3: Run cuOpt
5252
------------------

docs/cuopt/source/cuopt-server/csp-guides/csp-azure.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ Step 1: Create an Azure VM with NVAIE Image
5656
Step 2: Activate NVAIE Subscription
5757
------------------------------------
5858

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>`__.
6060

6161
Step 3: Run cuOpt
6262
------------------
6363

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>`.
6565

6666

6767
Step 4: Mapping Visualization with Azure

docs/cuopt/source/cuopt-server/examples/lp-examples.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ If you want to run server locally, please run the following command in a termina
1515
export port=5000
1616
python -m cuopt_server.cuopt_service --ip $ip --port $port
1717
18+
.. _generic-example-with-normal-and-batch-mode:
19+
1820
Genric Example With Normal Mode and Batch Mode
1921
------------------------------------------------
2022

@@ -225,6 +227,8 @@ Batch mode response:
225227
.. note::
226228
Warm start is only applicable to LP and not for MILP.
227229

230+
.. _warm-start:
231+
228232
Warm Start
229233
----------
230234

docs/cuopt/source/cuopt-server/quick-start.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ After installation, you can verify that cuOpt Server is working correctly by run
104104
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.
105105

106106
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>`.
108108

109109

110110
Install jq and curl for basic HTTP requests and parsing JSON responses

docs/cuopt/source/faq.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ General FAQ
4545
4646
.. dropdown:: Do I need a GPU to use cuOpt?
4747

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.
4949

5050
.. dropdown:: Does cuOpt use multiple GPUs/multi-GPUs/multi GPUs?
5151

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>`.
5353
#. There is no support for leveraging multiple GPUs to solve a single problem or oversubscribing a single GPU for multiple solvers.
5454

5555
.. dropdown:: The cuOpt Service is not starting: Issue with port?
@@ -249,7 +249,7 @@ Routing FAQ
249249
250250
#. cuOpt is stateless and cannot handle dynamic constraints directly, but this can be resolved with modeling.
251251
#. 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.
253253
254254
.. dropdown:: Does cuOpt take an initial solution?
255255

docs/cuopt/source/lp-features.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Warm Start
5353

5454
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.
5555

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.
5757

5858
PDLP Solver Mode
5959
----------------
@@ -73,12 +73,12 @@ Method
7373
Crossover
7474
---------
7575

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>`.
7777

7878

7979
Logging Callback
8080
----------------
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.
8282

8383

8484
Infeasibility Detection
@@ -102,4 +102,4 @@ The user may specify a time limit to the solver. By default the solver runs unti
102102
Batch Mode
103103
----------
104104

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.

docs/cuopt/source/lp-milp-settings.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ detected as infeasible for PDLP to stop.
133133

134134
Note: the default value is false.
135135

136+
.. _crossover:
137+
136138
Crossover
137139
^^^^^^^^^
138140

0 commit comments

Comments
 (0)