Skip to content


Browse files Browse the repository at this point in the history
docs: details on benchmarked results
  • Loading branch information
johanneskoester committed Mar 25, 2022
1 parent 4dfd155 commit 64fea09
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/snakefiles/rules.rst
Expand Up @@ -1336,7 +1336,16 @@ With the `benchmark` keyword, a rule can be declared to store a benchmark of its
"somecommand {input} {output}"
benchmarks the CPU and wall clock time of the command ``somecommand`` for the given output and input files.
benchmarks the

* CPU time (in seconds),
* wall clock time,
* memory usage (`RSS <>`_, `VMS <>`_, `USS <>`_, `PSS <>`_ in megabytes),
* CPU load (CPU time divided by wall clock time),
* I/O (in bytes)

of the command ``somecommand`` for the given output and input files.

For this, the shell or run body of the rule is executed on that data, and all run times are stored into the given benchmark tsv file (which will contain a tab-separated table of run times and memory usage in MiB).
Per default, Snakemake executes the job once, generating one run time.
However, the benchmark file can be annotated with the desired number of repeats, e.g.,
Expand Down

0 comments on commit 64fea09

Please sign in to comment.