Transition Guide for Change in Features#

In addition to the quality improvements, some new features were added, and some features were deprecated to improve user experience. For any questions, please reach out to the cuOpt team through NGC.

Parameter/option statuses are listed below, they express how each of these options are affected:

New - A new feature has been added.

Update - A change in definition of feature.

Deprecated - These are “no operation” options, they will be accepted by the server, but they will not be used anywhere. And the solver will also return a warning about them being deprecated.

Limited - These options are limited with respect to the number of dimensions that can be provided.

Removed - These features were deprecated in previous release and completely removed in this one.

Initial Solution#

Status:

  • New

Former:

  • Not supported

Current:

  • Only applicable to routing.

  • Initial solution can be shared with new requests using old solutions or generated solutions to boost solver search.

PDLP Warm Start#

Status:

  • New

Former:

  • Not supported

Current:

  • Only applicable for LP.

  • Previous solutions can be fed using their request IDs to the new solver request to provide a boost for searching solutions.

Server logging on client side using callback#

Status:

  • New

Former:

  • Not supported

Current:

  • Only applicable to LP and MILP.

  • Server side logging can be accessed using a callback function through endpoint.

  • cli already has a inbuilt callback, so enabling the option will get you logs.

Incumbent solution for MILP using callback#

Status:

  • New

Former:

  • Not supported

Current:

  • Only applicable to MILP.

  • Incumbent solution can be queried intermittently while solver is still searching for solution using a callback.

  • cli already has a inbuilt callback, so enabling the option will get you details.

MIP and LP statistics in response#

Status:

  • Update

Former:

  • Both were intertwined and had some default values if it’s a invalid setting.

Current:

  • LP and MILP stats are separate.

  • If the stats is invalid, it will be None or empty.

Branch and Bound#

Status:

  • New

Former:

  • Not Supported

Current:

  • Only applicable to MILP.

  • Option to enable/disable branch and bound on MILP.

  • Option to configure number of threads that branch and bound can use.

API Endpoint Self-Hosted#

/cuopt/request/{id}

Status:

  • New

Former:

  • Not Supported

Current:

  • Only gets status of the particular request.

/cuopt/solution

Status:

  • New

Former:

  • Not Supported

Current:

  • To upload a solution which can be used as initial solution routing.

GET/DELETE /cuopt/solution/{id}

Status:

  • New

Former:

  • Not Supported

Current:

  • Retrieve solution for a submitted request or saved solution.

  • Delete a solution for a submitted request or saved solution.

/cuopt/solution/{id}/incumbents

Status:

  • New

Former:

  • Not Supported

Current:

  • Only applicable for MILP.

  • Pull incumbent solutions for MILP while the solver is busy solving for better results.

GET/DELETE /cuopt/log/{id}

Status:

  • New

Former:

  • Not Supported

Current:

  • GET/DELETE solver logs for MILP and LP while the solver is running on a request.

/cuopt/routes and /cuopt/lp

Status:

  • Deprecated

Former:

  • Supported

Current:

  • Use /cuopt/request.

On this page