speechtotext.metric.customMetrics

Module to create custom metrics to save with the plots from the plotting module.

Use this module like this:

# Imports
from speechtotext.functions import BaseResult
from speechtotext.plot.plotting import Plotting

# Create class with matplotlib picture
class BenchmarkResults(BaseMetrics):
        def create_df(self) -> pd.core.frame.DataFrame:
                return self.df

# Add model to Plotting
Plotting.CUSTOM_RESULTS.append(BenchmarkResults)

Classes

BaseMetrics	Base class used to create metrics for result dataframe.
BenchmarkResults	This class saves the results of the benchmark.
ErrorMetrics	This class calulates the error statistic on the benchmark results.
ResultMetrics	This class calulates the default statistic metrics on the benchmark results.