Saving and Loading

Functions for saving and loading your experiment to stop and restart.

boa.storage.scheduler_to_json_file(scheduler, scheduler_filepath: PathLike = 'scheduler.json', dir_: PathLike = None, **kwargs) → None

Save a JSON-serialized snapshot of this Scheduler’s settings and state to a .json file by the given path.

Parameters:

• scheduler_filepath (PathLike) –

• dir_ (PathLike) –

Return type:

None

boa.storage.scheduler_from_json_file(filepath: PathLike = 'scheduler.json', wrapper=None, **kwargs) → Scheduler

Restore an Scheduler and its state from a JSON-serialized snapshot, residing in a .json file by the given path.

Parameters:

filepath (PathLike) –

Return type:

Scheduler

boa.storage.scheduler_to_json_snapshot(scheduler: Scheduler, encoder_registry: Optional[Dict[Type, Callable[[Any], Dict[str, Any]]]] = None, class_encoder_registry: Optional[Dict[Type, Callable[[Any], Dict[str, Any]]]] = None) → Dict[str, Any]

Serialize this Scheduler to JSON to be able to interrupt and restart optimization and save it to file by the provided path.

Returns:

A JSON-safe dict representation of this Scheduler.

Parameters:

• scheduler (Scheduler) –

• encoder_registry (Optional[Dict[Type, Callable[[Any], Dict[str, Any]]]]) –

• class_encoder_registry (Optional[Dict[Type, Callable[[Any], Dict[str, Any]]]]) –

Return type:

Dict[str, Any]

boa.storage.scheduler_from_json_snapshot(serialized: Dict[str, Any], decoder_registry: Optional[Dict[str, Type]] = None, class_decoder_registry: Optional[Dict[str, Callable[[Dict[str, Any]], Any]]] = None, wrapper_path=None, filepath: PathLike = None, **kwargs) → Scheduler

Recreate an Scheduler from a JSON snapshot.

Parameters:

• serialized (Dict[str, Any]) –

• decoder_registry (Optional[Dict[str, Type]]) –

• class_decoder_registry (Optional[Dict[str, Callable[[Dict[str, Any]], Any]]]) –

• filepath (PathLike) –

Return type:

Scheduler

boa.storage.recursive_deserialize(obj, **kwargs)

boa.storage.exp_opt_to_csv(experiment: Experiment, opt_filepath: PathLike = 'optimization.csv', dir_: PathLike = None, *, metrics_to_end: bool = False, ax_kwargs: Optional[Dict[str, Any]] = None, **kwargs) → Path

Parameters:

• experiment (Experiment) –

• opt_filepath (PathLike) –

• dir_ (PathLike) –

• metrics_to_end (bool) –

• ax_kwargs (Optional[Dict[str, Any]]) –

Return type:

Path

boa.storage.scheduler_opt_to_csv(scheduler: Scheduler, **kwargs)

Parameters:

scheduler (Scheduler) –

boa.storage.dump_scheduler_data(scheduler, scheduler_filepath, opt_filepath, **kwargs)