Feature/ddp example

tests/test_cmaes.py

@@ -28,14 +28,14 @@ def test_cmaes_basic(cma_adapter, mpi_tmp_path: pathlib.Path) -> None:
         The temporary checkpoint directory.
     """
     rng = random.Random(42)  # Separate random number generator for optimization.
-    function, limits = get_function_search_space("sphere")
+    benchmark_function, limits = get_function_search_space("sphere")
     # Set up evolutionary operator.
     adapter = cma_adapter
     propagator = CMAPropagator(adapter, limits, rng=rng)
 
     # Set up Propulator performing actual optimization.
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,

tests/test_island.py

@@ -20,15 +20,15 @@ def global_variables():
     rng = random.Random(
         42 + MPI.COMM_WORLD.rank
     )  # Set up separate random number generator for optimization.
-    function, limits = get_function_search_space(
+    benchmark_function, limits = get_function_search_space(
         "sphere"
     )  # Get function and search space to optimize.
     propagator = get_default_propagator(
         pop_size=4,
         limits=limits,
         rng=rng,
     )  # Set up evolutionary operator.
-    yield rng, function, limits, propagator
+    yield rng, benchmark_function, limits, propagator
 
 
 @pytest.fixture(
@@ -62,12 +62,12 @@ def test_islands(
     mpi_tmp_path : pathlib.Path
         The temporary checkpoint directory.
     """
-    rng, function, limits, propagator = global_variables
+    rng, benchmark_function, limits, propagator = global_variables
     set_logger_config(log_file=mpi_tmp_path / "log.log")
 
     # Set up island model.
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -100,12 +100,12 @@ def test_checkpointing_isolated(
     mpi_tmp_path : pathlib.Path
         The temporary checkpoint directory.
     """
-    rng, function, limits, propagator = global_variables
+    rng, benchmark_function, limits, propagator = global_variables
     set_logger_config(log_file=mpi_tmp_path / "log.log")
 
     # Set up island model.
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -121,7 +121,7 @@ def test_checkpointing_isolated(
     del islands
 
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -160,12 +160,12 @@ def test_checkpointing(
     mpi_tmp_path : pathlib.Path
         The temporary checkpoint directory.
     """
-    rng, function, limits, propagator = global_variables
+    rng, benchmark_function, limits, propagator = global_variables
     set_logger_config(log_file=mpi_tmp_path / "log.log")
 
     # Set up island model.
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -185,7 +185,7 @@ def test_checkpointing(
     del islands
 
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -225,12 +225,12 @@ def test_checkpointing_unequal_populations(
     mpi_tmp_path : pathlib.Path
         The temporary checkpoint directory.
     """
-    rng, function, limits, propagator = global_variables
+    rng, benchmark_function, limits, propagator = global_variables
     set_logger_config(log_file=mpi_tmp_path / "log.log")
 
     # Set up island model.
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -251,7 +251,7 @@ def test_checkpointing_unequal_populations(
     del islands
 
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,

tests/test_propulator.py

@@ -50,15 +50,15 @@ def test_propulator(function_name: str, mpi_tmp_path: pathlib.Path) -> None:
     rng = random.Random(
         42 + MPI.COMM_WORLD.rank
     )  # Random number generator for optimization
-    function, limits = get_function_search_space(function_name)
+    benchmark_function, limits = get_function_search_space(function_name)
     set_logger_config(log_file=mpi_tmp_path / "log.log")
     propagator = get_default_propagator(
         pop_size=4,
         limits=limits,
         rng=rng,
     )  # Set up evolutionary operator.
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=100,
@@ -81,15 +81,15 @@ def test_propulator_checkpointing(mpi_tmp_path: pathlib.Path) -> None:
     rng = random.Random(
         42 + MPI.COMM_WORLD.rank
     )  # Separate random number generator for optimization
-    function, limits = get_function_search_space("sphere")
+    benchmark_function, limits = get_function_search_space("sphere")
 
     propagator = get_default_propagator(  # Get default evolutionary operator.
         pop_size=4,  # Breeding pool size
         limits=limits,  # Search-space limits
         rng=rng,  # Random number generator
     )
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         generations=100,
         checkpoint_path=mpi_tmp_path,
@@ -105,7 +105,7 @@ def test_propulator_checkpointing(mpi_tmp_path: pathlib.Path) -> None:
     MPI.COMM_WORLD.barrier()  # Synchronize all processes.
 
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         generations=20,
         checkpoint_path=mpi_tmp_path,

tutorials/cmaes_example.py

@@ -1,4 +1,5 @@
 """Simple example script using CMA-ES."""
+
 import pathlib
 import random
 
@@ -36,7 +37,7 @@
     rng = random.Random(
         config.seed + comm.rank
     )  # Separate random number generator for optimization.
-    function, limits = get_function_search_space(
+    benchmark_function, limits = get_function_search_space(
         config.function
     )  # Get callable function + search-space limits.
 
@@ -52,7 +53,7 @@
 
     # Set up propulator performing actual optimization.
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         island_comm=comm,

tutorials/islands_example.py

@@ -1,4 +1,5 @@
 """Simple island model example script."""
+
 import pathlib
 import random
 
@@ -31,7 +32,7 @@
     rng = random.Random(
         config.seed + comm.rank
     )  # Separate random number generator for optimization.
-    function, limits = get_function_search_space(
+    benchmark_function, limits = get_function_search_space(
         config.function
     )  # Get callable function + search-space limits.
 
@@ -58,7 +59,7 @@
 
     # Set up island model.
     islands = Islands(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         generations=config.generations,

tutorials/propulator_example.py

@@ -1,4 +1,5 @@
 """Simple Propulator example script using the default genetic propagator."""
+
 import pathlib
 import random
 
@@ -35,7 +36,7 @@
     rng = random.Random(
         config.seed + comm.rank
     )  # Separate random number generator for optimization.
-    function, limits = get_function_search_space(
+    benchmark_function, limits = get_function_search_space(
         config.function
     )  # Get callable function + search-space limits.
     # Set up evolutionary operator.
@@ -50,7 +51,7 @@
 
     # Set up propulator performing actual optimization.
     propulator = Propulator(
-        loss_fn=function,
+        loss_fn=benchmark_function,
         propagator=propagator,
         rng=rng,
         island_comm=comm,

tutorials/pso_example.py

@@ -4,6 +4,7 @@
 You can choose between benchmark functions and optimize them. The example shows how to set up Propulate in order to use
 it with PSO.
 """
+
 import pathlib
 import random
 
@@ -47,7 +48,7 @@
     rng = random.Random(
         config.seed + comm.rank
     )  # Separate random number generator for optimization.
-    function, limits = get_function_search_space(
+    benchmark_function, limits = get_function_search_space(
         config.function
     )  # Get callable function + search-space limits.
 
@@ -91,7 +92,7 @@
     propagator = Conditional(config.pop_size, pso_propagator, init)
 
     propulator = Propulator(
-        function,
+        benchmark_function,
         propagator,
         rng=rng,
         island_comm=comm,