Note
Go to the end to download the full example code
Saving/Resuming Study with RDB Backend
An RDB backend enables persistent experiments (i.e., to save and resume a study) as well as access to history of studies. In addition, we can run multi-node optimization tasks with this feature, which is described in Easy Parallelization.
In this section, let’s try simple examples running on a local environment with SQLite DB.
Note
You can also utilize other RDB backends, e.g., PostgreSQL or MySQL, by setting the storage argument to the DB’s URL. Please refer to SQLAlchemy’s document for how to set up the URL.
New Study
We can create a persistent study by calling create_study()
function as follows.
An SQLite file example.db
is automatically initialized with a new study record.
import logging
import sys
import optuna
# Add stream handler of stdout to show the messages
optuna.logging.get_logger("optuna").addHandler(logging.StreamHandler(sys.stdout))
study_name = "example-study" # Unique identifier of the study.
storage_name = "sqlite:///{}.db".format(study_name)
study = optuna.create_study(study_name=study_name, storage=storage_name)
A new study created in RDB with name: example-study
To run a study, call optimize()
method passing an objective function.
def objective(trial):
x = trial.suggest_float("x", -10, 10)
return (x - 2) ** 2
study.optimize(objective, n_trials=3)
Trial 0 finished with value: 13.22036310447501 and parameters: {'x': 5.6359817249918915}. Best is trial 0 with value: 13.22036310447501.
Trial 1 finished with value: 15.72789439761094 and parameters: {'x': 5.965840944567866}. Best is trial 0 with value: 13.22036310447501.
Trial 2 finished with value: 27.90327803579913 and parameters: {'x': -3.282355349254642}. Best is trial 0 with value: 13.22036310447501.
Resume Study
To resume a study, instantiate a Study
object
passing the study name example-study
and the DB URL sqlite:///example-study.db
.
study = optuna.create_study(study_name=study_name, storage=storage_name, load_if_exists=True)
study.optimize(objective, n_trials=3)
Using an existing study with name 'example-study' instead of creating a new one.
Trial 3 finished with value: 9.17390079612642 and parameters: {'x': -1.0288447956484035}. Best is trial 3 with value: 9.17390079612642.
Trial 4 finished with value: 0.7093156215172433 and parameters: {'x': 1.157791224507104}. Best is trial 4 with value: 0.7093156215172433.
Trial 5 finished with value: 56.3595045733305 and parameters: {'x': 9.507296755379429}. Best is trial 4 with value: 0.7093156215172433.
Note that the storage doesn’t store the state of the instance of samplers
and pruners
.
When we resume a study with a sampler whose seed
argument is specified for
reproducibility, you need to restore the sampler with using pickle
as follows:
import pickle
# Save the sampler with pickle to be loaded later.
with open("sampler.pkl", "wb") as fout:
pickle.dump(study.sampler, fout)
restored_sampler = pickle.load(open("sampler.pkl", "rb"))
study = optuna.create_study(
study_name=study_name, storage=storage_name, load_if_exists=True, sampler=restored_sampler
)
study.optimize(objective, n_trials=3)
Experimental History
We can access histories of studies and trials via the Study
class.
For example, we can get all trials of example-study
as:
study = optuna.create_study(study_name=study_name, storage=storage_name, load_if_exists=True)
df = study.trials_dataframe(attrs=("number", "value", "params", "state"))
Using an existing study with name 'example-study' instead of creating a new one.
The method trials_dataframe()
returns a pandas dataframe like:
print(df)
number value params_x state
0 0 13.220363 5.635982 COMPLETE
1 1 15.727894 5.965841 COMPLETE
2 2 27.903278 -3.282355 COMPLETE
3 3 9.173901 -1.028845 COMPLETE
4 4 0.709316 1.157791 COMPLETE
5 5 56.359505 9.507297 COMPLETE
A Study
object also provides properties
such as trials
, best_value
,
best_params
(see also Lightweight, versatile, and platform agnostic architecture).
print("Best params: ", study.best_params)
print("Best value: ", study.best_value)
print("Best Trial: ", study.best_trial)
print("Trials: ", study.trials)
Best params: {'x': 1.157791224507104}
Best value: 0.7093156215172433
Best Trial: FrozenTrial(number=4, state=1, values=[0.7093156215172433], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 839984), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 860911), params={'x': 1.157791224507104}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=5, value=None)
Trials: [FrozenTrial(number=0, state=1, values=[13.22036310447501], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 615663), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 655024), params={'x': 5.6359817249918915}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=1, value=None), FrozenTrial(number=1, state=1, values=[15.72789439761094], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 676745), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 697680), params={'x': 5.965840944567866}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=2, value=None), FrozenTrial(number=2, state=1, values=[27.90327803579913], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 714522), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 735644), params={'x': -3.282355349254642}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=3, value=None), FrozenTrial(number=3, state=1, values=[9.17390079612642], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 791286), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 820444), params={'x': -1.0288447956484035}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=4, value=None), FrozenTrial(number=4, state=1, values=[0.7093156215172433], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 839984), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 860911), params={'x': 1.157791224507104}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=5, value=None), FrozenTrial(number=5, state=1, values=[56.3595045733305], datetime_start=datetime.datetime(2024, 4, 1, 6, 9, 54, 877683), datetime_complete=datetime.datetime(2024, 4, 1, 6, 9, 54, 898402), params={'x': 9.507296755379429}, user_attrs={}, system_attrs={}, intermediate_values={}, distributions={'x': FloatDistribution(high=10.0, log=False, low=-10.0, step=None)}, trial_id=6, value=None)]
Total running time of the script: (0 minutes 1.196 seconds)