From 64fea0921f6a35dbea96435debb114012603ffc2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20K=C3=B6ster?= Date: Fri, 25 Mar 2022 09:15:06 +0100 Subject: [PATCH] docs: details on benchmarked results --- docs/snakefiles/rules.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/snakefiles/rules.rst b/docs/snakefiles/rules.rst index 56b630bb3..df1c83494 100644 --- a/docs/snakefiles/rules.rst +++ b/docs/snakefiles/rules.rst @@ -1336,7 +1336,16 @@ With the `benchmark` keyword, a rule can be declared to store a benchmark of its shell: "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.,