Update remaining examples to use vocs

Author: shuds13

examples/astra/run_optimization_serial_ASTRA.py

@@ -9,34 +9,32 @@
 https://optimas.readthedocs.io/en/latest/index.html
 """
 
-from optimas.core import VaryingParameter, Objective, Parameter
 from optimas.generators import AxSingleFidelityGenerator
 from optimas.evaluators import TemplateEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 from analysis_script import analyze_simulation
 
-# Create varying parameters and objectives.
+# Create VOCS object.
 # name of parameter, lower bound of values to be explored,
 # upper bound of values to be explored
-var_1 = VaryingParameter("RF_phase", -2.5, 2.5)
-var_2 = VaryingParameter("B_sol", 0.12, 0.38)
-# Objectives that will be minimized:
-obj_1 = Objective("bunch_length", minimize=True)
-obj_2 = Objective("emittance", minimize=True)
-# Additional example parameters that will be analyzed but are not used for the
-# optimization:
-em_x = Parameter("emittance_x")
-em_y = Parameter("emittance_y")
+vocs = VOCS(
+    variables={
+        "RF_phase": [-2.5, 2.5],
+        "B_sol": [0.12, 0.38],
+    },
+    objectives={
+        "bunch_length": "MINIMIZE",
+        "emittance": "MINIMIZE",
+    },
+    observables=["emittance_x", "emittance_y"],
+)
 
 # Create generator.
 # Pick the generator to be used, here Single-fidelity Bayesian optimization.
-# The analyzed_parameters are parameters that are calculated for each
-# simulation but not used for the optimization.
 gen = AxSingleFidelityGenerator(
-    varying_parameters=[var_1, var_2],
-    objectives=[obj_1, obj_2],
+    vocs=vocs,
     n_init=8,
-    analyzed_parameters=[em_x, em_y],
 )
 
 

examples/hipace/run_example.py

@@ -10,30 +10,27 @@
 the `analysis_script.py` file.
 """
 
-from optimas.core import Parameter, VaryingParameter, Objective
 from optimas.generators import AxSingleFidelityGenerator
 from optimas.evaluators import TemplateEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 
 from analysis_script import analyze_simulation
 
 
-# Create varying parameters and objectives.
-var_1 = VaryingParameter("witness_charge", 0.05, 1.0)
-obj = Objective("f", minimize=False)
-
-
-# Define additional parameters to analyze.
-energy_med = Parameter("energy_med")
-energy_mad = Parameter("energy_mad")
-charge = Parameter("charge")
+# Create VOCS object.
+vocs = VOCS(
+    variables={
+        "witness_charge": [0.05, 1.0],
+    },
+    objectives={"f": "MAXIMIZE"},
+    observables=["energy_med", "energy_mad", "charge"],
+)
 
 
 # Create generator.
 gen = AxSingleFidelityGenerator(
-    varying_parameters=[var_1],
-    objectives=[obj],
-    analyzed_parameters=[energy_med, energy_mad, charge],
+    vocs=vocs,
     n_init=4,
 )
 

examples/multi_stage/run_example.py

@@ -10,32 +10,28 @@
 the `analysis_script.py` file.
 """
 
-from optimas.core import Parameter, VaryingParameter, Objective
 from optimas.generators import AxSingleFidelityGenerator
 from optimas.evaluators import TemplateEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 
 from analysis_script import analyze_simulation
 
 
-# Create varying parameters and objectives.
-var_1 = VaryingParameter("adjust_factor", 0.7, 1.05)
-var_2 = VaryingParameter("lens_start", 0.32, 0.347)
-obj = Objective("f", minimize=True)
-
-
-# Define additional parameters to analyze.
-energy_std = Parameter("energy_std")
-energy_avg = Parameter("energy_avg")
-charge = Parameter("charge")
-emittance = Parameter("emittance")
+# Create VOCS object.
+vocs = VOCS(
+    variables={
+        "adjust_factor": [0.7, 1.05],
+        "lens_start": [0.32, 0.347],
+    },
+    objectives={"f": "MINIMIZE"},
+    observables=["energy_std", "energy_avg", "charge", "emittance"],
+)
 
 
 # Create generator.
 gen = AxSingleFidelityGenerator(
-    varying_parameters=[var_1, var_2],
-    objectives=[obj],
-    analyzed_parameters=[energy_std, energy_avg, charge, emittance],
+    vocs=vocs,
     n_init=4,
 )
 

examples/multitask_lpa_fbpic_waket/run_opt.py

@@ -2,26 +2,27 @@
 
 from multiprocessing import set_start_method
 
-from optimas.core import VaryingParameter, Objective, Parameter, Task
+from optimas.core import Task
 from optimas.generators import AxMultitaskGenerator
 from optimas.evaluators import TemplateEvaluator, MultitaskEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 
 from analysis_script import analyze_simulation
 
 
-# Create varying parameters and objectives.
-var_1 = VaryingParameter("beam_i_1", 1.0, 10.0)  # kA
-var_2 = VaryingParameter("beam_i_2", 1.0, 10.0)  # kA
-var_3 = VaryingParameter("beam_z_i_2", -10.0, 10.0)  # µm
-var_4 = VaryingParameter("beam_length", 1.0, 20.0)  # µm
-obj = Objective("f", minimize=True)
-
-
-# Define other quantities to analyze (which are not the optimization objective)
-par_1 = Parameter("energy_med")
-par_2 = Parameter("energy_mad")
-par_3 = Parameter("charge")
+# Create VOCS object.
+vocs = VOCS(
+    variables={
+        "beam_i_1": [1.0, 10.0],  # kA
+        "beam_i_2": [1.0, 10.0],  # kA
+        "beam_z_i_2": [-10.0, 10.0],  # µm
+        "beam_length": [1.0, 20.0],  # µm
+        "trial_type": {"wake-t", "fbpic"},
+    },
+    objectives={"f": "MINIMIZE"},
+    observables=["energy_med", "energy_mad", "charge"],
+)
 
 
 # Create tasks.
@@ -31,9 +32,7 @@
 
 # Create generator.
 gen = AxMultitaskGenerator(
-    varying_parameters=[var_1, var_2, var_3, var_4],
-    objectives=[obj],
-    analyzed_parameters=[par_1, par_2, par_3],
+    vocs=vocs,
     use_cuda=True,
     dedicated_resources=True,
     hifi_task=hifi_task,

examples/wake_t/run_example.py

@@ -11,23 +11,25 @@
 file.
 """
 
-from optimas.core import VaryingParameter, Objective
 from optimas.generators import AxSingleFidelityGenerator
 from optimas.evaluators import TemplateEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 
 from analysis_script import analyze_simulation
 
 
-# Create varying parameters and objectives.
-var_1 = VaryingParameter("g_lens", 100.0, 1000.0)
-obj = Objective("f", minimize=True)
+# Create VOCS object.
+vocs = VOCS(
+    variables={
+        "g_lens": [100.0, 1000.0],
+    },
+    objectives={"f": "MINIMIZE"},
+)
 
 
 # Create generator.
-gen = AxSingleFidelityGenerator(
-    varying_parameters=[var_1], objectives=[obj], n_init=12
-)
+gen = AxSingleFidelityGenerator(vocs=vocs, n_init=12)
 
 
 # Create evaluator.

examples/wake_t_fbpic_mt/run_example.py

@@ -12,17 +12,23 @@
 file.
 """
 
-from optimas.core import VaryingParameter, Objective, Task
+from optimas.core import Task
 from optimas.generators import AxMultitaskGenerator
 from optimas.evaluators import TemplateEvaluator, MultitaskEvaluator
 from optimas.explorations import Exploration
+from generator_standard.vocs import VOCS
 
 from analysis_script import analyze_simulation
 
 
-# Create varying parameters and objectives.
-var_1 = VaryingParameter("g_lens", 100.0, 1000.0)
-obj = Objective("f", minimize=True)
+# Create VOCS object.
+vocs = VOCS(
+    variables={
+        "g_lens": [100.0, 1000.0],
+        "trial_type": {"wake-t", "fbpic"},
+    },
+    objectives={"f": "MINIMIZE"},
+)
 
 # Create tasks.
 lofi_task = Task("wake-t", n_init=12, n_opt=12)
@@ -31,8 +37,7 @@
 
 # Create generator.
 gen = AxMultitaskGenerator(
-    varying_parameters=[var_1],
-    objectives=[obj],
+    vocs=vocs,
     lofi_task=lofi_task,
     hifi_task=hifi_task,
 )