AxMultiFidelityGenerator

class optimas.generators.AxMultiFidelityGenerator(varying_parameters, objectives, analyzed_parameters=None, outcome_constraints=None, n_init=4, enforce_n_init=False, abandon_failed_trials=True, fit_out_of_design=False, fidel_cost_intercept=1.0, use_cuda=False, gpu_id=0, dedicated_resources=False, save_model=True, model_save_period=5, model_history_dir='model_history')

Multifidelity Bayesian optimization using the Ax service API.

Parameters:

varying_parameterslist of VaryingParameter

List of input parameters to vary. One them should be a fidelity.

objectiveslist of Objective

List of optimization objectives.

analyzed_parameterslist of Parameter, optional

List of parameters to analyze at each trial, but which are not optimization objectives. By default None.

outcome_constraintslist of str, optional

List of string representation of outcome constraints (i.e., constraints on any of the analyzed_parameters) of form "metric_name >= bound", like "m1 <= 3.".

n_initint, optional

Number of evaluations to perform during the initialization phase using Sobol sampling. If external data is attached to the exploration, the number of initialization evaluations will be reduced by the same amount, unless enforce_n_init=True. By default, 4.

enforce_n_initbool, optional

Whether to enforce the generation of n_init Sobol trials, even if external data is supplied. By default, False.

abandon_failed_trialsbool, optional

Whether failed trials should be abandoned (i.e., not suggested again). By default, True.

fit_out_of_designbool, optional

Whether to fit the surrogate model taking into account evaluations outside of the range of the varying parameters. This can be useful if the range of parameter has been reduced during the optimization. By default, False.

fidel_cost_interceptfloat, optional

The cost intercept for the affine cost of the form cost_intercept + n, where n is the number of generated points. Used for the knowledge gradient acquisition function. By default, 1.

use_cudabool, optional

Whether to allow the generator to run on a CUDA GPU. By default False.

gpu_idint, optional

The ID of the GPU in which to run the generator. By default, 0.

dedicated_resourcesbool, optional

Whether to allocated dedicated resources (e.g., the GPU) for the generator. These resources will not be available to the simulation workers. By default, False.

save_modelbool, optional

Whether to save the optimization model (in this case, the Ax client) to disk. By default True.

model_save_periodint, optional

Periodicity, in number of evaluated Trials, with which to save the model to disk. By default, 5.

model_history_dirstr, optional

Name of the directory in which the model will be saved. By default, 'model_history'.

Methods

ask_trials(n_trials)	Ask the generator to suggest the next n_trials to evaluate.
attach_trials(trial_data[, ...])	Manually add a list of trials to the generator.
get_gen_specs(sim_workers, run_params, max_evals)	Get the libEnsemble gen_specs.
get_libe_specs()	Get the libEnsemble libe_specs.
get_trial(trial_index)	Get trial by index.
ignore_trials(trials)	Ignore trials as determined by the generator.
incorporate_history(history)	Incorporate past history into the generator.
ingest(results)	Send the results of evaluations to the generator.
mark_trial_as_failed(trial_index)	Mark an already evaluated trial as failed.
save_model_to_file()	Save model to file.
suggest(num_points)	Request the next set of points to evaluate.
tell_trials(trials[, allow_saving_model])	Give trials back to generator once they have been evaluated.
update_parameter(parameter)	Update a varying parameter of the generator.

Attributes

analyzed_parameters	Get the list of analyzed parameters.
ax_client	Get the underlying AxClient.
constraints	Get the list of constraints.
dedicated_resources	Get whether the generator has dedicated resources allocated.
gpu_id	Get the ID of the GPU used by the generator.
model	Get access to the underlying model using an AxModelManager.
n_completed_trials	Get the number of successfully evaluated trials.
n_evaluated_trials	Get the number of evaluated trials.
n_failed_trials	Get the number of unsuccessfully evaluated trials.
n_given_trials	Get the number of trials given for evaluation.
n_queued_trials	Get the number of trials queued for evaluation.
objectives	Get the list of objectives.
use_cuda	Get whether the generator can use CUDA.
varying_parameters	Get the list of varying parameters.