speechtotext.metric.customMetrics.BaseMetrics

class BaseMetrics(df, report_folder, file_name)[source]

Bases: BaseResult

Base class used to create metrics for result dataframe.

Creates object of BaseResult. Child class should be added to Plotting.CUSTOM_RESULTS.

Parameters:
  • df (pd.core.frame.DataFrame) – Dataframe that needs to be plotted.

  • report_folder (str) – Path to report folder.

  • file_name (str) – Name of saved File.

Methods

create_df

Creates df that needs to be saved.

save

Saves Result to report folder.

abstract create_df()[source]

Creates df that needs to be saved.

Returns:

Dataframe that needs to be saved.

Return type:

pd.core.frame.DataFrame

save()[source]

Saves Result to report folder.