summary_metrics.py

Create a reduced version of the validation metrics table.

The reduced version is created by selecting a subset of columns.

It can also create a plot between two chosen metrics.

Tha parsing of this script is tightly connected to how the results are output by validate.py.

summary_metrics.load_summarized_table(args: Namespace) → DataFrame

Load the DataFrame and keep only columns according to the selected metrics.

Parameters:

argsargparse.Namespace

Arguments to control the loading.

Returns:

pd.DataFrame

The summarized DataFrame.

summary_metrics.save_plots(args: Namespace, df: DataFrame) → None

Generate and save the plot to disk.

Parameters:

argsargparse.Namespace

Arguments to control the plot.

dfpd.DataFrame

A DataFrame with the validation metrics.

summary_metrics.summarize(args: Namespace) → None

Summarize the results and save them to the disk.

Parameters:

argsargparse.Namespace

Arguments required to control the process.