From 895cd02778d0e8463bc045c9bd569a050a631a65 Mon Sep 17 00:00:00 2001 From: Alejandro Gallo Date: Tue, 6 Dec 2022 20:38:57 +0100 Subject: [PATCH] Add some documentation about running the benches --- README.org | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.org b/README.org index 1db407e..a9ac12b 100644 --- a/README.org +++ b/README.org @@ -109,3 +109,24 @@ Notice that you can give a path for ctf for all of them by doing #+begin_src sh :eval no ../../tools/configure-benches.sh --with-ctf=/absolute/path/to/ctf #+end_src + +* Running benches + +** Main benchmark + +The main benchmark gets built in =bench/main= and is used to run an +atrip run with random tensors. + +A common run of this script will be the following + +#+begin_src sh +bench/main \ + --no 100 \ + --nv 1000 \ + --mod 1 \ + --% 0 \ + --dist group \ + --nocheckpoint \ + --max-iterations 1000 +#+end_src +