NL Formulation

.circleci/config.yml

@@ -10,20 +10,3 @@ workflows:
       - dwave/test-linux
       - dwave/test-osx
       - dwave/test-win
-
-  weekly:
-    triggers:
-      - schedule:
-          cron: "0 2 * * 6"
-          filters:
-            branches:
-              only:
-                - master
-                - main
-    jobs:
-      - dwave/test-linux:
-          integration-tests: "canary"
-      - dwave/test-osx:
-          integration-tests: "skip"
-      - dwave/test-win:
-          integration-tests: "skip"

demo_callbacks.py

@@ -14,6 +14,8 @@
 from __future__ import annotations
 
 import math
+from dataclasses import asdict
+from typing import Union
 
 import dash
 import pandas as pd
@@ -29,8 +31,10 @@
     REQUESTED_SHIFT_ICON,
     SMALL_SCENARIO,
     UNAVAILABLE_ICON,
+    USE_NL,
 )
 from demo_interface import errors_list, generate_forecast_table
+from src.demo_enums import SolverType
 
 
 @dash.callback(
@@ -208,10 +212,10 @@ def display_initial_schedule(
         {"display": "none"},
         count,
         count,
-        [num_employees]*len(count),
+        [num_employees] * len(count),
         new_full_time_max,
         full_time_marks,
-        num_full_time
+        num_full_time,
     )
 
 
@@ -309,34 +313,41 @@ def run_optimization(
     if run_click == 0 or ctx.triggered_id != "run-button":
         raise PreventUpdate
 
+    solver_type = SolverType.NL if USE_NL else SolverType.CQM
     shifts = list(sched_df["props"]["data"][0].keys())
     shifts.remove("Employee")
 
     availability = utils.availability_to_dict(sched_df["props"]["data"])
     employees = list(availability.keys())
 
-    isolated_days_allowed = True if 0 in checklist else False
-
     forecast = [
-        val if isinstance(val, int)
-        else forecast_placeholder[i]
-        for i, val in enumerate(forecast)
+        val if isinstance(val, int) else forecast_placeholder[i] for i, val in enumerate(forecast)
     ]
 
-    cqm = employee_scheduling.build_cqm(
-        availability,
-        shifts,
-        *shifts_per_employee,
-        forecast,
-        isolated_days_allowed,
-        consecutive_shifts + 1,
-        num_full_time,
+    params = utils.ModelParams(
+        availability=availability,
+        shifts=shifts,
+        min_shifts=min(shifts_per_employee),
+        max_shifts=max(shifts_per_employee),
+        shift_forecast=forecast,
+        allow_isolated_days_off=0 in checklist,
+        max_consecutive_shifts=consecutive_shifts,
+        num_full_time=num_full_time,
     )
 
-    sampleset, errors = employee_scheduling.run_cqm(cqm)
-    sample = sampleset.first.sample
+    if solver_type is SolverType.NL:
+        model, assignments = employee_scheduling.build_nl(**asdict(params))
+        errors = employee_scheduling.run_nl(model, assignments, **asdict(params))
+        sched = utils.build_schedule_from_state(assignments.state(), employees, shifts)
+
+    else:  # CQM
+        cqm = employee_scheduling.build_cqm(**asdict(params))
+
+        feasible_sampleset, errors = employee_scheduling.run_cqm(cqm)
+        sample = feasible_sampleset.first.sample
+
+        sched = utils.build_schedule_from_sample(sample, employees)
 
-    sched = utils.build_schedule_from_sample(sample, employees)
     scheduled_count = sched.map(lambda cell: UNAVAILABLE_ICON not in cell).sum()[1:].to_dict()
 
     return (

demo_configs.py

@@ -37,6 +37,7 @@
 # Optional: None or an integer
 RANDOM_SEED = None
 
+USE_NL = False  # Uses NL if True, otherwise uses CQM
 
 #######################################
 # Sliders, buttons and option entries #
@@ -58,7 +59,7 @@
     "value": 12,
 }
 
-# number of full time employees slider (value means default)
+# number of full-time employees slider (value means default)
 NUM_FULL_TIME = {
     "min": 0,
     "max": 9,

demo_interface.py

@@ -83,6 +83,28 @@ def range_slider(label: str, id: str, config: dict) -> html.Div:
     )
 
 
+def dropdown(label: str, id: str, options: list) -> html.Div:
+    """Dropdown element for option selection.
+    Args:
+        label: The title that goes above the dropdown.
+        id: A unique selector for this element.
+        options: A list of dictionaries of labels and values.
+    """
+    return html.Div(
+        className="dropdown-wrapper",
+        children=[
+            html.Label(label),
+            dcc.Dropdown(
+                id=id,
+                options=options,
+                value=options[0]["value"],
+                clearable=False,
+                searchable=False,
+            ),
+        ],
+    )
+
+
 def generate_options(options_list: list) -> list[dict]:
     """Generates options for dropdowns, checklists, radios, etc."""
     return [{"label": label, "value": i} for i, label in enumerate(options_list)]
@@ -100,17 +122,10 @@ def generate_settings_form() -> html.Div:
         className="settings",
         id="control-card",
         children=[
-            html.Div(
-                children=[
-                    html.Label("Presets (sets sliders below)"),
-                    dcc.Dropdown(
-                        id="example-scenario-select",
-                        options=example_scenario,
-                        value=example_scenario[0]["value"],
-                        clearable=False,
-                        searchable=False,
-                    ),
-                ]
+            dropdown(
+                "Presets (sets sliders below)",
+                "example-scenario-select",
+                example_scenario,
             ),
             slider(
                 "Employees",
@@ -186,11 +201,20 @@ def generate_run_buttons() -> html.Div:
 
 def generate_forecast_table(forecast: list, scheduled: dict) -> html.Div:
     """Generate the forecasted vs scheduled table"""
-    forecast = {scheduled_key: forecast_value for scheduled_key, forecast_value in zip(scheduled.keys(), forecast)}
+    forecast = {
+        scheduled_key: forecast_value
+        for scheduled_key, forecast_value in zip(scheduled.keys(), forecast)
+    }
     return html.Div(
         className="schedule-forecast",
         children=[
-            html.Div([html.Label("Forecasted Need:"), html.Label("Scheduled Employees:"), html.Label("Difference:")]),
+            html.Div(
+                [
+                    html.Label("Forecasted Need:"),
+                    html.Label("Scheduled Employees:"),
+                    html.Label("Difference:"),
+                ]
+            ),
             dash_table.DataTable(
                 id="forecast-output",
                 columns=([{"id": p, "name": p} for p in forecast.keys()]),
@@ -227,7 +251,7 @@ def create_interface():
                     "num-full-time-select": NUM_FULL_TIME["value"],
                     "consecutive-shifts-select": MAX_CONSECUTIVE_SHIFTS["value"],
                     "shifts-per-employee-select": MIN_MAX_SHIFTS["value"],
-                }
+                },
             ),
             dcc.Store(id="submission_indicator"),
             # Header brand banner
@@ -289,42 +313,54 @@ def create_interface():
                                                             html.Div(
                                                                 className="schedule-forecast schedule-forecast-input",
                                                                 children=[
-                                                                    html.Label("Staffing Requirements:"),
+                                                                    html.Label(
+                                                                        "Staffing Requirements:"
+                                                                    ),
                                                                     html.Div(
                                                                         [
                                                                             dcc.Input(
-                                                                                id={"index": param, "type": "forecast"},
+                                                                                id={
+                                                                                    "index": param,
+                                                                                    "type": "forecast",
+                                                                                },
                                                                                 type="number",
                                                                                 debounce=True,
                                                                                 value=0,
                                                                                 min=0,
                                                                                 max=100,
                                                                                 required=True,
-                                                                            ) for param in COL_IDS
+                                                                            )
+                                                                            for param in COL_IDS
                                                                         ],
-                                                                        id="forecast-input"
-                                                                    )
+                                                                        id="forecast-input",
+                                                                    ),
                                                                 ],
                                                             ),
                                                         ],
                                                     ),
                                                     html.Div(
                                                         className="legend",
                                                         children=[
-                                                            html.Div([
-                                                                html.Div(
-                                                                    className="requested-shifts",
-                                                                    children=[REQUESTED_SHIFT_ICON],
-                                                                ),
-                                                                html.Label("Requested"),
-                                                            ]),
-                                                            html.Div([
-                                                                html.Div(
-                                                                    className="unavailable-shifts",
-                                                                    children=[UNAVAILABLE_ICON],
-                                                                ),
-                                                                html.Label("Unavailable"),
-                                                            ]),
+                                                            html.Div(
+                                                                [
+                                                                    html.Div(
+                                                                        className="requested-shifts",
+                                                                        children=[
+                                                                            REQUESTED_SHIFT_ICON
+                                                                        ],
+                                                                    ),
+                                                                    html.Label("Requested"),
+                                                                ]
+                                                            ),
+                                                            html.Div(
+                                                                [
+                                                                    html.Div(
+                                                                        className="unavailable-shifts",
+                                                                        children=[UNAVAILABLE_ICON],
+                                                                    ),
+                                                                    html.Label("Unavailable"),
+                                                                ]
+                                                            ),
                                                         ],
                                                     ),
                                                 ],
@@ -358,21 +394,33 @@ def create_interface():
                                                     html.Div(
                                                         className="legend",
                                                         children=[
-                                                            html.Div([
-                                                                html.Div(className="scheduled-shifts"),
-                                                                html.Label("Scheduled"),
-                                                            ]),
-                                                            html.Div([
-                                                                html.Div(
-                                                                    className="unscheduled-requested-shifts",
-                                                                    children=[REQUESTED_SHIFT_ICON],
-                                                                ),
-                                                                html.Label("Unscheduled requested"),
-                                                            ]),
-                                                            html.Div([
-                                                                html.Div(UNAVAILABLE_ICON),
-                                                                html.Label("Unavailable"),
-                                                            ]),
+                                                            html.Div(
+                                                                [
+                                                                    html.Div(
+                                                                        className="scheduled-shifts"
+                                                                    ),
+                                                                    html.Label("Scheduled"),
+                                                                ]
+                                                            ),
+                                                            html.Div(
+                                                                [
+                                                                    html.Div(
+                                                                        className="unscheduled-requested-shifts",
+                                                                        children=[
+                                                                            REQUESTED_SHIFT_ICON
+                                                                        ],
+                                                                    ),
+                                                                    html.Label(
+                                                                        "Unscheduled requested"
+                                                                    ),
+                                                                ]
+                                                            ),
+                                                            html.Div(
+                                                                [
+                                                                    html.Div(UNAVAILABLE_ICON),
+                                                                    html.Label("Unavailable"),
+                                                                ]
+                                                            ),
                                                         ],
                                                     ),
                                                 ],

requirements.txt

@@ -1,5 +1,6 @@
 dash[diskcache]==2.16.1
 dash-bootstrap-components==1.6.0
-dwave-ocean-sdk>=6.7
+dwave-ocean-sdk>=7.0.0
+dwave-optimization>=0.4.2
 Faker==21.0.0
 pandas>=2.0

src/demo_enums.py

@@ -0,0 +1,29 @@
+# Copyright 2024 D-Wave
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from enum import Enum
+
+
+class SolverType(Enum):
+    """Enum class representing the solver types used in the demo."""
+
+    CQM = 0  # Default value for application dropdown
+    NL = 1
+
+    @property
+    def label(self):
+        return {
+            SolverType.CQM: "CQM",
+            SolverType.NL: "Nonlinear",
+        }[self]