feature/libe_gen_wrapper + Feature/asktell aposmm

examples/dummy_aposmm_libE_gen/run_example.py

@@ -0,0 +1,99 @@
+"""Basic example of parallel random sampling with simulations."""
+
+from math import gamma, pi, sqrt
+import numpy as np
+from libensemble.generators import APOSMM
+import libensemble.gen_funcs
+
+libensemble.gen_funcs.rc.aposmm_optimizers = "nlopt"
+from optimas.core import VaryingParameter, Objective
+from libensemble.tests.regression_tests.support import (
+    six_hump_camel_minima as minima,
+)
+
+# from optimas.generators import RandomSamplingGenerator
+from optimas.generators import libEWrapper
+from optimas.evaluators import TemplateEvaluator
+from optimas.explorations import Exploration
+
+from multiprocessing import set_start_method
+
+set_start_method("fork", force=True)
+
+
+def analyze_simulation(simulation_directory, output_params):
+    """Analyze the simulation output.
+
+    This method analyzes the output generated by the simulation to
+    obtain the value of the optimization objective and other analyzed
+    parameters, if specified. The value of these parameters has to be
+    given to the `output_params` dictionary.
+
+    Parameters
+    ----------
+    simulation_directory : str
+        Path to the simulation folder where the output was generated.
+    output_params : dict
+        Dictionary where the value of the objectives and analyzed parameters
+        will be stored. There is one entry per parameter, where the key
+        is the name of the parameter given by the user.
+
+    Returns
+    -------
+    dict
+        The `output_params` dictionary with the results from the analysis.
+
+    """
+    # Read back result from file
+    with open("result.txt") as f:
+        result = float(f.read())
+    # Fill in output parameters.
+    output_params["f"] = result
+    return output_params
+
+
+# Create varying parameters and objectives.
+var_1 = VaryingParameter("x0", -3.0, 3.0)
+var_2 = VaryingParameter("x1", -2.0, 2.0)
+obj = Objective("f")
+
+n = 2
+
+aposmm = APOSMM(
+    initial_sample_size=100,
+    localopt_method="LN_BOBYQA",
+    sample_points=np.round(minima, 1),
+    rk_const=0.5 * ((gamma(1 + (n / 2)) * 5) ** (1 / n)) / sqrt(pi),
+    xtol_abs=1e-2,
+    ftol_abs=1e-2,
+    dist_to_bound_multiple=0.5,
+    max_active_runs=4,  # refers to APOSMM's simul local optimization runs
+    lb=np.array([-3, -2]),  # potentially matches the VaryingParameters
+    ub=np.array([3, 2]),
+)
+
+gen = libEWrapper(
+    varying_parameters=[var_1, var_2],
+    objectives=[obj],
+    libe_gen_instance=aposmm,
+)
+
+# Create evaluator.
+ev = TemplateEvaluator(
+    sim_template="template_simulation_script.py",
+    analysis_func=analyze_simulation,
+)
+
+
+# Create exploration.
+exp = Exploration(
+    generator=gen, evaluator=ev, max_evals=300, sim_workers=4, run_async=True
+)
+
+
+# To safely perform exploration, run it in the block below (this is needed
+# for some flavours of multiprocessing, namely spawn and forkserver)
+if __name__ == "__main__":
+    exp.run()
+    assert len(gen.libe_gen.all_local_minima)
+    print(f"Found {len(gen.libe_gen.all_local_minima)} minima!")

examples/dummy_aposmm_libE_gen/template_simulation_script.py

@@ -0,0 +1,22 @@
+"""Simple template script used for demonstration.
+
+The script evaluates an analytical expression and stores the results in a
+`result.txt` file that is later read by the analysis function.
+"""
+
+import numpy as np
+
+# 2D function with multiple minima
+# result = -({{x0}} + 10 * np.cos({{x0}})) * ({{x1}} + 5 * np.cos({{x1}}))
+
+x1 = {{x0}}
+x2 = {{x1}}
+
+term1 = (4 - 2.1 * x1**2 + (x1**4) / 3) * x1**2
+term2 = x1 * x2
+term3 = (-4 + 4 * x2**2) * x2**2
+
+result = term1 + term2 + term3
+
+with open("result.txt", "w") as f:
+    f.write("%f" % result)

examples/dummy_random_libEgen/run_example.py

@@ -0,0 +1,76 @@
+"""Basic example of parallel random sampling with simulations."""
+
+from libensemble.gen_funcs.persistent_sampling import RandSample
+from optimas.core import VaryingParameter, Objective
+
+# from optimas.generators import RandomSamplingGenerator
+from optimas.generators import libEWrapper
+from optimas.evaluators import TemplateEvaluator
+from optimas.explorations import Exploration
+
+
+def analyze_simulation(simulation_directory, output_params):
+    """Analyze the simulation output.
+
+    This method analyzes the output generated by the simulation to
+    obtain the value of the optimization objective and other analyzed
+    parameters, if specified. The value of these parameters has to be
+    given to the `output_params` dictionary.
+
+    Parameters
+    ----------
+    simulation_directory : str
+        Path to the simulation folder where the output was generated.
+    output_params : dict
+        Dictionary where the value of the objectives and analyzed parameters
+        will be stored. There is one entry per parameter, where the key
+        is the name of the parameter given by the user.
+
+    Returns
+    -------
+    dict
+        The `output_params` dictionary with the results from the analysis.
+
+    """
+    # Read back result from file
+    with open("result.txt") as f:
+        result = float(f.read())
+    # Fill in output parameters.
+    output_params["f"] = result
+    return output_params
+
+
+# Create varying parameters and objectives.
+var_1 = VaryingParameter("x0", 0.0, 15.0)
+var_2 = VaryingParameter("x1", 0.0, 15.0)
+obj = Objective("f")
+
+
+# Create generator.
+# gen = RandomSamplingGenerator(
+#     varying_parameters=[var_1, var_2], objectives=[obj], distribution="normal"
+# )
+
+gen = libEWrapper(
+    varying_parameters=[var_1, var_2],
+    objectives=[obj],
+    libe_gen_class=RandSample,
+)
+
+# Create evaluator.
+ev = TemplateEvaluator(
+    sim_template="template_simulation_script.py",
+    analysis_func=analyze_simulation,
+)
+
+
+# Create exploration.
+exp = Exploration(
+    generator=gen, evaluator=ev, max_evals=10, sim_workers=4, run_async=True
+)
+
+
+# To safely perform exploration, run it in the block below (this is needed
+# for some flavours of multiprocessing, namely spawn and forkserver)
+if __name__ == "__main__":
+    exp.run()

examples/dummy_random_libEgen/template_simulation_script.py

@@ -0,0 +1,13 @@
+"""Simple template script used for demonstration.
+
+The script evaluates an analytical expression and stores the results in a
+`result.txt` file that is later read by the analysis function.
+"""
+
+import numpy as np
+
+# 2D function with multiple minima
+result = -({{x0}} + 10 * np.cos({{x0}})) * ({{x1}} + 5 * np.cos({{x1}}))
+
+with open("result.txt", "w") as f:
+    f.write("%f" % result)

optimas/gen_functions.py

@@ -48,6 +48,10 @@ def persistent_generator(H, persis_info, gen_specs, libE_info):
 
     # Get generator, objectives, and parameters to analyze.
     generator = gen_specs["user"]["generator"]
+
+    if hasattr(generator, "libe_gen_class"):
+        generator.init_libe_gen(H, persis_info, gen_specs, libE_info)
+
     objectives = generator.objectives
     analyzed_parameters = generator.analyzed_parameters
 
@@ -110,11 +114,16 @@ def persistent_generator(H, persis_info, gen_specs, libE_info):
                         ev = Evaluation(parameter=par, value=y)
                         trial.complete_evaluation(ev)
                 # Register trial with unknown SEM
-                generator.tell([trial])
+                if hasattr(generator, "libe_gen_class"):
+                    generator.tell([trial], libE_calc_in=calc_in[i])
+                else:
+                    generator.tell([trial])
             # Set the number of points to generate to that number:
             number_of_gen_points = min(n + n_failed_gens, max_evals - n_gens)
             n_failed_gens = 0
         else:
             number_of_gen_points = 0
 
+    if hasattr(generator, "libe_gen_class"):
+        return generator.final_tell(libE_calc_in=calc_in)
     return H_o, persis_info, FINISHED_PERSISTENT_GEN_TAG

optimas/generators/__init__.py

@@ -22,6 +22,7 @@
 from .grid_sampling import GridSamplingGenerator
 from .line_sampling import LineSamplingGenerator
 from .random_sampling import RandomSamplingGenerator
+from .libE_wrapper import libEWrapper
 
 
 __all__ = [
@@ -32,4 +33,5 @@
     "GridSamplingGenerator",
     "LineSamplingGenerator",
     "RandomSamplingGenerator",
+    "libEWrapper",
 ]

optimas/generators/base.py

@@ -237,7 +237,10 @@ def ask(self, n_trials: int) -> List[Trial]:
         return trials
 
     def tell(
-        self, trials: List[Trial], allow_saving_model: Optional[bool] = True
+        self,
+        trials: List[Trial],
+        allow_saving_model: Optional[bool] = True,
+        libE_calc_in: Optional[np.typing.NDArray] = None,
     ) -> None:
         """Give trials back to generator once they have been evaluated.
 
@@ -253,7 +256,10 @@ def tell(
         for trial in trials:
             if trial not in self._given_trials:
                 self._add_external_evaluated_trial(trial)
-        self._tell(trials)
+        if libE_calc_in is not None:
+            self._tell(trials, libE_calc_in)
+        else:
+            self._tell(trials)
         for trial in trials:
             if not trial.failed:
                 log_msg = "Completed trial {} with objective(s) {}".format(