gemseo.scenarios.backup_settings module

Backup settings.

class BackupSettings(file_path, at_each_iteration=False, at_each_function_call=True, erase=False, load=False, plot=False)

Bases: object

The settings of the backup file to store the evaluations.

Parameters:

• file_path (str | Path)

• at_each_iteration (bool) --

  By default it is set to False.

• at_each_function_call (bool) --

  By default it is set to True.

• erase (bool) --

  By default it is set to False.

• load (bool) --

  By default it is set to False.

• plot (bool) --

  By default it is set to False.

at_each_function_call: bool = True

Whether the backup file is updated at every function call.

at_each_iteration: bool = False

Whether the backup file is updated at every iteration of the optimization.

erase: bool = False

Whether the backup file is erased before the run.

file_path: str | Path

The backup file path.

load: bool = False

Whether the backup file is loaded before run.

A backup file can be useful after a crash.

plot: bool = False

Whether to plot the optimization history view at each iteration.

The plots will be generated only after the first two iterations.