speechtotext.plot.plotting.Plotting

class Plotting(results, errors, report_name)

Bases: object

Class that is used to create plots for an benchmark.

Creates plotting object

Parameters:

• results (list[pd.core.frame.DataFrame]) – List of result dataframes.

• errors (list[pd.core.frame.DataFrame]) – List of error dataframes.

• report_name (str) – Name of report.

Methods

launch_dtale	Launch webui to explore the data.
save_all	Loops over all customPlot classes in CUSTOM_PLOTS to creates and saves the plots.

Attributes

CUSTOM_ERRORS	List of error classes that need to be saved.
CUSTOM_ERROR_PLOTS	List of error plot classes that need to be saved.
CUSTOM_PLOTS	List of plot classes that need to be saved.
CUSTOM_RESULTS	List of result classes that need to be saved.
DATASET_NAMES	List of dataset names that were used for the benchmarks.

CUSTOM_ERRORS: list[BaseResult] = []

List of error classes that need to be saved.

This could be an pandas df, report text file, …

Type:

list[BaseResult]

CUSTOM_ERROR_PLOTS: list[BaseResult] = [<class 'speechtotext.plot.customErrorPlots.ErrorCountByModel'>, <class 'speechtotext.plot.customErrorPlots.ErrorCountByModelByDataset'>, <class 'speechtotext.plot.customErrorPlots.ErrorCountHeatmap'>]

List of error plot classes that need to be saved.

This could be an plotly, matplotlib or another plot.

Type:

list[BaseResult]

CUSTOM_PLOTS: list[BaseResult] = [<class 'speechtotext.plot.customPlots.DynamicallyByModelNameForEachDataset'>, <class 'speechtotext.plot.customPlots.DynamicallyByModelNameByDataset'>, <class 'speechtotext.plot.customPlots.MetricHeatMap'>]

List of plot classes that need to be saved.

This could be an plotly, matplotlib or another plot.

Type:

list[BaseResult]

CUSTOM_RESULTS: list[BaseResult] = [<class 'speechtotext.metric.customMetrics.BenchmarkResults'>, <class 'speechtotext.metric.customMetrics.ResultMetrics'>]

List of result classes that need to be saved.

This could be an pandas df, report text file, …

Type:

list[BaseResult]

DATASET_NAMES: list[str] = []

List of dataset names that were used for the benchmarks.

Type:

list[str]

launch_dtale()

Launch webui to explore the data.

save_all()

Loops over all customPlot classes in CUSTOM_PLOTS to creates and saves the plots.