Skip to content

Commit ca7bc1e

Browse files
committed
Benchmark: lightly edit docs
1 parent 7399106 commit ca7bc1e

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

Benchmark.lean

+15-12
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,22 @@ To run the benchmarks, simply load this file normally or build it with
1919
2020
## The `bchmk` command.
2121
22-
This is a custom command with the following syntax :
23-
`#bchmk (nIter : Nat) with (l : List Nat) using (b : Benchmark)`
22+
This is a custom command with syntax
23+
```
24+
#bchmk (nIter : Nat) with (l : List Nat) using (b : Benchmark)
25+
```
2426
25-
In this command, `nIter` determines the number of times the benchmark will be run.
27+
`nIter` determines the number of times the benchmark is be run.
2628
27-
Then, given `l : List Nat` we execute a benchmark `b` for each element of `l`.
29+
Then, given `l : List Nat`, we execute a benchmark `b` for each element of `l`.
2830
We output the average over `nIter` runs for each element of `l`.
29-
See below for a description of the different benchmarks studied. (Uncomment the #check benchX)
31+
See below for a description of the different benchmarks studied. (Uncomment the
32+
`#check benchX` lines.)
3033
31-
See also `Benchmark/Basic` for the definition of the `Benchmark` type.
34+
See `Benchmark/Basic.lean` for the definition of the `Benchmark` type.
3235
3336
## Lists with relevant values
37+
3438
We run the benchmarks on the following lists:
3539
3640
- `pows (n : Nat)` :
@@ -40,13 +44,12 @@ The list of the first `n` powers of two : `(List.range n).map (2 ^ ·)`
4044
The range between `1` and `n - 1`: `(List.range' 1 (n - 1))`
4145
This contains the relevant values for the depth test.
4246
43-
## Technical Detail
44-
The benchmarks are set up with the same configuration as in the paper.
45-
However by default they do only one run (As opposed of taking the average of 20 runs).
46-
This take about 8 minutes on our machine.
47-
(MacBook Pro with an Apple M2 Pro processor and 32GB of RAM.)
47+
## Benchmark Configuration
4848
49-
To run the exact same test as shown in the paper, set `nIter` to 20.
49+
The benchmarks are set up with the same configuration as in the paper, only with
50+
`nIter = 1` instead of `nIter = 20`.
51+
This take about 8 minutes on our machine (a MacBook Pro with an Apple M2 Pro
52+
processor and 32GB of RAM).
5053
-/
5154

5255
/- We effectively disable Lean's deterministic timeout mechanism

0 commit comments

Comments
 (0)