dolysis
/
benchmark
mirror of https://github.com/google/benchmark.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add note to tools.md regarding scipy.

This commit is contained in:
Dominic Hamon 2018-07-23 12:08:20 +01:00 committed by GitHub
parent 1f35fa4aa7
commit 63e183b389
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools.md
View File

@ -9,6 +9,8 @@ The program is invoked like:
$ compare_bench.py <old-benchmark> <new-benchmark> [benchmark options]...
```
Note, it relies on the scipy package which can be installed using [these instructions](https://www.scipy.org/install.html).
Where `<old-benchmark>` and `<new-benchmark>` either specify a benchmark executable file, or a JSON output file. The type of the input file is automatically detected. If a benchmark executable is specified then the benchmark is run to obtain the results. Otherwise the results are simply loaded from the output file.
`[benchmark options]` will be passed to the benchmarks invocations. They can be anything that binary accepts, be it either normal `--benchmark_*` parameters, or some custom parameters your binary takes.