Add success attribute to OptimizationResults and raise Exepction `i…

…f not success`
fau-advanced-separations · Mar 22, 2024 · 9478b91 · 9478b91
1 parent d59c7fd
commit 9478b91
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1 deletion.
diff --git a/CADETProcess/optimization/axAdapater.py b/CADETProcess/optimization/axAdapater.py
@@ -455,6 +455,10 @@ def run(self, optimization_problem, x0):
 
         print(exp_to_df(self.ax_experiment))
 
+        self.results.success = True
+        self.results.exit_flag = 0
+        self.results.exit_message = global_stopping_message
+
 
 class SingleObjectiveAxInterface(AxInterface):
     def _setup_optimization_config(self, objectives, outcome_constraints):

diff --git a/CADETProcess/optimization/optimizer.py b/CADETProcess/optimization/optimizer.py
@@ -265,6 +265,11 @@ def optimize(
 
         plt.switch_backend(backend)
 
+        if not self.results.success:
+            raise CADETProcessError(
+                f"Optimizaton failed with message: {self.results.exit_message}"
+            )
+
         return self.results
 
     @abstractmethod

diff --git a/CADETProcess/optimization/pymooAdapter.py b/CADETProcess/optimization/pymooAdapter.py
@@ -169,12 +169,15 @@ def run(self, optimization_problem: OptimizationProblem, x0=None):
             self.run_post_processing(X, F, G, CV, algorithm.n_gen-1, X_opt)
 
         if algorithm.n_gen >= n_max_gen:
-            exit_message = 'Max number of generations exceeded.'
+            success = True
             exit_flag = 1
+            exit_message = 'Max number of generations exceeded.'
         else:
+            success = False
             exit_flag = 0
             exit_message = 'success'
 
+        self.results.success = success
         self.results.exit_flag = exit_flag
         self.results.exit_message = exit_message
 

diff --git a/CADETProcess/optimization/results.py b/CADETProcess/optimization/results.py
@@ -31,6 +31,8 @@ class OptimizationResults(Structure):
         Optimization problem.
     optimizer : OptimizerBase
         Optimizer used to optimize the OptimizationProblem.
+    success : bool
+        True if optimization was successfully terminated. False otherwise.
     exit_flag : int
         Information about the solver termination.
     exit_message : str
@@ -56,6 +58,7 @@ class OptimizationResults(Structure):
         functions.
 
     """
+    success = Bool(default=False)
     exit_flag = UnsignedInteger()
     exit_message = String()
     time_elapsed = UnsignedFloat()

diff --git a/CADETProcess/optimization/scipyAdapter.py b/CADETProcess/optimization/scipyAdapter.py
@@ -136,6 +136,7 @@ def callback_function(x, state=None):
                 callback=callback_function,
             )
 
+        self.results.success = bool(scipy_results.success)
         self.results.exit_flag = scipy_results.status
         self.results.exit_message = scipy_results.message