dedis / kyber

Advanced crypto library for the Go language
Other
636 stars 168 forks source link

Benchmarking platform #521

Closed matteosz closed 3 months ago

matteosz commented 4 months ago

This PR implements a benchmarking visualization tool for kyber and the script to run the benchmarks itself.

Steps to ensure it works correctly:

home comparison ranking sign
sonarcloud[bot] commented 4 months ago

Quality Gate Failed Quality Gate failed

Failed conditions
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarcloud[bot] commented 3 months ago

Please retry analysis of this Pull-Request directly on SonarCloud

sonarcloud[bot] commented 3 months ago

Quality Gate Failed Quality Gate failed

Failed conditions
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

AnomalRoil commented 3 months ago

Do you think we should do another repo "kyber-benchmark" with the web bits to get a dedicated Github Page and not clutter the kyber repo too much?

Leaving all the Go bits here, but moving the HTML, static resources, etc. to their own repo and pulling the data we need from this repo in CI.

matteosz commented 3 months ago

Do you think we should do another repo "kyber-benchmark" with the web bits to get a dedicated Github Page and not clutter the kyber repo too much?

Leaving all the Go bits here, but moving the HTML, static resources, etc. to their own repo and pulling the data we need from this repo in CI.

I don't know, in kyber there's already the docs folder which hosts the webpage with documentation and other stuff, and so I see the benchmarks as an extension to that; also everything centralized is easier to manage and update in the future, I feel that a separate repo might be forgotten and leaking behind through the development of the repo. Plus, it's very isolated from the library and only 1.4 MB so I guess my preference would be to keep it in Kyber, but I could move it if someone in DEDIS created a custom repo for it.