Feature/nl formulation

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 *.py[cod]
 *$py.class
 cache.db*
+.venv

app.py

@@ -13,6 +13,7 @@
 #    limitations under the License.
 from __future__ import annotations
 
+import multiprocess
 from typing import TYPE_CHECKING, Any
 
 import diskcache
@@ -21,9 +22,16 @@
 
 import employee_scheduling
 import utils
-from app_configs import (APP_TITLE, DEBUG, LARGE_SCENARIO, MEDIUM_SCENARIO, MIN_MAX_EMPLOYEES,
-                         SMALL_SCENARIO)
+from app_configs import (
+    APP_TITLE,
+    DEBUG,
+    LARGE_SCENARIO,
+    MEDIUM_SCENARIO,
+    MIN_MAX_EMPLOYEES,
+    SMALL_SCENARIO,
+)
 from app_html import errors_list, set_html
+from src.demo_enums import SolverType
 
 if TYPE_CHECKING:
     from pandas import DataFrame
@@ -33,9 +41,8 @@
 
 # Fix for Dash background callbacks crashing on macOS 10.13+ (https://bugs.python.org/issue33725)
 # See https://github.com/dwave-examples/flow-shop-scheduling/pull/4 for more details.
-import multiprocess
 if multiprocess.get_start_method(allow_none=True) is None:
-    multiprocess.set_start_method('spawn')
+    multiprocess.set_start_method("spawn")
 
 app = Dash(
     __name__,
@@ -47,7 +54,9 @@
 
 
 @app.callback(
-    Output({"type": "to-collapse-class", "index": MATCH}, "className", allow_duplicate=True),
+    Output(
+        {"type": "to-collapse-class", "index": MATCH}, "className", allow_duplicate=True
+    ),
     inputs=[
         Input({"type": "collapse-trigger", "index": MATCH}, "n_clicks"),
         State({"type": "to-collapse-class", "index": MATCH}, "className"),
@@ -114,7 +123,10 @@ def set_scenario(
         shifts_per_employees,
         employees_per_shift,
         random_seed,
-        False, False, False, False
+        False,
+        False,
+        False,
+        False,
     )
 
 
@@ -129,7 +141,9 @@ def set_scenario(
         State("employees-per-shift-select", "tooltip"),
     ],
 )
-def update_employees_per_shift(value: int, tooltip: dict[str, Any]) -> tuple[int, dict, dict]:
+def update_employees_per_shift(
+    value: int, tooltip: dict[str, Any]
+) -> tuple[int, dict, dict]:
     """Update the employees-per-shift slider max if num-employees is changed."""
     marks = {
         MIN_MAX_EMPLOYEES["min"]: str(MIN_MAX_EMPLOYEES["min"]),
@@ -222,10 +236,7 @@ def custom_random_seed(value: int, scenario: int) -> int:
     Output("schedule-tab", "disabled", allow_duplicate=True),
     Output("tabs", "value"),
     Output({"type": "to-collapse-class", "index": 1}, "style", allow_duplicate=True),
-    inputs=[
-        Input("num-employees-select", "value"),
-        Input("seed-select", "value")
-    ],
+    inputs=[Input("num-employees-select", "value"), Input("seed-select", "value")],
 )
 def disp_initial_sched(
     num_employees: int, rand_seed: int
@@ -269,10 +280,7 @@ def update_error_sidebar(run_click: int, prev_classes) -> tuple[dict, str]:
     if "collapsed" in classes:
         return no_update, no_update
 
-    return (
-        {"display": "none"},
-        prev_classes + " collapsed"
-    )
+    return ({"display": "none"}, prev_classes + " collapsed")
 
 
 @app.callback(
@@ -288,11 +296,20 @@ def update_error_sidebar(run_click: int, prev_classes) -> tuple[dict, str]:
         State("checklist-input", "value"),
         State("consecutive-shifts-select", "value"),
         State("availability-content", "children"),
+        State("solver-select", "value"),
     ],
     running=[
         # show cancel button and hide run button, and disable and animate results tab
-        (Output("cancel-button", "style"), {"display": "inline-block"}, {"display": "none"}),
-        (Output("run-button", "style"), {"display": "none"}, {"display": "inline-block"}),
+        (
+            Output("cancel-button", "style"),
+            {"display": "inline-block"},
+            {"display": "none"},
+        ),
+        (
+            Output("run-button", "style"),
+            {"display": "none"},
+            {"display": "inline-block"},
+        ),
         # switch to schedule tab while running
         (Output("schedule-tab", "disabled"), False, False),
         (Output("tabs", "value"), "schedule-tab", "schedule-tab"),
@@ -308,6 +325,7 @@ def run_optimization(
     checklist: list[int],
     consecutive_shifts: int,
     sched_df: DataFrame,
+    solver: int,
 ) -> tuple[DataFrame, bool, dict, list]:
     """Run a job on the hybrid solver when the run button is clicked."""
     if run_click == 0 or ctx.triggered_id != "run-button":
@@ -322,20 +340,35 @@ def run_optimization(
     isolated_days_allowed = True if 0 in checklist else False
     manager_required = True if 1 in checklist else False
 
-    cqm = employee_scheduling.build_cqm(
-        availability,
-        shifts,
-        *shifts_per_employee,
-        *employees_per_shift,
-        manager_required,
-        isolated_days_allowed,
-        consecutive_shifts + 1,
+    params = utils.ModelParams(
+        availability=availability,
+        shifts=shifts,
+        min_shifts=min(shifts_per_employee),
+        max_shifts=max(shifts_per_employee),
+        shift_min=min(employees_per_shift),
+        shift_max=max(employees_per_shift),
+        requires_manager=manager_required,
+        allow_isolated_days_off=isolated_days_allowed,
+        max_consecutive_shifts=consecutive_shifts
     )
 
-    feasible_sampleset, errors = employee_scheduling.run_cqm(cqm)
-    sample = feasible_sampleset.first.sample
+    solver_type = SolverType(solver)
+
+    if solver_type == SolverType.CQM:
+        cqm = employee_scheduling.build_cqm(params)
+
+        feasible_sampleset, errors = employee_scheduling.run_cqm(cqm)
+        sample = feasible_sampleset.first.sample
+
+        sched = utils.build_schedule_from_sample(sample, employees)
+
+    elif solver_type == SolverType.NL:
+        model, assignments = employee_scheduling.build_nl(params)
+        errors = employee_scheduling.run_nl(model, assignments, params)
+        sched = utils.build_schedule_from_state(assignments.state(), employees, shifts)
 
-    sched = utils.build_schedule_from_sample(sample, employees)
+    else:
+        raise ValueError(f"Solver value `{solver_type.label}` is unhandled.")
 
     return (
         utils.display_schedule(sched, availability),

app_html.py

@@ -19,6 +19,7 @@
 
 from app_configs import (DESCRIPTION, EXAMPLE_SCENARIO, MAIN_HEADER, MAX_CONSECUTIVE_SHIFTS, MIN_MAX_EMPLOYEES,
                          MIN_MAX_SHIFTS, NUM_EMPLOYEES, REQUESTED_SHIFT_ICON, THUMBNAIL, UNAVAILABLE_ICON)
+from src.demo_enums import SolverType
 
 
 def description_card():
@@ -73,6 +74,29 @@ def range_slider(name: 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_control_card() -> html.Div:
     """Generates the control card for the dashboard.
 
@@ -81,21 +105,20 @@ def generate_control_card() -> html.Div:
         model, and solver.
     """
     example_scenario = [{"label": size, "value": i} for i, size in enumerate(EXAMPLE_SCENARIO)]
+    solver_options = [{"label": s.label, "value": s.value} for s in SolverType]
 
     return html.Div(
         id="control-card",
         children=[
-            html.Div(
-                children=[
-                    html.Label("Scenario preset (sets sliders below)"),
-                    dcc.Dropdown(
-                        id="example-scenario-select",
-                        options=example_scenario,
-                        value=example_scenario[0]["value"],
-                        clearable=False,
-                        searchable=False,
-                    ),
-                ]
+            dropdown(
+                "Solver",
+                "solver-select",
+                solver_options,
+            ),
+            dropdown(
+                "Scenario preset (sets sliders below)",
+                "example-scenario-select",
+                example_scenario
             ),
             # add sliders for employees and shifts
             slider(