metrics_report#

popo.plotting.tables.metrics_report(res, metrics, minimize_cols=None, maximize_cols=None, title='Model performance', subtitle=None, source_note=None, decimals=3)#

A themed metric-comparison table with each column’s best value highlighted.

Parameters:

  • res (DataFrame) – DataFrame with one row per model/run and metric columns.

  • metrics (list[str]) – Column names to format as numbers.

  • minimize_cols (list[str] | None) – Metric columns where lower is better (MAE, RMSE, losses).

  • maximize_cols (list[str] | None) – Metric columns where higher is better (accuracy, R^2).

  • title (str) – Table title.

  • subtitle (str | None) – Optional subtitle shown below the title.

  • source_note (str | None) – Optional attribution line at the bottom of the table.

  • decimals (int) – Decimal places for numeric formatting.

Return type:

GT

Returns:

A GT object ready for display in a notebook.

On this page