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. For example, cuOpt-23.08 solver supports only one break per (e.g., lunch break).

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

Feasible/Infeasible Solution

No change

solver_config

No change

fleet_data

All time windows
Status:
  • Update

Former:
  • Float type was expected

Current:
  • Int type is expected

vehicle_break_time_windows
Status:
  • Update

Former:
  • With cuOpt-23.08 the number of dimensions for break is limited to 1.

Current:
  • Lists of tuples of earliest and latest break time for each vehicle.

  • There can be multiple such lists for different breaks (lunch break, tea break, etc.).

vehicle_break_durations
Status:
  • Update

Former:
  • With cuOpt-23.08 the number of dimensions for break duration is limited to 1.

Current:
  • Lists of break duration time for each vehicle.

  • There can be multiple such lists for different breaks (lunch break, tea break, etc.).

vehicle_fixed_costs
status:
  • New

Current:
  • Provides support for assigning costs for using a vehicle.

priorities
Status:
  • Removed

Former:
  • Vehicle with higher priority would be considered more compared to other lower priority ones.

Suggestion:
  • Use vehicle fixed costs instead.

task_data

All time windows
Status:
  • Update

Former:
  • Float type was expected

Current:
  • Int type is expected

priorities
Status:
  • Removed

Former:
  • Tasks with higher priority would be considered more compared to other lower priority ones.

Suggestion:
  • Use prize collection to accomplish this.

mandatory_task_ids
Status:
  • Removed

Former:
  • Supports drop_infeasible_tasks option to make sure mandatory tasks are not dropped.

Suggestion:
  • Not required since drop_infeasible_tasks is removed.

solver_config

drop_infeasible_tasks
Status:
  • Removed

Former:
  • Drops tasks which might not be feasible.

Suggestion:
  • Use prize collection to accomplish this.

API Endpoint Self-Hosted

/cuopt/get_routes/
Status:
  • Deprecated

Suggestion:
  • Please start using /cuopt/routes/ endpoint.