pywatts.callbacks package¶

Submodules¶

class pywatts.callbacks.base_callback.BaseCallback(use_filemanager: bool = True)¶

Bases: abc.ABC

Base callback class handling filemanager for all child classes. All child classes need to implement at least the __call__ method.

Parameters:	ABC (ABC) – Abstract Base Class

get_path(filename: str) → str¶

Get the full path to use as a save location for callback objects.

Parameters:	filename (str) – Suggested name of the file (could be changed if already exist).
Returns:	Full path to save the file to.
Return type:	str

set_filemanager(filemanager: pywatts.core.filemanager.FileManager)¶

Set or replace filemanager to change save location (e.g. for different runs) if the user set the use_filemanager flag to True.

Parameters:	filemanager ([type]) – [description]

class pywatts.callbacks.csv_callback.CSVCallback(prefix: str, use_filemanager: Optional[bool] = None)¶

Callback class to save csv files.

Parameters:	BaseCallback (BaseCallback) – Base callback as parent class.

class pywatts.callbacks.debug_callback.PrintCallback(use_filemanager: bool = True)¶

Print callback class to print out result data into terminal for debugging.

Parameters:	BaseCallback (BaseCallback) – Base callback class.

class pywatts.callbacks.debug_callback.StatisticCallback(prefix: str, use_filemanager: Optional[bool] = None)¶

Statistic callback class to print out statistical information about the results into terminal for better understanding and debugging.

Parameters:	BaseCallback (BaseCallback) – Base callback class.

class pywatts.callbacks.plot_callback.ImagePlotCallback(prefix: str, use_filemanager: Optional[bool] = None)¶

Callback to save an image.

Parameters:	BaseCallback (BaseCallback) – Base callback class.

class pywatts.callbacks.plot_callback.LinePlotCallback(prefix: str, use_filemanager: Optional[bool] = None)¶

Callback to save a line plot.

Parameters:	BaseCallback (BaseCallback) – Base callback class.