README.md in benchmark_driver-0.10.16 vs README.md in benchmark_driver-0.11.0
- old
+ new
@@ -1,6 +1,6 @@
-# BenchmarkDriver [](https://travis-ci.org/k0kubun/benchmark_driver)
+# BenchmarkDriver [](https://travis-ci.org/benchmark-driver/benchmark-driver)
Fully-featured accurate benchmark driver for Ruby
## Features
### Accurate Measurement
@@ -166,14 +166,30 @@
x.report 'Array#empty?', %{ array.empty? }
x.output 'markdown'
end
```
+With following `blank_loop.yml`,
+
+```
+loop_count: 20000000
+prelude: |
+ class Array
+ alias_method :blank?, :empty?
+ end
+ array = []
+benchmark:
+ empty: array.empty?
+ blank: array.blank?
+```
+
+you can output results in various ways like:
+
### compare
```
-$ benchmark-driver examples/yaml/blank_loop.yml --output compare --rbenv '2.4.2;2.5.0'
+$ benchmark-driver blank_loop.yml --output compare --rbenv '2.4.2;2.5.0'
Calculating -------------------------------------
2.4.2 2.5.0
empty 195.957M 129.970M i/s - 20.000M times in 0.102063s 0.153882s
blank 66.554M 55.630M i/s - 20.000M times in 0.300507s 0.359519s
@@ -188,21 +204,21 @@
```
### simple
```
-$ benchmark-driver examples/yaml/blank_loop.yml --output simple --rbenv '2.4.2;2.5.0'
+$ benchmark-driver blank_loop.yml --output simple --rbenv '2.4.2;2.5.0'
benchmark results (i/s):
2.4.2 2.5.0
empty 184.084M 117.319M
blank 65.843M 62.093M
```
### markdown
```
-$ benchmark-driver examples/yaml/blank_loop.yml --output markdown --rbenv '2.4.2;2.5.0'
+$ benchmark-driver blank_loop.yml --output markdown --rbenv '2.4.2;2.5.0'
```
benchmark results (i/s)
| | 2.4.2| 2.5.0|
@@ -213,11 +229,11 @@
### record
Measure first, output with various formats later.
```
-$ benchmark-driver examples/yaml/blank_loop.yml --output record --rbenv '2.4.2;2.5.0'
+$ benchmark-driver blank_loop.yml --output record --rbenv '2.4.2;2.5.0'
benchmarking....
$ benchmark-driver benchmark_driver.record.yml --output compare
Calculating -------------------------------------
empty 153.380M 114.228M i/s - 20.000M times in 0.130395s 0.175088s
@@ -260,11 +276,11 @@
| command\_stdout | Special runner to integrate existing benchmarks |
### ips
```
-$ benchmark-driver examples/yaml/blank_loop.yml --runner ips --rbenv '2.4.3;2.5.0'
+$ benchmark-driver blank_loop.yml --runner ips --rbenv '2.4.3;2.5.0'
Calculating -------------------------------------
2.4.3 2.5.0
empty 228.802M 180.125M i/s - 20.000M times in 0.087412s 0.111034s
blank 90.012M 88.853M i/s - 20.000M times in 0.222193s 0.225090s
@@ -279,11 +295,11 @@
```
### time
```
-$ benchmark-driver examples/yaml/blank_loop.yml --runner time --rbenv '2.4.3;2.5.0'
+$ benchmark-driver blank_loop.yml --runner time --rbenv '2.4.3;2.5.0'
Calculating -------------------------------------
2.4.3 2.5.0
empty 0.087 0.110 s - 20.000M times
blank 0.217 0.219 s - 20.000M times
@@ -298,11 +314,11 @@
```
### memory
```
-$ benchmark-driver examples/yaml/blank_loop.yml --runner memory --rbenv '2.4.3;2.5.0'
+$ benchmark-driver blank_loop.yml --runner memory --rbenv '2.4.3;2.5.0'
Calculating -------------------------------------
2.4.3 2.5.0
empty 9.192M 9.364M bytes - 20.000M times
blank 9.080M 9.372M bytes - 20.000M times
@@ -319,10 +335,10 @@
### once
Only for testing purpose.
```
-$ benchmark-driver examples/yaml/blank_loop.yml --runner once --rbenv '2.4.3;2.5.0'
+$ benchmark-driver blank_loop.yml --runner once --rbenv '2.4.3;2.5.0'
Calculating -------------------------------------
2.4.3 2.5.0
empty 1.818M 2.681M i/s - 1.000 times in 0.000001s 0.000000s
blank 1.531M 2.421M i/s - 1.000 times in 0.000001s 0.000000s