Quickstart Guide#

cuopt_cli is built as part of the libcuopt package and you can follow these Quickstart Guide to install it.

To see all available options and their descriptions:

cuopt_cli --help

This will display the complete list of command-line arguments and their usage:

 1Setting CUDA_MODULE_LOADING to EAGER
 2Usage: cuopt_cli [--help] [--version] [--initial-solution VAR] [--relaxation] [--presolve] [--iteration-limit VAR] [--pdlp-solver-mode VAR] [--method VAR] [--num-cpu-threads VAR] [--augmented VAR] [--folding VAR] [--dualize VAR] [--ordering VAR] [--barrier-dual-initial-point VAR] [--time-limit VAR] [--absolute-dual-tolerance VAR] [--relative-dual-tolerance VAR] [--absolute-primal-tolerance VAR] [--relative-primal-tolerance VAR] [--absolute-gap-tolerance VAR] [--relative-gap-tolerance VAR] [--mip-absolute-tolerance VAR] [--mip-relative-tolerance VAR] [--mip-integrality-tolerance VAR] [--mip-absolute-gap VAR] [--mip-relative-gap VAR] [--primal-infeasible-tolerance VAR] [--dual-infeasible-tolerance VAR] [--infeasibility-detection VAR] [--strict-infeasibility VAR] [--per-constraint-residual VAR] [--save-best-primal-so-far VAR] [--first-primal-feasible VAR] [--mip-scaling VAR] [--mip-heuristics-only VAR] [--log-to-console VAR] [--crossover VAR] [--eliminate-dense-columns VAR] [--cudss-deterministic VAR] [--presolve VAR] [--dual-postsolve VAR] [--log-file VAR] [--solution-file VAR] [--user-problem-file VAR] filename
 3
 4Positional arguments:
 5  filename                       input mps file [required]
 6
 7Optional arguments:
 8  -h, --help                     shows help message and exits 
 9  -v, --version                  prints version information and exits 
10  --initial-solution             path to the initial solution .sol file [nargs=0..1] [default: ""]
11  --relaxation                   solve the LP relaxation of the MIP 
12  --presolve                     enable/disable presolve (default: true for MIP problems, false for LP problems) 
13  --iteration-limit              [nargs=0..1] [default: 2147483647]
14  --pdlp-solver-mode             [nargs=0..1] [default: 4]
15  --method                       [nargs=0..1] [default: 0]
16  --num-cpu-threads              [nargs=0..1] [default: -1]
17  --augmented                    [nargs=0..1] [default: -1]
18  --folding                      [nargs=0..1] [default: -1]
19  --dualize                      [nargs=0..1] [default: -1]
20  --ordering                     [nargs=0..1] [default: -1]
21  --barrier-dual-initial-point   [nargs=0..1] [default: -1]
22  --time-limit                   [nargs=0..1] [default: inf]
23  --absolute-dual-tolerance      [nargs=0..1] [default: 0.0001]
24  --relative-dual-tolerance      [nargs=0..1] [default: 0.0001]
25  --absolute-primal-tolerance    [nargs=0..1] [default: 0.0001]
26  --relative-primal-tolerance    [nargs=0..1] [default: 0.0001]
27  --absolute-gap-tolerance       [nargs=0..1] [default: 0.0001]
28  --relative-gap-tolerance       [nargs=0..1] [default: 0.0001]
29  --mip-absolute-tolerance       [nargs=0..1] [default: 0.0001]
30  --mip-relative-tolerance       [nargs=0..1] [default: 0.0001]
31  --mip-integrality-tolerance    [nargs=0..1] [default: 1e-05]
32  --mip-absolute-gap             [nargs=0..1] [default: 1e-10]
33  --mip-relative-gap             [nargs=0..1] [default: 0.0001]
34  --primal-infeasible-tolerance  [nargs=0..1] [default: 1e-08]
35  --dual-infeasible-tolerance    [nargs=0..1] [default: 1e-08]
36  --infeasibility-detection      [nargs=0..1] [default: false]
37  --strict-infeasibility         [nargs=0..1] [default: false]
38  --per-constraint-residual      [nargs=0..1] [default: false]
39  --save-best-primal-so-far      [nargs=0..1] [default: false]
40  --first-primal-feasible        [nargs=0..1] [default: false]
41  --mip-scaling                  [nargs=0..1] [default: true]
42  --mip-heuristics-only          [nargs=0..1] [default: false]
43  --log-to-console               [nargs=0..1] [default: true]
44  --crossover                    [nargs=0..1] [default: false]
45  --eliminate-dense-columns      [nargs=0..1] [default: true]
46  --cudss-deterministic          [nargs=0..1] [default: false]
47  --presolve                     [nargs=0..1] [default: false]
48  --dual-postsolve               [nargs=0..1] [default: true]
49  --log-file                     [nargs=0..1] [default: ""]
50  --solution-file                [nargs=0..1] [default: ""]
51  --user-problem-file            [nargs=0..1] [default: ""]

Please refer to LP and MILP Settings for more details on default values and other options.