Components¶
Below is a brief introduction to the most important components of the code to orientate first-time users. GloMPO is implemented in a modular way such that all decision criteria are customizable.
Note
If a module is not mentioned below, then its contents is probably not intended to be used directly by users.
coreThis module contains the most important GloMPO components:
manager.pyContains
GloMPOManagerthe primary point of entry into the code. The manager performs the optimization, accepts all settings, and produces all the output.checkpointing.pyContains
CheckpointingControlwhich configures GloMPO’s ability to save a snapshot of itself during an optimization from which it can resume later.function.pyAn API template for the optimization task from which it may, but need not, inherit.
optimizerlogger.pyContains classes used to record optimizations in memory and save them to file. Users should not need to work with these classes directly
opt_selectorsEach file contains a different
BaseSelectorchild-class. These objects decide which optimizer configuration to start from a list of options.optimizersEach file contains a different
BaseOptimizerchild-class. These are implementations or wrappers around actual optimization algorithms.generatorsEach file contains a different
BaseGeneratorchild-class. These are algorithms which decide where optimizers are started within the search domain.exitconditionsEach file contains a different
BaseExitConditionchild-class. These are simple conditions which control GloMPO’s overall termination conditions.stoppersEach file contains a different
BaseStopperchild-class. These are termination conditions which, if satisfied, will get GloMPO to trigger an early termination of a particular optimizer.analysisModule containing classes related to parameter sensitivity analysis
hsic.pyContains the class
HSICto compute new results andHSICResultto load previous ones.kernels.pyContains the kernels needed for the HSIC calculation. Users can use
BaseKernelto implement their own kernels.
- Manager
- Optimizers
- Selectors
- Generators
- Exit Conditions
- Stoppers
- Checkpointing
- Sensitivity Analysis
- Extras
- Named Tuples
- Helpers
BoundGroupCheckpointingErrorFlowListLiteralWrapperSplitOptimizerLogsStopInterruptWorkInDirectory__all__bound_group_presenter()deepsizeof()distance()flow_presenter()generator_presenter()glompo_colors()infer_headers()is_bounds_valid()literal_presenter()nested_string_formatting()number_available_cores()numpy_array_presenter()numpy_dtype_presenter()optimizer_selector_presenter()present_memory()rolling_min()unknown_object_presenter()unravel()
- Wrappers