comparison benchmark/benchmark_utils.jl @ 1318:e883085a091a tooling/benchmarks

Improve docstring for run_benchmark(target,baseline)
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 28 Apr 2023 08:35:37 +0200
parents 7110851b9c87
children cb4d57ce2ed1
comparison
equal deleted inserted replaced
1317:7110851b9c87 1318:e883085a091a
51 end 51 end
52 52
53 """ 53 """
54 run_benchmark(target, baseline, f=minimum; judgekwargs=Dict()) 54 run_benchmark(target, baseline, f=minimum; judgekwargs=Dict())
55 55
56 Runs the benchmark at revisions `target` and `baseline` and compares them using `PkgBenchmark.judge`. 56 Runs the benchmark at revisions `target` and `baseline` and compares them
57 `f` is the function used to compare. `judgekwargs` are keyword arguments passed to `judge`. 57 using `PkgBenchmark.judge`. `f` is the function used to compare. `judgekwargs`
58 are keyword arguments passed to `judge`.
58 59
59 `target` and `baseline` can be any identifier compatible with `hg update`. 60 `target` and `baseline` can be any identifier compatible with `hg update`.
60 61
61 Returns a `PkgBenchmark.BenchmarkJudgement` 62 Returns a `PkgBenchmark.BenchmarkJudgement`
62 """ 63 """