Manager Module

libEnsemble manager routines

manager.manager_main(hist, libE_specs, alloc_specs, sim_specs, gen_specs, exit_criteria, persis_info, wcomms=[])

Manager routine to coordinate the generation and simulation evaluations

Parameters:

  • hist (libensemble.history.History) – A libEnsemble history type object.

  • libE_specs (dict) – Specifications for libEnsemble

  • alloc_specs (dict) – Specifications for the allocation function

  • sim_specs (dict) – Specifications for the simulation function

  • gen_specs (dict) – Specifications for the generator function

  • exit_criteria (dict) – Criteria for libEnsemble to stop a run

  • persis_info (dict) – Persistent information to be passed between user functions

  • wcomms (list, Optional) – A list of comm type objects for each worker. Default is an empty list.

Return type:

(<class ‘dict’>, <class ‘int’>, <class ‘int’>)

class manager.Manager(hist, libE_specs, alloc_specs, sim_specs, gen_specs, exit_criteria, wcomms=[])

Manager class for libensemble.

Parameters:

  • hist (ndarray[Any, dtype[_ScalarType_co]]) –

  • libE_specs (dict) –

  • alloc_specs (dict) –

  • sim_specs (dict) –

  • gen_specs (dict) –

  • exit_criteria (dict) –

  • wcomms (list) –

__init__(hist, libE_specs, alloc_specs, sim_specs, gen_specs, exit_criteria, wcomms=[])

Initializes the manager

Parameters:

  • hist (ndarray[Any, dtype[_ScalarType_co]]) –

  • libE_specs (dict) –

  • alloc_specs (dict) –

  • sim_specs (dict) –

  • gen_specs (dict) –

  • exit_criteria (dict) –

  • wcomms (list) –

term_test_wallclock(max_elapsed)

Checks against wallclock timeout

Parameters:

max_elapsed (int) –

Return type:

bool

term_test_sim_max(sim_max)

Checks against max simulations

Parameters:

sim_max (int) –

Return type:

bool

term_test_gen_max(gen_max)

Checks against max generator calls

Parameters:

gen_max (int) –

Return type:

bool

term_test_stop_val(stop_val)

Checks against stop value criterion

Parameters:

stop_val (Any) –

Return type:

bool

term_test(logged=True)

Checks termination criteria

Parameters:

logged (bool) –

Return type:

bool | int

run(persis_info)

Runs the manager

Parameters:

persis_info (dict) –

Return type:

(<class ‘dict’>, <class ‘int’>, <class ‘int’>)