Mercurial > repos > public > sbplib_julia
diff 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 |
line wrap: on
line diff
--- a/benchmark/run_and_view.jl Fri Jan 27 11:58:02 2023 +0100 +++ b/benchmark/run_and_view.jl Fri Jan 27 12:05:49 2023 +0100 @@ -40,6 +40,8 @@ run_benchmark(rev) Updates the repository to the given revison and runs the benchmark suite. When done, updates the repository to the origianl state. +`rev` can be any identifier compatible with `hg update`. + Returns a `PkgBenchmark.BenchmarkResult` """ @@ -58,6 +60,8 @@ Runs the benchmark at revisions `target` and `baseline` and compares them using `PkgBenchmark.judge`. `f` is the function used to compare. `judgekwargs` are keyword arguments passed to `judge`. +`target` and `baseline` can be any identifier compatible with `hg update`. + Returns a `PkgBenchmark.BenchmarkJudgement` """ function run_benchmark(target, baseline, f=minimum; judgekwargs=Dict())