README.md in benchmark_driver-0.13.3 vs README.md in benchmark_driver-0.14.0
- old
+ new
@@ -68,20 +68,21 @@
With `benchmark-driver` command, you can describe benchmark with YAML input.
```
$ benchmark-driver -h
-Usage: benchmark-driver [options] [YAML]
+Usage: benchmark-driver [options] [YAML|RUBY]
-r, --runner [TYPE] Specify runner type: ips, time, memory, once (default: ips)
-o, --output [TYPE] Specify output type: compare, simple, markdown, record (default: compare)
-e, --executables [EXECS] Ruby executables (e1::path1,arg1,...; e2::path2,arg2;...)
--rbenv [VERSIONS] Ruby executables in rbenv (x.x.x,arg1,...;y.y.y,arg2,...;...)
- --repeat-count [NUM] Try benchmark NUM times and use the fastest result (TODO)
+ --repeat-count [NUM] Try benchmark NUM times and use the fastest result or the worst memory usage
+ --repeat-result [TYPE] Yield "best", "average" or "worst" result with --repeat-count (default: best)
--bundler Install and use gems specified in Gemfile
--filter [REGEXP] Filter out benchmarks with given regexp
- --verbose [LEVEL] Show some verbose outputs: 0, 1, 2 (default: 0)
--run-duration [SECONDS] Warmup estimates loop_count to run for this duration (default: 3)
+ -v, --verbose Verbose mode. Multiple -v options increase visilibity (max: 2)
```
#### Running single script
With following `example_single.yml`,
@@ -361,19 +362,19 @@
If you benchmark can run with `ruby foo bar`, specify `foo bar` to `command:`.
Then write `stdout_to_metrics:` to convert stdout to metrics. This runner can be used only with YAML interface for now.
```
-$ benchmark-driver benchmark.yml --verbose 1 --rbenv '2.6.0-dev;2.6.0-dev,--jit'
+$ benchmark-driver benchmark.yml --verbose 1 --rbenv '2.6.0-dev;2.6.0-dev --jit'
2.6.0-dev: ruby 2.6.0dev (2018-03-21 trunk 62870) [x86_64-linux]
-2.6.0-dev,--jit: ruby 2.6.0dev (2018-03-21 trunk 62870) +JIT [x86_64-linux]
+2.6.0-dev --jit: ruby 2.6.0dev (2018-03-21 trunk 62870) +JIT [x86_64-linux]
Calculating -------------------------------------
- 2.6.0-dev 2.6.0-dev,--jit
+ 2.6.0-dev 2.6.0-dev --jit
optcarrot 51.866 67.445 fps
Comparison:
optcarrot
- 2.6.0-dev,--jit: 67.4 fps
+ 2.6.0-dev --jit: 67.4 fps
2.6.0-dev: 51.9 fps - 1.30x slower
```
## Contributing