benchopt.results.result_processing.describe_results

benchopt.results.result_processing.describe_results(source)

Compute summary statistics for a benchopt result table.

Parameters:

source: str | Path | pd.DataFrame

Either a path to a result file (read with read_results) or an already-loaded results DataFrame (e.g. from read_results).

Returns:

summary: dict

n_rows, n_configs (unique objective x solver x dataset triplets), n_repetitions, objectives, solvers, datasets, objective_columns (the objective_<name> metric columns, e.g. objective_value, objective_train_loss) and run_dates.