Skip to content

Refactoring of report generator #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Aug 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions report_generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Report generator produces Excel table file from json benchmark log files.

Run `python report_generator.py --result-files bench_log_1.json,bench_log_2.json [--report-file new_report.xlsx --generation-config gen_config.json --merging none]` to launch report generation.
Run `python report_generator.py --result-files bench_log_1.json,bench_log_2.json [--report-file new_report.xlsx --generation-config default_report_gen_config.json]` to launch report generation.

runner options:
* ``result-files`` : comma-separated benchmark json result file paths
* ``report-file`` : report file path
* ``generation-config`` : generation configuration file path
* ``merging``: *full*, *none*, *sw_only*, *hw_only*. How to merge same cases in benchmark logs

config parameters:
* ``header``: The column names in the table header. These parameters are also used to compare reports. If a name is compound, use the ``:`` symbol to separate its parts.
* ``comparison_method``: The formula for the comparison of two results. The options are: ``1 operation 2`` or ``2 operation 1``, where ``1`` is the first result and ``2`` is the second result. The default is ``2 / 1``, which returns the ratio of the second result to the first one.
* ``aggregation_metrics``: The metrics applied to the columns with the comparisons of two reports. You can use multiple metrics. For each of these metrics, a separate sheet with a summary is compiled. The metrics should be Excel functions. For example: ``"geomean", "average"``.
11 changes: 6 additions & 5 deletions report_generator/default_report_gen_config.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"align": [
"header": [
"algorithm",
"stage",
"input_data:data_order",
Expand All @@ -10,9 +10,10 @@
"input_data:classes",
"input_data:n_clusters"
],
"diff": [
"software_hash",
"hardware_hash",
"measurement_time"
"comparison_method": {
"default": "2 / 1"
},
"aggregation_metrics": [
"geomean"
]
}
Loading