Skip to content

Commit 556313d

Browse files
Refactoring of report generator (#84)
* initial * codefactor & EOF * Update report_generator.py * apply comments * round ratio cell * apply readme comments * Update report_generator/README.md * elastic-net->elasticnet && add iter in lasso & elasticnet && pca n_components int->float * remove knn_regr * Update sklearn_bench/pca.py Co-authored-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
1 parent 964a267 commit 556313d

File tree

6 files changed

+462
-180
lines changed

6 files changed

+462
-180
lines changed

report_generator/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

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

5-
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.
5+
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.
66

77
runner options:
88
* ``result-files`` : comma-separated benchmark json result file paths
99
* ``report-file`` : report file path
1010
* ``generation-config`` : generation configuration file path
11-
* ``merging``: *full*, *none*, *sw_only*, *hw_only*. How to merge same cases in benchmark logs
11+
12+
config parameters:
13+
* ``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.
14+
* ``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.
15+
* ``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"``.
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"align": [
2+
"header": [
33
"algorithm",
44
"stage",
55
"input_data:data_order",
@@ -10,9 +10,10 @@
1010
"input_data:classes",
1111
"input_data:n_clusters"
1212
],
13-
"diff": [
14-
"software_hash",
15-
"hardware_hash",
16-
"measurement_time"
13+
"comparison_method": {
14+
"default": "2 / 1"
15+
},
16+
"aggregation_metrics": [
17+
"geomean"
1718
]
1819
}

0 commit comments

Comments
 (0)