optuna.visualization.plot_hypervolume_history

optuna.visualization.plot_hypervolume_history(study, reference_point)[source]

Plot hypervolume history of all trials in a study.

Example

The following code snippet shows how to plot optimization history.

import optuna


def objective(trial):
    x = trial.suggest_float("x", 0, 5)
    y = trial.suggest_float("y", 0, 3)

    v0 = 4 * x ** 2 + 4 * y ** 2
    v1 = (x - 5) ** 2 + (y - 5) ** 2
    return v0, v1


study = optuna.create_study(directions=["minimize", "minimize"])
study.optimize(objective, n_trials=50)

reference_point=[100., 50.]
fig = optuna.visualization.plot_hypervolume_history(study, reference_point)
fig.show()

Parameters:

study (Study) – A Study object whose trials are plotted for their hypervolumes. The number of objectives must be 2 or more.
reference_point (Sequence[float]) – A reference point to use for hypervolume computation. The dimension of the reference point must be the same as the number of objectives.

Returns:

A plotly.graph_objects.Figure object.

Return type:

Figure

Note

Added in v3.3.0 as an experimental feature. The interface may change in newer versions without prior notice. See https://github.com/optuna/optuna/releases/tag/v3.3.0.