ax.service¶
Ax Client¶
-
class
ax.service.ax_client.AxClient(generation_strategy=None, db_settings=None, enforce_sequential_optimization=True, random_seed=None, verbose_logging=True, suppress_storage_errors=False)[source]¶ Bases:
ax.service.utils.with_db_settings_base.WithDBSettingsBaseConvenience handler for management of experimentation cycle through a service-like API. External system manages scheduling of the cycle and makes calls to this client to get next suggestion in the experiment and log back data from the evaluation of that suggestion.
Note: AxClient expects to only propose 1 arm (suggestion) per trial; support for use cases that require use of batches is coming soon.
Two custom types used in this class for convenience are TParamValue and TParameterization. Those are shortcuts for Union[str, bool, float, int] and Dict[str, Union[str, bool, float, int]], respectively.
- Parameters
generation_strategy (
Optional[GenerationStrategy]) – Optional generation strategy. If not set, one is intelligently chosen based on properties of search space.db_settings (
Optional[DBSettings]) – Settings for saving and reloading the underlying experiment to a database. Expected to be of type ax.storage.sqa_store.structs.DBSettings and require SQLAlchemy.enforce_sequential_optimization (
bool) – Whether to enforce that when it is reasonable to switch models during the optimization (as prescribed by num_trials in generation strategy), Ax will wait for enough trials to be completed with data to proceed. Defaults to True. If set to False, Ax will keep generating new trials from the previous model until enough data is gathered. Use this only if necessary; otherwise, it is more resource-efficient to optimize sequentially, by waiting until enough data is available to use the next model.Optional integer random seed, set to fix the optimization random seed for reproducibility. Works only for Sobol quasi-random generator and for BoTorch-powered models. For the latter models, the trials generated from the same optimization setup with the same seed, will be mostly similar, but the exact parameter values may still vary and trials latter in the optimizations will diverge more and more. This is because a degree of randomness is essential for high performance of the Bayesian optimization models and is not controlled by the seed.
Note: In multi-threaded environments, the random seed is thread-safe, but does not actually guarantee reproducibility. Whether the outcomes will be exactly the same for two same operations that use the random seed, depends on whether the threads modify the random state in the same order across the two operations.
verbose_logging (
bool) – Whether Ax should log significant optimization events, defaults to True.suppress_storage_errors (
bool) – Whether to suppress SQL storage-related errors if encounted. Only use if SQL storage is not important for the given use case, since this will only log, but not raise, an exception if its encountered while saving to DB or loading from it.
-
abandon_trial(trial_index, reason=None)[source]¶ Abandons a trial and adds optional metadata to it.
- Parameters
trial_index (
int) – Index of trial within the experiment.- Return type
None
-
attach_trial(parameters)[source]¶ Attach a new trial with the given parameterization to the experiment.
-
complete_trial(trial_index, raw_data, metadata=None, sample_size=None)[source]¶ Completes the trial with given metric values and adds optional metadata to it.
- Parameters
trial_index (
int) – Index of trial within the experiment.raw_data (
Union[Dict[str,Tuple[float,Optional[float]]],Tuple[float,Optional[float]],float,List[Tuple[Dict[str,Union[str,bool,float,int,None]],Dict[str,Tuple[float,Optional[float]]]]]]) – Evaluation data for the trial. Can be a mapping from metric name to a tuple of mean and SEM, just a tuple of mean and SEM if only one metric in optimization, or just the mean if there is no SEM. Can also be a list of (fidelities, mapping from metric name to a tuple of mean and SEM).metadata (
Optional[Dict[str,Union[str,int]]]) – Additional metadata to track about this run.sample_size (
Optional[int]) – Number of samples collected for the underlying arm, optional.
- Return type
None
-
create_experiment(parameters, name=None, objective_name=None, minimize=False, parameter_constraints=None, outcome_constraints=None, status_quo=None, overwrite_existing_experiment=False, experiment_type=None, choose_generation_strategy_kwargs=None)[source]¶ Create a new experiment and save it if DBSettings available.
- Parameters
parameters (
List[Dict[str,Union[str,bool,float,int,None,List[Union[str,bool,float,int,None]]]]]) – List of dictionaries representing parameters in the experiment search space. Required elements in the dictionaries are: “name” (name of this parameter, string), “type” (type of the parameter: “range”, “fixed”, or “choice”, string), and “bounds” for range parameters (list of two values, lower bound first), “values” for choice parameters (list of values), and “value” for fixed parameters (single value).objective – Name of the metric used as objective in this experiment. This metric must be present in raw_data argument to complete_trial.
name (
Optional[str]) – Name of the experiment to be created.minimize (
bool) – Whether this experiment represents a minimization problem.parameter_constraints (
Optional[List[str]]) – List of string representation of parameter constraints, such as “x3 >= x4” or “-x3 + 2*x4 - 3.5*x5 >= 2”. For the latter constraints, any number of arguments is accepted, and acceptable operators are “<=” and “>=”.outcome_constraints (
Optional[List[str]]) – List of string representation of outcome constraints of form “metric_name >= bound”, like “m1 <= 3.”status_quo (
Optional[Dict[str,Union[str,bool,float,int,None]]]) – Parameterization of the current state of the system. If set, this will be added to each trial to be evaluated alongside test configurations.overwrite_existing_experiment (
bool) – If an experiment has already been set on this AxClient instance, whether to reset it to the new one. If overwriting the experiment, generation strategy will be re-selected for the new experiment and restarted. To protect experiments in production, one cannot overwrite existing experiments if the experiment is already stored in the database, regardless of the value of overwrite_existing_experiment.choose_generation_strategy_kwargs (
Optional[Dict[str,Any]]) – Keyword arguments to pass to choose_generation_strategy function which determines what generation strategy should be used when none was specified on init.
- Return type
None
-
property
experiment¶ Returns the experiment set on this Ax client.
- Return type
-
static
from_json_snapshot(serialized, **kwargs)[source]¶ Recreate an AxClient from a JSON snapshot.
- Return type
-
property
generation_strategy¶ Returns the generation strategy, set on this experiment.
- Return type
-
get_best_parameters()[source]¶ Given an experiment, identifies the best arm.
First attempts according to do so with models used in optimization and its corresponding predictions if available. Falls back to the best raw objective based on the data fetched from the experiment.
- TModelPredictArm is of the form:
({metric_name: mean}, {metric_name_1: {metric_name_2: cov_1_2}})
-
get_contour_plot(param_x=None, param_y=None, metric_name=None)[source]¶ Retrieves a plot configuration for a contour plot of the response surface. For response surfaces with more than two parameters, selected two parameters will appear on the axes, and remaining parameters will be affixed to the middle of their range. If contour params arguments are not provided, the first two parameters in the search space will be used. If contour metrics are not provided, objective will be used.
- Parameters
- Return type
-
get_feature_importances(relative=True)[source]¶ Get a bar chart showing feature_importances for a metric.
A drop-down controls the metric for which the importances are displayed.
- Parameters
relative (
bool) – Whether the values are displayed as percentiles or as raw importance metrics.- Return type
-
get_max_parallelism()[source]¶ Retrieves maximum number of trials that can be scheduled in parallel at different stages of optimization.
Some optimization algorithms profit significantly from sequential optimization (i.e. suggest a few points, get updated with data for them, repeat, see https://ax.dev/docs/bayesopt.html). Parallelism setting indicates how many trials should be running simulteneously (generated, but not yet completed with data).
The output of this method is mapping of form {num_trials -> max_parallelism_setting}, where the max_parallelism_setting is used for num_trials trials. If max_parallelism_setting is -1, as many of the trials can be ran in parallel, as necessary. If num_trials in a tuple is -1, then the corresponding max_parallelism_setting should be used for all subsequent trials.
For example, if the returned list is [(5, -1), (12, 6), (-1, 3)], the schedule could be: run 5 trials with any parallelism, run 6 trials in parallel twice, run 3 trials in parallel for as long as needed. Here, ‘running’ a trial means obtaining a next trial from AxClient through get_next_trials and completing it with data when available.
-
get_model_predictions(metric_names=None)[source]¶ Retrieve model-estimated means and covariances for all metrics. Note: this function retrieves the predictions for the ‘in-sample’ arms, which means that the return mapping on this function will only contain predictions for trials that have been completed with data.
- Parameters
metric_names (
Optional[List[str]]) – Names of the metrics, for which to retrieve predictions. All metrics on experiment will be retrieved if this argument was not specified.- Return type
- Returns
A mapping from trial index to a mapping of metric names to tuples of predicted metric mean and SEM, of form: { trial_index -> { metric_name: ( mean, SEM ) } }.
-
get_next_trial()[source]¶ Generate trial with the next set of parameters to try in the iteration process.
Note: Service API currently supports only 1-arm trials.
-
get_optimization_trace(objective_optimum=None)[source]¶ Retrieves the plot configuration for optimization trace, which shows the evolution of the objective mean over iterations.
-
get_trial_parameters(trial_index)[source]¶ Retrieve the parameterization of the trial by the given index.
-
load_experiment_from_database(experiment_name, choose_generation_strategy_kwargs=None)[source]¶ Load an existing experiment from database using the DBSettings passed to this AxClient on instantiation.
- Parameters
experiment_name (
str) – Name of the experiment.- Return type
None- Returns
Experiment object.
-
static
load_from_json_file(filepath='ax_client_snapshot.json', **kwargs)[source]¶ Restore an AxClient and its state from a JSON-serialized snapshot, residing in a .json file by the given path.
- Return type
-
log_trial_failure(trial_index, metadata=None)[source]¶ Mark that the given trial has failed while running.
-
save_to_json_file(filepath='ax_client_snapshot.json')[source]¶ Save a JSON-serialized snapshot of this AxClient’s settings and state to a .json file by the given path.
- Return type
None
-
to_json_snapshot()[source]¶ Serialize this AxClient to JSON to be able to interrupt and restart optimization and save it to file by the provided path.
-
update_trial_data(trial_index, raw_data, metadata=None, sample_size=None)[source]¶ Attaches additional data for completed trial (for example, if trial was completed with data for only one of the required metrics and more data needs to be attached).
- Parameters
trial_index (
int) – Index of trial within the experiment.raw_data (
Union[Dict[str,Tuple[float,Optional[float]]],Tuple[float,Optional[float]],float,List[Tuple[Dict[str,Union[str,bool,float,int,None]],Dict[str,Tuple[float,Optional[float]]]]]]) – Evaluation data for the trial. Can be a mapping from metric name to a tuple of mean and SEM, just a tuple of mean and SEM if only one metric in optimization, or just the mean if there is no SEM. Can also be a list of (fidelities, mapping from metric name to a tuple of mean and SEM).metadata (
Optional[Dict[str,Union[str,int]]]) – Additional metadata to track about this run.sample_size (
Optional[int]) – Number of samples collected for the underlying arm, optional.
- Return type
None
Managed Loop¶
-
class
ax.service.managed_loop.OptimizationLoop(experiment, total_trials=20, arms_per_trial=1, random_seed=None, wait_time=0, run_async=False, generation_strategy=None)[source]¶ Bases:
objectManaged optimization loop, in which Ax oversees deployment of trials and gathering data.
-
full_run()[source]¶ Runs full optimization loop as defined in the provided optimization plan.
- Return type
-
static
with_evaluation_function(parameters, evaluation_function, experiment_name=None, objective_name=None, minimize=False, parameter_constraints=None, outcome_constraints=None, total_trials=20, arms_per_trial=1, wait_time=0, random_seed=None, generation_strategy=None)[source]¶ Constructs a synchronous OptimizationLoop using an evaluation function.
- Return type
-
classmethod
with_runners_and_metrics(parameters, path_to_runner, paths_to_metrics, experiment_name=None, objective_name=None, minimize=False, parameter_constraints=None, outcome_constraints=None, total_trials=20, arms_per_trial=1, wait_time=0, random_seed=None)[source]¶ Constructs an asynchronous OptimizationLoop using Ax runners and metrics.
- Return type
-
-
ax.service.managed_loop.optimize(parameters, evaluation_function, experiment_name=None, objective_name=None, minimize=False, parameter_constraints=None, outcome_constraints=None, total_trials=20, arms_per_trial=1, random_seed=None, generation_strategy=None)[source]¶ Construct and run a full optimization loop.
Utils¶
Best Point Identification¶
-
ax.service.utils.best_point.get_best_from_model_predictions(experiment)[source]¶ Given an experiment, returns the best predicted parameterization and corresponding prediction based on the most recent Trial with predictions. If no trials have predictions returns None.
Only some models return predictions. For instance GPEI does while Sobol does not.
- TModelPredictArm is of the form:
({metric_name: mean}, {metric_name_1: {metric_name_2: cov_1_2}})
- Parameters
experiment (
Experiment) – Experiment, on which to identify best raw objective arm.- Return type
Optional[Tuple[Dict[str,Union[str,bool,float,int,None]],Optional[Tuple[Dict[str,float],Optional[Dict[str,Dict[str,float]]]]]]]- Returns
Tuple of parameterization and model predictions for it.
-
ax.service.utils.best_point.get_best_parameters(experiment)[source]¶ Given an experiment, identifies the best arm.
First attempts according to do so with models used in optimization and its corresponding predictions if available. Falls back to the best raw objective based on the data fetched from the experiment.
- TModelPredictArm is of the form:
({metric_name: mean}, {metric_name_1: {metric_name_2: cov_1_2}})
- Parameters
experiment (
Experiment) – Experiment, on which to identify best raw objective arm.- Return type
Optional[Tuple[Dict[str,Union[str,bool,float,int,None]],Optional[Tuple[Dict[str,float],Optional[Dict[str,Dict[str,float]]]]]]]- Returns
Tuple of parameterization and model predictions for it.
-
ax.service.utils.best_point.get_best_raw_objective_point(experiment, optimization_config=None)[source]¶ Given an experiment, identifies the arm that had the best raw objective, based on the data fetched from the experiment.
- Parameters
experiment (
Experiment) – Experiment, on which to identify best raw objective arm.optimization_config (
Optional[OptimizationConfig]) – Optimization config to use in absence or in place of the one stored on the experiment.
- Return type
Tuple[Dict[str,Union[str,bool,float,int,None]],Dict[str,Tuple[float,float]]]- Returns
- Tuple of parameterization and a mapping from metric name to a tuple of
the corresponding objective mean and SEM.
Instantiation¶
-
ax.service.utils.instantiation.constraint_from_str(representation, parameters)[source]¶ Parse string representation of a parameter constraint.
- Return type
-
ax.service.utils.instantiation.data_from_evaluations(evaluations, trial_index, sample_sizes, start_time=None, end_time=None)[source]¶ Transforms evaluations into Ax Data.
Each evaluation is either a trial evaluation: {metric_name -> (mean, SEM)} or a fidelity trial evaluation for multi-fidelity optimizations: [(fidelities, {metric_name -> (mean, SEM)})].
- Parameters
evalutions – Mapping from arm name to evaluation.
trial_index (
int) – Index of the trial, for which the evaluations are.sample_sizes (
Dict[str,int]) – Number of samples collected for each arm, may be empty if unavailable.start_time (
Optional[int]) – Optional start time of run of the trial that produced this data, in milliseconds.end_time (
Optional[int]) – Optional end time of run of the trial that produced this data, in milliseconds.
- Return type
-
ax.service.utils.instantiation.make_experiment(parameters, name=None, objective_name=None, minimize=False, parameter_constraints=None, outcome_constraints=None, status_quo=None, experiment_type=None)[source]¶ Instantiation wrapper that allows for creation of SimpleExperiment without importing or instantiating any Ax classes.
- Return type
-
ax.service.utils.instantiation.outcome_constraint_from_str(representation)[source]¶ Parse string representation of an outcome constraint.
- Return type
-
ax.service.utils.instantiation.parameter_from_json(representation)[source]¶ Instantiate a parameter from JSON representation.
- Return type
-
ax.service.utils.instantiation.raw_data_to_evaluation(raw_data, objective_name, start_time=None, end_time=None)[source]¶ Format the trial evaluation data to a standard TTrialEvaluation (mapping from metric names to a tuple of mean and SEM) representation, or to a TFidelityTrialEvaluation.
Note: this function expects raw_data to be data for a Trial, not a BatchedTrial.
Storage¶
-
ax.service.utils.storage.load_experiment(name, db_settings)[source]¶ Load experiment from the db. Service API only supports Experiment.
- Parameters
name (
str) – Experiment name.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Returns
Loaded experiment.
- Return type
ax.core.Experiment
-
ax.service.utils.storage.load_experiment_and_generation_strategy(experiment_name, db_settings)[source]¶ Load experiment and the corresponding generation strategy from the DB.
- Parameters
name – Experiment name.
db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
- Returns
A tuple of the loaded experiment and generation strategy.
-
ax.service.utils.storage.logger= <Logger ax.service.utils.storage (INFO)>¶ Utilities for storing experiment to the database via DBSettings.
-
ax.service.utils.storage.save_experiment(experiment, db_settings)[source]¶ Save experiment to db.
- Parameters
experiment (
Experiment) – Experiment object.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.save_generation_strategy(generation_strategy, db_settings)[source]¶ Save generation strategy to DB.
- Parameters
generation_strategy (
GenerationStrategy) – Corresponding generation strategy.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.save_new_trial(experiment, trial, db_settings)[source]¶ Save a new trial on an experiment in DB.
NOTE: This function also saves data attached to experiment for this trial.
- Parameters
experiment (
Experiment) – Experiment object.trial (
BaseTrial) – BaseTrial object.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.save_new_trials(experiment, trials, db_settings)[source]¶ Save a set of new trials on an experiment in DB.
NOTE: This function also saves data attached to experiment for these trials.
- Parameters
experiment (
Experiment) – Experiment object.trials (
List[BaseTrial]) – List of trials (subclasses of BaseTrial: Trial or BatchTrial).db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.save_updated_trial(experiment, trial, db_settings)[source]¶ Save an updated trial on an experiment in DB.
NOTE: This function also saves data attached to experiment for this trial.
- Parameters
experiment (
Experiment) – Experiment object.trial (
BaseTrial) – BaseTrial object.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.save_updated_trials(experiment, trials, db_settings)[source]¶ Save a set of updated trials on an experiment in DB.
NOTE: This function also saves data attached to experiment for these trials.
- Parameters
experiment (
Experiment) – Experiment object.trials (
List[BaseTrial]) – List of trials (subclasses of BaseTrial: Trial or BatchTrial).db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None
-
ax.service.utils.storage.update_generation_strategy(generation_strategy, generator_runs, db_settings)[source]¶ Update generation strategy in DB with new generator runs.
- Parameters
generation_strategy (
GenerationStrategy) – Corresponding generation strategy.generator_runs (
List[GeneratorRun]) – New generator runs produced from the generation strategy since its last save.db_settings (
DBSettings) – Defines behavior for loading/saving experiment to/from db.
- Return type
None