From 3603e7810a1ac9288c14f43a0372594e9863e715 Mon Sep 17 00:00:00 2001 From: Jaremy Creechley Date: Thu, 2 May 2024 16:13:24 +0300 Subject: [PATCH] readme --- benchmarks/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 benchmarks/README.md diff --git a/benchmarks/README.md b/benchmarks/README.md new file mode 100644 index 00000000..dd64b5b9 --- /dev/null +++ b/benchmarks/README.md @@ -0,0 +1,18 @@ + +# Benchmark Runner + +Modify `runAllBenchmarks` proc in `run_benchmarks.nim` to the desired parameters and variations. + +Then run it: + +```sh +nim c -r run_benchmarks +``` + +By default all circuit files for each combinations of circuit args will be generated in a unique folder named like: + nim-codex/benchmarks/circuit_bench_depth32_maxslots256_cellsize2048_blocksize65536_nsamples9_entropy1234567_seed12345_nslots11_ncells512_index3 + + +You can modify the `CircuitArgs` and `CircuitEnv` objects in `runAllBenchMarks` to suite your needs. See `create_circuits.nim` for their definition. + +By it runs all commands relative to the `nim-codex` repo. This simplifies finding the correct circuit includes paths, etc. `CircuitEnv` sets all of this.