Add extra_column to benchcomp markdown visualizer #2415
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds the ability to add extra columns to the markdown tables
generated by the dump_markdown_results_table visualization. The
following is taken from the visualization's documentation:
This PR also adds columns to each of the benchcomp perf metrics that
help to identify benchmarks that are interesting from the rendered
Markdown summary. Here is an example Action Summary, screenshots are below.
Runtime metrics have a "% change" extra column whose value is rendered in bold if the % change is >50% (either positive or negative), which is the same as the current threshold for regression alerting.
The 'success' metric has a 'change' column that is blank if the metric either failed on old+new kani or passed with old+new kani. If the result changed between versions, the value in this column for the benchmark will be "❌ newly failing" or "✅ newly passing".

Numerical benchmarks like 'number_program_steps' display the difference between the old and new value if it is non-zero. The value is bold if the difference is >10% more than the old value.

Testing:
How is this change tested? Extended existing regression test
Is this a refactor change?
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.