Quickstart Guide#

cuopt_cli is built as part of the libcuopt package and you can follow these instructions 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:

 1Usage: cuopt_cli [--help] [--version] [--initial-solution VAR] [--relaxation] [--iteration-limit VAR] [--pdlp-solver-mode VAR] [--method VAR] [--num-cpu-threads 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] [--log-file VAR] [--solution-file VAR] filename
 2
 3Positional arguments:
 4  filename                       input mps file [required]
 5
 6Optional arguments:
 7  -h, --help                     shows help message and exits 
 8  -v, --version                  prints version information and exits 
 9  --initial-solution             path to the initial solution .sol file [nargs=0..1] [default: ""]
10  --relaxation                   solve the LP relaxation of the MIP 
11  --iteration-limit              [nargs=0..1] [default: 2147483647]
12  --pdlp-solver-mode             [nargs=0..1] [default: 1]
13  --method                       [nargs=0..1] [default: 0]
14  --num-cpu-threads              [nargs=0..1] [default: -1]
15  --time-limit                   [nargs=0..1] [default: inf]
16  --absolute-dual-tolerance      [nargs=0..1] [default: 0.0001]
17  --relative-dual-tolerance      [nargs=0..1] [default: 0.0001]
18  --absolute-primal-tolerance    [nargs=0..1] [default: 0.0001]
19  --relative-primal-tolerance    [nargs=0..1] [default: 0.0001]
20  --absolute-gap-tolerance       [nargs=0..1] [default: 0.0001]
21  --relative-gap-tolerance       [nargs=0..1] [default: 0.0001]
22  --mip-absolute-tolerance       [nargs=0..1] [default: 0.0001]
23  --mip-relative-tolerance       [nargs=0..1] [default: 0.0001]
24  --mip-integrality-tolerance    [nargs=0..1] [default: 1e-05]
25  --mip-absolute-gap             [nargs=0..1] [default: 1e-10]
26  --mip-relative-gap             [nargs=0..1] [default: 0.0001]
27  --primal-infeasible-tolerance  [nargs=0..1] [default: 1e-08]
28  --dual-infeasible-tolerance    [nargs=0..1] [default: 1e-08]
29  --infeasibility-detection      [nargs=0..1] [default: false]
30  --strict-infeasibility         [nargs=0..1] [default: false]
31  --per-constraint-residual      [nargs=0..1] [default: false]
32  --save-best-primal-so-far      [nargs=0..1] [default: false]
33  --first-primal-feasible        [nargs=0..1] [default: false]
34  --mip-scaling                  [nargs=0..1] [default: true]
35  --mip-heuristics-only          [nargs=0..1] [default: false]
36  --log-to-console               [nargs=0..1] [default: true]
37  --crossover                    [nargs=0..1] [default: false]
38  --log-file                     [nargs=0..1] [default: ""]
39  --solution-file                [nargs=0..1] [default: ""]

Please refer to parameter settings for more details on default values and other options.