sharkdp/hyperfine
1
1
Fork 0
mirror of https://github.com/sharkdp/hyperfine.git synced 2024-11-29 15:03:55 +03:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
David Peter 2019-06-08 14:36:45 +02:00 committed by GitHub
parent 3395914a20
commit 52cbac4417
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -18,9 +18,9 @@ A command-line benchmarking tool.
* Constant feedback about the benchmark progress and current estimates. * Constant feedback about the benchmark progress and current estimates.
* Warmup runs can be executed before the actual benchmark. * Warmup runs can be executed before the actual benchmark.
* Cache-clearing commands can be set up before each timing run. * Cache-clearing commands can be set up before each timing run.
* Statistical outlier detection. * Statistical outlier detection to detect interference from other programs and caching effects.
* Export results to various formats: CSV, JSON, Markdown. * Export results to various formats: CSV, JSON, Markdown, AsciiDoc.
* Parameterized benchmarks. * Parameterized benchmarks (e.g. vary the number of threads).
* Cross-platform * Cross-platform
## Usage ## Usage
@ -77,24 +77,17 @@ Hyperfine has multiple options for exporting benchmark results: CSV, JSON, Markd
text for details). To export results to Markdown, for example, you can use the `--export-markdown` text for details). To export results to Markdown, for example, you can use the `--export-markdown`
option that will create tables like this: option that will create tables like this:
| Command | Mean [ms] | Min…Max [ms] | | Command | Mean [s] | Min [s] | Max [s] | Relative |
|:---|---:|---:| |:---|---:|---:|---:|---:|
| `find . -iregex '.*[0-9]\.jpg$'` | 506.0 ± 8.1 | 495.4…518.6 | | `find . -iregex '.*[0-9]\.jpg$'` | 2.395 ± 0.033 | 2.355 | 2.470 | 7.7 |
| `find . -iname '*[0-9].jpg'` | 304.9 ± 3.1 | 299.8…309.3 | | `find . -iname '*[0-9].jpg'` | 1.416 ± 0.029 | 1.389 | 1.494 | 4.6 |
| `fd -HI '.*[0-9]\.jpg$'` | 66.2 ± 5.8 | 62.5…86.3 | | `fd -HI '.*[0-9]\.jpg$'` | 0.309 ± 0.005 | 0.305 | 0.320 | 1.0 |
The JSON output is useful if you want to analyze the benchmark results in more detail. See the The JSON output is useful if you want to analyze the benchmark results in more detail. See the
[`scripts/`](https://github.com/sharkdp/hyperfine/tree/master/scripts) folder for some examples. [`scripts/`](https://github.com/sharkdp/hyperfine/tree/master/scripts) folder for some examples.
## Installation ## Installation
### On macOS
Hyperfine can be installed via [Homebrew](https://brew.sh):
```
brew install hyperfine
```
### On Ubuntu ### On Ubuntu
Download the appropriate `.deb` package from the [Release page](https://github.com/sharkdp/hyperfine/releases) Download the appropriate `.deb` package from the [Release page](https://github.com/sharkdp/hyperfine/releases)
@ -119,6 +112,13 @@ Hyperfine can be installed via xbps
xbps-install -S hyperfine xbps-install -S hyperfine
``` ```
### On macOS
Hyperfine can be installed via [Homebrew](https://brew.sh):
```
brew install hyperfine
```
### With conda ### With conda
![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/hyperfine.svg) ![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/hyperfine.svg)