cyrxnopt_analysis.alerts namespace

Submodules

cyrxnopt_analysis.alerts.Alert module

class cyrxnopt_analysis.alerts.Alert.Alert(throw: bool = False)[source]

Bases: ABC

process(results: List[OptimizerResult])[source]

Process the results, triggering the alarm if certain conditions are met.

Parameters:: results (List[Results]) – Result list to process
Raises:: RuntimeError – This function must be overridden in children.

property throw: bool

property triggered: bool

cyrxnopt_analysis.alerts.OverBudget module

class cyrxnopt_analysis.alerts.OverBudget.OverBudget(budget: int, throw: bool = False)[source]

Bases: Alert

property budget: int

property errors: List[OptimizerResult]

process(results: List[OptimizerResult])[source]

Process the results, triggering the alarm if certain conditions are met.

Parameters:: results (List[Results]) – Result list to process
Raises:: RuntimeError – This function must be overridden in children.