From 4976f2801bc0aa8074d2ab43a1be0064d6ad2358 Mon Sep 17 00:00:00 2001 From: Ramakrishna Prabhu Date: Fri, 29 May 2026 16:00:40 -0500 Subject: [PATCH] docs: rename lp-qp-milp doc containers to numerical-optimization Rename the grouping doc directories and consolidated files that bundle LP, QP, and MILP together so adding a new problem type no longer forces a rename: cuopt-c/lp-qp-milp/ -> cuopt-c/numerical-optimization/ cuopt-python/lp-qp-milp/ -> cuopt-python/numerical-optimization/ lp-qp-milp-settings.rst -> numerical-optimization-settings.rst lp-qp-milp-c-api.rst -> numerical-optimization-c-api.rst lp-qp-milp-api.rst -> numerical-optimization-api.rst lp-qp-milp-examples.rst -> numerical-optimization-examples.rst All toctree entries and :doc: cross-references are updated accordingly. Per-type pages and example files (e.g. lp-qp-example.rst, milp-examples.rst, simple_lp_example.c) keep their type-specific names. Skill references to these paths will be updated separately. Co-Authored-By: Claude Opus 4.8 (1M context) Signed-off-by: Ramakrishna Prabhu --- docs/cuopt/source/cuopt-c/index.rst | 2 +- .../examples/Makefile | 0 .../examples/lp_file_example.c | 0 .../examples/milp_mps_example.c | 0 .../examples/mip_sample.mps | 0 .../examples/mps_file_example.c | 0 .../examples/sample.lp | 0 .../examples/sample.mps | 0 .../examples/simple_lp_example.c | 0 .../examples/simple_milp_example.c | 0 .../examples/simple_qp_example.c | 0 .../{lp-qp-milp => numerical-optimization}/index.rst | 4 ++-- .../lp-qp-example.rst | 2 +- .../milp-examples.rst | 2 +- .../numerical-optimization-c-api.rst} | 4 ++-- docs/cuopt/source/cuopt-cli/quick-start.rst | 2 +- docs/cuopt/source/cuopt-grpc/examples.rst | 8 ++++---- docs/cuopt/source/cuopt-grpc/quick-start.rst | 2 +- docs/cuopt/source/cuopt-python/index.rst | 2 +- .../examples/expressions_constraints_example.py | 0 .../examples/incumbent_solutions_example.py | 0 .../examples/pdlp_warmstart_example.py | 0 .../examples/production_planning_example.py | 0 .../examples/qp_matrix_example.py | 0 .../examples/semi_continuous_example.py | 0 .../examples/simple_lp_example.py | 0 .../examples/simple_milp_example.py | 0 .../examples/simple_qp_example.py | 0 .../examples/solution_example.py | 0 .../{lp-qp-milp => numerical-optimization}/index.rst | 4 ++-- .../numerical-optimization-api.rst} | 0 .../numerical-optimization-examples.rst} | 0 docs/cuopt/source/cuopt-server/examples/lp-examples.rst | 2 +- docs/cuopt/source/cuopt-server/server-api/index.rst | 2 +- ...p-settings.rst => numerical-optimization-settings.rst} | 2 +- docs/cuopt/source/transition.rst | 2 +- 36 files changed, 20 insertions(+), 20 deletions(-) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/Makefile (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/lp_file_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/milp_mps_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/mip_sample.mps (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/mps_file_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/sample.lp (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/sample.mps (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/simple_lp_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/simple_milp_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/examples/simple_qp_example.c (100%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/index.rst (74%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/lp-qp-example.rst (98%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp => numerical-optimization}/milp-examples.rst (98%) rename docs/cuopt/source/cuopt-c/{lp-qp-milp/lp-qp-milp-c-api.rst => numerical-optimization/numerical-optimization-c-api.rst} (98%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/expressions_constraints_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/incumbent_solutions_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/pdlp_warmstart_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/production_planning_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/qp_matrix_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/semi_continuous_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/simple_lp_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/simple_milp_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/simple_qp_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/examples/solution_example.py (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp => numerical-optimization}/index.rst (86%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp/lp-qp-milp-api.rst => numerical-optimization/numerical-optimization-api.rst} (100%) rename docs/cuopt/source/cuopt-python/{lp-qp-milp/lp-qp-milp-examples.rst => numerical-optimization/numerical-optimization-examples.rst} (100%) rename docs/cuopt/source/{lp-qp-milp-settings.rst => numerical-optimization-settings.rst} (99%) diff --git a/docs/cuopt/source/cuopt-c/index.rst b/docs/cuopt/source/cuopt-c/index.rst index 9f424cdcb9..2b01f80317 100644 --- a/docs/cuopt/source/cuopt-c/index.rst +++ b/docs/cuopt/source/cuopt-c/index.rst @@ -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 and MILP diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/Makefile b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/Makefile similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/Makefile rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/Makefile diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/lp_file_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/lp_file_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/lp_file_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/lp_file_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/milp_mps_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/milp_mps_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/milp_mps_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/milp_mps_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/mip_sample.mps b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/mip_sample.mps similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/mip_sample.mps rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/mip_sample.mps diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/mps_file_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/mps_file_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/mps_file_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/mps_file_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/sample.lp b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.lp similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/sample.lp rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.lp diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/sample.mps b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.mps similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/sample.mps rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/sample.mps diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_lp_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_lp_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_lp_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_lp_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_milp_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_milp_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_milp_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_milp_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_qp_example.c b/docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_qp_example.c similarity index 100% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/examples/simple_qp_example.c rename to docs/cuopt/source/cuopt-c/numerical-optimization/examples/simple_qp_example.c diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/index.rst b/docs/cuopt/source/cuopt-c/numerical-optimization/index.rst similarity index 74% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/index.rst rename to docs/cuopt/source/cuopt-c/numerical-optimization/index.rst index 57de6053a5..e96f2650df 100644 --- a/docs/cuopt/source/cuopt-c/lp-qp-milp/index.rst +++ b/docs/cuopt/source/cuopt-c/numerical-optimization/index.rst @@ -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 diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst b/docs/cuopt/source/cuopt-c/numerical-optimization/lp-qp-example.rst similarity index 98% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst rename to docs/cuopt/source/cuopt-c/numerical-optimization/lp-qp-example.rst index d4b981719c..be5d9a8a69 100644 --- a/docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-example.rst +++ b/docs/cuopt/source/cuopt-c/numerical-optimization/lp-qp-example.rst @@ -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 `. +This example demonstrates how to use the LP solver in C. More details on the API can be found in :doc:`C API `. The example code is available at ``examples/cuopt-c/lp/simple_lp_example.c`` (:download:`download `): diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst b/docs/cuopt/source/cuopt-c/numerical-optimization/milp-examples.rst similarity index 98% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst rename to docs/cuopt/source/cuopt-c/numerical-optimization/milp-examples.rst index a6d446d4b3..9bfc15fab4 100644 --- a/docs/cuopt/source/cuopt-c/lp-qp-milp/milp-examples.rst +++ b/docs/cuopt/source/cuopt-c/numerical-optimization/milp-examples.rst @@ -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 `. +This example demonstrates how to use the MILP solver in C. More details on the API can be found in :doc:`C API `. The example code is available at ``../lp-milp/examples/simple_milp_example.c`` (:download:`download `): diff --git a/docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-milp-c-api.rst b/docs/cuopt/source/cuopt-c/numerical-optimization/numerical-optimization-c-api.rst similarity index 98% rename from docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-milp-c-api.rst rename to docs/cuopt/source/cuopt-c/numerical-optimization/numerical-optimization-c-api.rst index ea9bf30925..beee7cf351 100644 --- a/docs/cuopt/source/cuopt-c/lp-qp-milp/lp-qp-milp-c-api.rst +++ b/docs/cuopt/source/cuopt-c/numerical-optimization/numerical-optimization-c-api.rst @@ -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 @@ -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 diff --git a/docs/cuopt/source/cuopt-cli/quick-start.rst b/docs/cuopt/source/cuopt-cli/quick-start.rst index c6012fe918..ad845bb50a 100644 --- a/docs/cuopt/source/cuopt-cli/quick-start.rst +++ b/docs/cuopt/source/cuopt-cli/quick-start.rst @@ -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. diff --git a/docs/cuopt/source/cuopt-grpc/examples.rst b/docs/cuopt/source/cuopt-grpc/examples.rst index 730db5f612..a4393738d0 100644 --- a/docs/cuopt/source/cuopt-grpc/examples.rst +++ b/docs/cuopt/source/cuopt-grpc/examples.rst @@ -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`` ------------- diff --git a/docs/cuopt/source/cuopt-grpc/quick-start.rst b/docs/cuopt/source/cuopt-grpc/quick-start.rst index b3c0ca2cc1..0c137071bb 100644 --- a/docs/cuopt/source/cuopt-grpc/quick-start.rst +++ b/docs/cuopt/source/cuopt-grpc/quick-start.rst @@ -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`. diff --git a/docs/cuopt/source/cuopt-python/index.rst b/docs/cuopt/source/cuopt-python/index.rst index 49b805a801..94d789a7c8 100644 --- a/docs/cuopt/source/cuopt-python/index.rst +++ b/docs/cuopt/source/cuopt-python/index.rst @@ -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 and MILP diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/expressions_constraints_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/expressions_constraints_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/expressions_constraints_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/expressions_constraints_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/incumbent_solutions_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/incumbent_solutions_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/incumbent_solutions_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/incumbent_solutions_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/pdlp_warmstart_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/pdlp_warmstart_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/pdlp_warmstart_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/pdlp_warmstart_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/production_planning_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/production_planning_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/production_planning_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/production_planning_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/qp_matrix_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/qp_matrix_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/qp_matrix_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/qp_matrix_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/semi_continuous_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/semi_continuous_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/semi_continuous_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/semi_continuous_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_lp_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_lp_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_lp_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_lp_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_milp_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_milp_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_milp_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_milp_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_qp_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_qp_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/simple_qp_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/simple_qp_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/examples/solution_example.py b/docs/cuopt/source/cuopt-python/numerical-optimization/examples/solution_example.py similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/examples/solution_example.py rename to docs/cuopt/source/cuopt-python/numerical-optimization/examples/solution_example.py diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/index.rst b/docs/cuopt/source/cuopt-python/numerical-optimization/index.rst similarity index 86% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/index.rst rename to docs/cuopt/source/cuopt-python/numerical-optimization/index.rst index e7fb2f6445..55dd1d9652 100644 --- a/docs/cuopt/source/cuopt-python/lp-qp-milp/index.rst +++ b/docs/cuopt/source/cuopt-python/numerical-optimization/index.rst @@ -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 diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/lp-qp-milp-api.rst b/docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-api.rst similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/lp-qp-milp-api.rst rename to docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-api.rst diff --git a/docs/cuopt/source/cuopt-python/lp-qp-milp/lp-qp-milp-examples.rst b/docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-examples.rst similarity index 100% rename from docs/cuopt/source/cuopt-python/lp-qp-milp/lp-qp-milp-examples.rst rename to docs/cuopt/source/cuopt-python/numerical-optimization/numerical-optimization-examples.rst diff --git a/docs/cuopt/source/cuopt-server/examples/lp-examples.rst b/docs/cuopt/source/cuopt-server/examples/lp-examples.rst index 964d99680c..1d686723b3 100644 --- a/docs/cuopt/source/cuopt-server/examples/lp-examples.rst +++ b/docs/cuopt/source/cuopt-server/examples/lp-examples.rst @@ -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 ~~~~~~~~~~ diff --git a/docs/cuopt/source/cuopt-server/server-api/index.rst b/docs/cuopt/source/cuopt-server/server-api/index.rst index 23340843ba..4feb31a2a6 100644 --- a/docs/cuopt/source/cuopt-server/server-api/index.rst +++ b/docs/cuopt/source/cuopt-server/server-api/index.rst @@ -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 diff --git a/docs/cuopt/source/lp-qp-milp-settings.rst b/docs/cuopt/source/numerical-optimization-settings.rst similarity index 99% rename from docs/cuopt/source/lp-qp-milp-settings.rst rename to docs/cuopt/source/numerical-optimization-settings.rst index 985204e1b2..ce7f0f6b85 100644 --- a/docs/cuopt/source/lp-qp-milp-settings.rst +++ b/docs/cuopt/source/numerical-optimization-settings.rst @@ -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 ` in case of C API and in case of Server Thin client as raw strings. -Please refer to examples in :doc:`C ` and :doc:`Server Thin client ` for more details. +Please refer to examples in :doc:`C ` and :doc:`Server Thin client ` 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``. diff --git a/docs/cuopt/source/transition.rst b/docs/cuopt/source/transition.rst index 3c6e0aa9c6..d3e3cb421f 100644 --- a/docs/cuopt/source/transition.rst +++ b/docs/cuopt/source/transition.rst @@ -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 ------------------------------------