comparison benchmark/run_and_view.jl @ 1185:6fc0adcd5b97 tooling/benchmarks

Add info about supported rev identifiers
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 27 Jan 2023 12:05:49 +0100
parents c06d8eb8b0f0
children ca26f0e7683e
comparison
equal deleted inserted replaced
1184:c06d8eb8b0f0 1185:6fc0adcd5b97
38 38
39 """ 39 """
40 run_benchmark(rev) 40 run_benchmark(rev)
41 41
42 Updates the repository to the given revison and runs the benchmark suite. When done, updates the repository to the origianl state. 42 Updates the repository to the given revison and runs the benchmark suite. When done, updates the repository to the origianl state.
43 `rev` can be any identifier compatible with `hg update`.
44
43 45
44 Returns a `PkgBenchmark.BenchmarkResult` 46 Returns a `PkgBenchmark.BenchmarkResult`
45 """ 47 """
46 function run_benchmark(rev) 48 function run_benchmark(rev)
47 rev_before = hg_rev() 49 rev_before = hg_rev()
55 """ 57 """
56 run_benchmark(target, baseline, f=minimum; judgekwargs=Dict()) 58 run_benchmark(target, baseline, f=minimum; judgekwargs=Dict())
57 59
58 Runs the benchmark at revisions `target` and `baseline` and compares them using `PkgBenchmark.judge`. 60 Runs the benchmark at revisions `target` and `baseline` and compares them using `PkgBenchmark.judge`.
59 `f` is the function used to compare. `judgekwargs` are keyword arguments passed to `judge`. 61 `f` is the function used to compare. `judgekwargs` are keyword arguments passed to `judge`.
62
63 `target` and `baseline` can be any identifier compatible with `hg update`.
60 64
61 Returns a `PkgBenchmark.BenchmarkJudgement` 65 Returns a `PkgBenchmark.BenchmarkJudgement`
62 """ 66 """
63 function run_benchmark(target, baseline, f=minimum; judgekwargs=Dict()) 67 function run_benchmark(target, baseline, f=minimum; judgekwargs=Dict())
64 t = run_benchmark(target) 68 t = run_benchmark(target)