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

Benchmark in every rule is annoying - extra 2 lines that should not be necessary #472

Open
corneliusroemer opened this issue Aug 22, 2024 · 2 comments

Comments

@corneliusroemer
Copy link
Member

corneliusroemer commented Aug 22, 2024

I've just been reviewing recent changes in ncov-ingest while investigating #471

I noticed that every rule now has gotten 2 new lines benchmark: "benchmarks/rulename.txt". I'm all for benchmarking, i.e. getting runtime/memory/cpu usage information - but it seems this way of doing things is suboptimal - there's almost no intrinsic information here, one could easily write a few-line macro that adds the 2 lines to every rule based on each rule's rule name.

I'm not saying we should do this in ncov-ingest, really, snakemake should not require these verbose directives but offer a single CLI option that auto-generates the benchmark files.

But I noticed it here so thought I'll raise it.

The immediate harm of the 2 lines is that the diff I'm reviewing has a lot of noise (it's like reformatting). For now I'd be in favour of not adding benchmarks to other workflows until there's a less intrusive/verbose way of doing so.

@corneliusroemer corneliusroemer added enhancement New feature or request and removed enhancement New feature or request labels Aug 22, 2024
@genehack
Copy link
Contributor

This feels more like something that belongs in the snakemake repo? (Which contains, it seems, a relevant open PR...)

Until snakemake supports global benchmarking, if we want benchmarks, we need to add benchmark rules. 🤷

@tsibley
Copy link
Member

tsibley commented Aug 27, 2024

The immediate harm of the 2 lines is that the diff I'm reviewing has a lot of noise (it's like reformatting).

Hmm, how are those lines adding noise to the diff? Can you give an example?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants