Report

This method contains a function to print benchmark results to console.

report(file, display={'metrics', 'name'})

Print average results from a result file to stdout.

Printed stats contain benchmark configs, object sizes, average benchmark values for successful cases and exception message for unsuccessful cases.

Parameters:

• file (Union[str, Path]) – File with benchmark results generated by save_results_to_file().

• display (Set[Literal['name', 'desc', 'config', 'metrics']]) –

  A set of objects to display in results. Values allowed inside the set:

  • ”name” – displays the name of the benchmark case.

  • ”desc” – displays the description of the benchmark case.

  • ”config” – displays the config info of the benchmark case.

  • ”metrics” – displays average write, read, update read+update times.