Better ensemble.add_random_streams docstring, don't erase persis_info

libensemble/ensemble.py

@@ -494,13 +494,29 @@ def from_json(self, file_path: str):
         self._parameterize(loaded)
 
     def add_random_streams(self, num_streams: int = 0, seed: str = ""):
-        """Adds ``np.random`` generators for each worker to ``persis_info``"""
+        """
+
+        Adds ``np.random`` generators for each worker ID to ``self.persis_info``.
+
+        Parameters
+        ----------
+
+        num_streams: int, optional
+
+            Number of matching worker ID and random stream entries to create. Defaults to
+            ``self.nworkers``.
+
+        seed: str, optional
+
+            Seed for NumPy's RNG
+
+        """
         if num_streams:
             nstreams = num_streams
         else:
             nstreams = self._nworkers()
 
-        self.persis_info = add_unique_random_streams({}, nstreams + 1, seed=seed)
+        self.persis_info = add_unique_random_streams(self.persis_info, nstreams + 1, seed=seed)
         return self.persis_info
 
     def save_output(self, file: str):

libensemble/tests/regression_tests/test_1d_sampling.py

@@ -21,6 +21,7 @@
 # Import libEnsemble items for this test
 from libensemble.sim_funcs.one_d_func import one_d_example as sim_f
 from libensemble.specs import ExitCriteria, GenSpecs, LibeSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 # Main block is necessary only when using local comms with spawn start method (default on macOS and Windows).
 if __name__ == "__main__":
@@ -38,7 +39,7 @@
         },
     )
 
-    sampling.add_random_streams()
+    sampling.persis_info = add_unique_random_streams({}, sampling.nworkers + 1)
     sampling.exit_criteria = ExitCriteria(gen_max=501)
 
     sampling.run()

libensemble/tests/regression_tests/test_GPU_variable_resources.py

@@ -36,6 +36,7 @@
 from libensemble.sim_funcs import six_hump_camel
 from libensemble.sim_funcs.var_resources import gpu_variable_resources_from_gen as sim_f
 from libensemble.specs import AllocSpecs, ExitCriteria, GenSpecs, LibeSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 # from libensemble import logger
 # logger.set_level("DEBUG")  # For testing the test
@@ -83,7 +84,7 @@
         },
     )
 
-    gpu_test.add_random_streams()
+    gpu_test.persis_info = add_unique_random_streams({}, gpu_test.nworkers + 1)
     gpu_test.exit_criteria = ExitCriteria(sim_max=40)
     gpu_test.run()
 

libensemble/tests/regression_tests/test_GPU_variable_resources_multi_task.py

@@ -47,6 +47,7 @@
 from libensemble.sim_funcs import six_hump_camel
 from libensemble.sim_funcs.var_resources import gpu_variable_resources_from_gen as sim_f
 from libensemble.specs import AllocSpecs, ExitCriteria, GenSpecs, LibeSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 # from libensemble import logger
 # logger.set_level("DEBUG")  # For testing the test
@@ -95,7 +96,7 @@
         },
     )
 
-    gpu_test.add_random_streams()
+    gpu_test.persis_info = add_unique_random_streams({}, gpu_test.nworkers + 1)
     gpu_test.exit_criteria = ExitCriteria(sim_max=40, wallclock_max=300)
 
     if gpu_test.ready():

libensemble/tests/regression_tests/test_inverse_bayes_example.py

@@ -25,6 +25,7 @@
 from libensemble.gen_funcs.persistent_inverse_bayes import persistent_updater_after_likelihood as gen_f
 from libensemble.sim_funcs.inverse_bayes import likelihood_calculator as sim_f
 from libensemble.specs import AllocSpecs, ExitCriteria, GenSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 # Main block is necessary only when using local comms with spawn start method (default on macOS and Windows).
 if __name__ == "__main__":
@@ -57,7 +58,7 @@
         alloc_specs=AllocSpecs(alloc_f=alloc_f),
     )
 
-    bayes_test.add_random_streams()
+    bayes_test.persis_info = add_unique_random_streams({}, bayes_test.nworkers + 1)
     gen_user = bayes_test.gen_specs.user
     val = gen_user["subbatch_size"] * gen_user["num_subbatches"] * gen_user["num_batches"]
     bayes_test.exit_criteria = ExitCriteria(sim_max=val, wallclock_max=300)

libensemble/tests/regression_tests/test_persistent_fd_param_finder.py

@@ -29,6 +29,7 @@
 from libensemble.sim_funcs.noisy_vector_mapping import func_wrapper as sim_f
 from libensemble.sim_funcs.noisy_vector_mapping import noisy_function
 from libensemble.specs import AllocSpecs, ExitCriteria, GenSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 # Main block is necessary only when using local comms with spawn start method (default on macOS and Windows).
 if __name__ == "__main__":
@@ -62,7 +63,7 @@
         alloc_specs=AllocSpecs(alloc_f=alloc_f),
         exit_criteria=ExitCriteria(gen_max=1000),
     )
-    fd_test.add_random_streams()
+    fd_test.persis_info = add_unique_random_streams({}, fd_test.nworkers + 1)
 
     shutil.copy("./scripts_used_by_reg_tests/ECnoise.m", "./")
 

libensemble/tests/regression_tests/test_persistent_surmise_calib.py

@@ -40,6 +40,7 @@
 from libensemble.sim_funcs.surmise_test_function import borehole as sim_f
 from libensemble.sim_funcs.surmise_test_function import tstd2theta
 from libensemble.specs import AllocSpecs, ExitCriteria, GenSpecs, SimSpecs
+from libensemble.tools import add_unique_random_streams
 
 if __name__ == "__main__":
 
@@ -100,7 +101,7 @@
         exit_criteria=ExitCriteria(sim_max=max_evals),
     )
 
-    test.add_random_streams()
+    test.persis_info = add_unique_random_streams({}, test.nworkers + 1)
 
     # Perform the run
     H, _, _ = test.run()

libensemble/tests/scaling_tests/forces/forces_adv/run_libe_forces_from_yaml.py

@@ -6,6 +6,7 @@
 
 from libensemble.ensemble import Ensemble
 from libensemble.executors.mpi_executor import MPIExecutor
+from libensemble.tools import add_unique_random_streams
 
 ####################
 
@@ -36,7 +37,7 @@
     }
 )
 
-forces.add_random_streams()
+forces.persis_info = add_unique_random_streams({}, forces.nworkers + 1)
 
 forces.run()
 forces.save_output(__file__)