artipie / benchmarks

Benchmarks for Artipie repositories
MIT License
6 stars 9 forks source link

feat: add script for writing results to README and checkout ref #38

Closed genryxy closed 2 years ago

genryxy commented 2 years ago

Part of artipie/artipie#431 Added script for writing results to README and made checkout by specified ref

genryxy commented 2 years ago

@g4s8 could you please take a look

g4s8 commented 2 years ago

@genryxy where this script will add results in README file?

genryxy commented 2 years ago

@g4s8 in these lines new results are added to the README

genryxy commented 2 years ago

@g4s8 it will change the content of the file. More precisely, it will move the entire text below the table above the table. If there are several tables in this README file, it won't work correctly

genryxy commented 2 years ago

@g4s8 here some examples

First (new bench)

The table below contains info about results of benchmarks for different versions for existed SDK API operations.

Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017
1.1.1 30.448 ± 0.152 31.055 ± 0.096 5.342 ± 0.011

Result

The table below contains info about results of benchmarks for different versions for existed SDK API operations.

Version HelmAstoAdd HelmAstoRemove HelmAstoReindex newBench
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009 -
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017 -
1.1.1 30.448 ± 0.152 31.055 ± 0.096 5.342 ± 0.011 -
new1.1.2 val1 val2 val3 val4

Second (old bench did not run)

Some text here.

Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017
1.1.1 30.448 ± 0.152 31.055 ± 0.096 5.342 ± 0.011

Result

Some text here.

Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017
1.1.1 30.448 ± 0.152 31.055 ± 0.096 5.342 ± 0.011
new1.1.2 val1 val2 -

Third (without table)

Some text here. Here is not any table.

Result

Some text here. Here is not any table.

Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009

Fourth (text below the table)

Some text here above the table. Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017

Some text here below the table.

Result

Some text here above the table. Some text here below the table. Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017
new1.1.2 val1 val2 val3

Fifth (several tables in README)

Some text here above the table. Version HelmAstoAdd HelmAstoRemove HelmAstoReindex
0.3 50.708 ± 0.115 51.498 ± 0.165 6.858 ± 0.009
1.0.1 50.454 ± 0.111 51.308 ± 0.173 8.015 ± 0.017
Another table
it is unexpected

Result

The result will be wrong because also values from the second table will be taken.

g4s8 commented 2 years ago

@genryxy I see, maybe we can update another file specified by user, not README?

genryxy commented 2 years ago

@g4s8 thanks, now it will be written to a separate file results.md. And link to this file could be added to the readme file

genryxy commented 2 years ago

@g4s8 could you please merge

genryxy commented 2 years ago

@g4s8 please reapprove because I moved script to a separate folder and renamed file with it

genryxy commented 2 years ago

@g4s8 I supposed to add file ./benchmarks/results.md which would contain only table with results. And specify a link to this table in ./benchmarks/README.md

genryxy commented 2 years ago

@g4s8 thanks, made as you suggested

genryxy commented 2 years ago

@g4s8 thanks, corrected. I thought at first call run and after that on another step call draw_charts stage because it looked for me like two different operations. But yes, it would be better join these stages into one to avoid duplicating code for calling these two stages.

genryxy commented 2 years ago

@g4s8 could you please take a look

genryxy commented 2 years ago

@g4s8 could you please check

genryxy commented 2 years ago

@g4s8 please check