leaspy.io.settings.outputs_settings.OutputsSettings

class OutputsSettings(settings)

Bases: object

Used to create the logs folder to monitor the convergence of the calibration algorithm.

Parameters:
settingsdict[str, Any]
Parameters of the object. It may be in:
  • pathstr or None

    Where to store logs (relative or absolute path) If None, nothing will be saved (only console prints), unless save_periodicity is not None (default relative path ‘./_outputs/’ will be used).

  • console_print_periodicityint >= 1 or None

    Flag to log into console convergence data every N iterations If None, no console prints.

  • save_periodicityint >= 1 or None

    Flag to save convergence data every N iterations If None, no data will be saved.

  • plot_periodicityint >= 1 or None

    Flag to plot convergence data every N iterations If None, no plots will be saved. Note that you can not plot convergence data without saving data (and not more frequently than these saves!)

  • overwrite_logs_folderbool

    Flag to remove all previous logs if existing (default False)

Raises:
LeaspyAlgoInputError