Interactive Dashboards#

Primal Interactive Dashboard#

pepflow.launch_primal_interactive(pep_builder: PEPBuilder, context: PEPContext, resolve_parameters: dict[str, NUMERICAL_TYPE] | None = None, port: int = 8050, jupyter_mode: str | None = 'external')#

Launch the Primal PEP Interactive Dashboard.

Variables:

  • pep_builder (PEPBuilder) – The PEPBuilder object whose associated Primal PEP problem we consider.

  • context (PEPContext) – The PEPContext object associated with the Primal PEP problem.

  • resolve_parameters (dict[str, NUMERICAL_TYPE] | None) – A dictionary that maps the name of parameters to the numerical values.

  • port (int) – The port where we host the Primal PEP Interactive Dashboard.

  • jupyter_mode (str | None) – A string to specify how to launch the PEP Interactive Dashboard. Default is “external”. Other options are “tab”, “jupyterlab”, or None. If None, then the PEP Interactive Dashboard will launch inline.

Example

>>> pf.launch_primal_interactive(pb, ctx, resolve_parameters={"L": 1})

Dual Interactive Dashboard#

pepflow.launch_dual_interactive(pep_builder: PEPBuilder, context: PEPContext, port: int = 9050, resolve_parameters: dict[str, NUMERICAL_TYPE] | None = None)#

Launch the Dual PEP Interactive Dashboard.

Variables:

  • pep_builder (PEPBuilder) – The PEPBuilder object whose associated Dual PEP problem we consider.

  • context (PEPContext) – The PEPContext object associated with the Dual PEP problem.

  • resolve_parameters (dict[str, NUMERICAL_TYPE] | None) – A dictionary that maps the name of parameters to the numerical values.

  • port (int) – The port where we host the Dual PEP Interactive Dashboard.

Example

>>> pf.launch_dual_interactive(pb, ctx, resolve_parameters={"L": 1})