Skip to content
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

run_benchmarks is referenced in the documentation and the codebase but is not available #963

Open
rw1nkler opened this issue May 17, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation testing Test-infrastructure related

Comments

@rw1nkler
Copy link
Contributor

The documentation of the benchmark_main points to run_benchmarks, also run_benchmarks.py is mentioned in the codebase, but the tool seems to be unavailable in the repository. Is this part of the documentation up to date? Is the tool still needed/used somewhere?

If so, would it be possible to update the documentation about it?

CC @proppy

@proppy proppy added documentation Improvements or additions to documentation testing Test-infrastructure related labels May 17, 2023
@rw1nkler rw1nkler moved this to Todo in Antmicro XLS May 31, 2023
@lpawelcz
Copy link
Contributor

Hi @proppy do you happen to know anything about this run_benchmarks.py?
I'm asking with regards to your comment and effort concentrated on reducing bazel usage in flows for dashboard generation (#1137) and Vizier parameter evaluation (#1160).

@proppy
Copy link
Member

proppy commented Dec 13, 2023

maybe @cdleary can shed more light on the history behind this script?

@cdleary
Copy link
Collaborator

cdleary commented Dec 13, 2023

Hasn't been open sourced yet because of two main complications:

  • it's tied to the internal revision control system (it sees how your change compares to baseline which is the canonical HEAD so has to have a facility for run-at-head)
  • it pulls in internal targets to benchmark which makes the bidirectional-import/export-to-github rewrite slightly more complicated

@allight and @meheff I think were chatting about how big of a lift it would be to make it work with the git based flow so we could properly OSS it -- presumably we'd need to virtualize the VCS parts, any other major parts I'm not thinking of?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation testing Test-infrastructure related
Projects
None yet
Development

No branches or pull requests

4 participants