|
| | pyhelios.wrappers.UParameterOptimizationWrapper._check_error (result, func, args) |
| | Automatic error checking for all parameter optimization functions.
|
| |
| bool | pyhelios.wrappers.UParameterOptimizationWrapper.isParameterOptimizationAvailable () |
| | Check if ParameterOptimization functions are available in this build.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper._require_available () |
| | Raise an actionable error if the plugin was not built into the library.
|
| |
| "ctypes._CFuncPtr" | pyhelios.wrappers.UParameterOptimizationWrapper._make_objective_trampoline (Callable[[Dict[str, float]], float] objective, Sequence[str] names, _CallbackState state) |
| | Wrap a Python objective as a C callback.
|
| |
| "ctypes._CFuncPtr" | pyhelios.wrappers.UParameterOptimizationWrapper._make_gradient_trampoline (Callable[[Dict[str, float]], Dict[str, float]] gradient, Sequence[str] names, _CallbackState state) |
| | Wrap a Python gradient function as a C callback.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper._write_gradient_dict (result, Sequence[str] names, out_ptr, int offset, str label) |
| | Validate a {name: partial derivative} mapping and write it out positionally.
|
| |
| "ctypes._CFuncPtr" | pyhelios.wrappers.UParameterOptimizationWrapper._make_constrained_trampoline (Callable[[Dict[str, float]], object] simulation, Sequence[str] names, int constraint_count, _CallbackState state) |
| | Wrap a Python constrained simulation as a C callback.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper._reraise (_CallbackState state) |
| | Re-raise the exception a callback stashed, preserving its traceback.
|
| |
| Tuple[ctypes.Array, list] | pyhelios.wrappers.UParameterOptimizationWrapper._build_parameter_array (List[dict] parameters) |
| | Build the C parameter array.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.destroyParameterOptimization (opt) |
| | Destroy a ParameterOptimization instance.
|
| |
| bool | pyhelios.wrappers.UParameterOptimizationWrapper.isAlgorithmAvailable (str algorithm_name) |
| | Check whether an algorithm can run in this build.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setGeneticAlgorithm (opt, PyHeliosGeneticAlgorithm settings) |
| | Select the genetic algorithm.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setBayesianOptimization (opt, PyHeliosBayesianOptimization settings) |
| | Select Bayesian optimization.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setCMAES (opt, PyHeliosCMAES settings) |
| | Select CMA-ES.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setAdam (opt, PyHeliosAdam settings) |
| | Select AdamW.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setLBFGS (opt, PyHeliosLBFGS settings) |
| | Select L-BFGS.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setBOBYQA (opt, PyHeliosBOBYQA settings) |
| | Select BOBYQA.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setSLSQP (opt, PyHeliosSLSQP settings) |
| | Select SLSQP.
|
| |
| | pyhelios.wrappers.UParameterOptimizationWrapper._fetch_preset (str function_name, struct_type) |
| | Read a settings preset from the native library.
|
| |
| PyHeliosGeneticAlgorithm | pyhelios.wrappers.UParameterOptimizationWrapper.getGeneticAlgorithmDefaults () |
| | Get the plugin's default genetic algorithm settings.
|
| |
| PyHeliosGeneticAlgorithm | pyhelios.wrappers.UParameterOptimizationWrapper.getGeneticAlgorithmExplore () |
| | Get the exploration-biased genetic algorithm preset.
|
| |
| PyHeliosGeneticAlgorithm | pyhelios.wrappers.UParameterOptimizationWrapper.getGeneticAlgorithmExploit () |
| | Get the exploitation-biased genetic algorithm preset.
|
| |
| PyHeliosBayesianOptimization | pyhelios.wrappers.UParameterOptimizationWrapper.getBayesianDefaults () |
| | Get the plugin's default Bayesian optimization settings.
|
| |
| PyHeliosBayesianOptimization | pyhelios.wrappers.UParameterOptimizationWrapper.getBayesianExplore () |
| | Get the exploration-biased Bayesian optimization preset.
|
| |
| PyHeliosBayesianOptimization | pyhelios.wrappers.UParameterOptimizationWrapper.getBayesianExploit () |
| | Get the exploitation-biased Bayesian optimization preset.
|
| |
| PyHeliosCMAES | pyhelios.wrappers.UParameterOptimizationWrapper.getCMAESDefaults () |
| | Get the plugin's default CMA-ES settings.
|
| |
| PyHeliosCMAES | pyhelios.wrappers.UParameterOptimizationWrapper.getCMAESExplore () |
| | Get the exploration-biased CMA-ES preset.
|
| |
| PyHeliosCMAES | pyhelios.wrappers.UParameterOptimizationWrapper.getCMAESExploit () |
| | Get the exploitation-biased CMA-ES preset.
|
| |
| PyHeliosLBFGS | pyhelios.wrappers.UParameterOptimizationWrapper.getLBFGSDefaults () |
| | Get the plugin's default L-BFGS settings.
|
| |
| PyHeliosAdam | pyhelios.wrappers.UParameterOptimizationWrapper.getAdamDefaults () |
| | Get the plugin's default Adam settings.
|
| |
| PyHeliosBOBYQA | pyhelios.wrappers.UParameterOptimizationWrapper.getBOBYQADefaults () |
| | Get the plugin's default BOBYQA settings.
|
| |
| PyHeliosSLSQP | pyhelios.wrappers.UParameterOptimizationWrapper.getSLSQPDefaults () |
| | Get the plugin's default SLSQP settings.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setPrintProgress (opt, bool enable) |
| | Enable or disable the plugin's progress printout.
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setResultFile (opt, Optional[str] path) |
| | Set the file the final result is written to (.csv or .txt).
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setProgressFile (opt, Optional[str] path) |
| | Set the file per-generation progress is written to (.csv or .txt).
|
| |
| None | pyhelios.wrappers.UParameterOptimizationWrapper.setInputFile (opt, Optional[str] path) |
| | Set a file to read the initial parameter set from.
|
| |
| Tuple[Dict[str, float], float] | pyhelios.wrappers.UParameterOptimizationWrapper._finish_run (int rc, _CallbackState state, Sequence[str] names, ctypes.Array out_values, ctypes.c_float out_fitness) |
| | Translate a native return code into a result or an exception.
|
| |
| Tuple[Dict[str, float], float] | pyhelios.wrappers.UParameterOptimizationWrapper.runOptimization (opt, List[dict] parameters, Callable[[Dict[str, float]], float] objective) |
| | Run a derivative-free optimization.
|
| |
| Tuple[Dict[str, float], float] | pyhelios.wrappers.UParameterOptimizationWrapper.runOptimizationWithGradient (opt, List[dict] parameters, Callable[[Dict[str, float]], float] objective, Callable[[Dict[str, float]], Dict[str, float]] gradient) |
| | Run an optimization with a user-supplied gradient.
|
| |
| Tuple[Dict[str, float], float] | pyhelios.wrappers.UParameterOptimizationWrapper.runOptimizationWithFDGradient (opt, List[dict] parameters, Callable[[Dict[str, float]], float] objective, float fd_step=0.0) |
| | Run an optimization with gradients estimated by finite differences.
|
| |
| Tuple[Dict[str, float], float] | pyhelios.wrappers.UParameterOptimizationWrapper.runOptimizationConstrained (opt, List[dict] parameters, Callable[[Dict[str, float]], object] simulation, int constraint_count) |
| | Run a constrained optimization: minimize f(x) subject to c_i(x) <= 0.
|
| |
| | pyhelios.wrappers.UParameterOptimizationWrapper.mock_createParameterOptimization (*args, **kwargs) |
| |
| | pyhelios.wrappers.UParameterOptimizationWrapper.mock_runParameterOptimization (*args, **kwargs) |
| |
1.13.2