Skip to content

Conversation

karkhaz
Copy link
Contributor

@karkhaz karkhaz commented Apr 27, 2023

This commit adds a new visualization that writes all results out to a
file as a series of tables, one for each metric.

For each metric, each row comprises the benchmark name, followed by the
values of the metric for each of the variants.

This is an example of the output:

  ## runtime

  | Benchmark |  variant_1 | variant_2 |
  | --- | --- |--- |
  | bench_1 | 5 | 10 |
  | bench_2 | 10 | 5 |

  ## success

  | Benchmark |  variant_1 | variant_2 |
  | --- | --- |--- |
  | bench_1 | True | True |
  | bench_2 | True | False |

Testing:

  • How is this change tested? New regression test

  • Is this a refactor change?

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

karkhaz added 2 commits April 27, 2023 20:12
This commit adds a new visualization that writes all results out to a
file as a series of tables, one for each metric.

For each metric, each row comprises the benchmark name, followed by the
values of the metric for each of the variants.

This is an example of the output:

```
  ## runtime

  | Benchmark |  variant_1 | variant_2 |
  | --- | --- |--- |
  | bench_1 | 5 | 10 |
  | bench_2 | 10 | 5 |

  ## success

  | Benchmark |  variant_1 | variant_2 |
  | --- | --- |--- |
  | bench_1 | True | True |
  | bench_2 | True | False |
```
This commit saves the benchcomp Markdown table to the GitHub Action
summary before running other visualization.
@karkhaz karkhaz requested a review from a team as a code owner April 27, 2023 19:13
@karkhaz karkhaz changed the title Kk markdown table @karkhaz Add markdown_results_table benchcomp visualization Apr 27, 2023
@karkhaz karkhaz changed the title @karkhaz Add markdown_results_table benchcomp visualization Add markdown_results_table benchcomp visualization Apr 27, 2023
@karkhaz
Copy link
Contributor Author

karkhaz commented Apr 27, 2023

Here is an example of the rendered Markdown output in the GitHub Action summary
Screen Shot 2023-04-27 at 21 07 58

@karkhaz karkhaz merged commit d045764 into model-checking:main Apr 27, 2023
@karkhaz karkhaz deleted the kk-markdown-table branch April 27, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants