mirror of
https://github.com/sharkdp/hyperfine.git
synced 2026-11-19 10:51:31 +00:00
Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ef68fef336 |
No files matched your search
+22
-3
@@ -3,7 +3,8 @@
|
|||||||
hyperfine \- command\-line benchmarking tool
|
hyperfine \- command\-line benchmarking tool
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B hyperfine
|
.B hyperfine
|
||||||
.RB [ \-ihVN ]
|
.RB [ \-hVN ]
|
||||||
|
.RB [ \-\-ignore\-failure[=MODE] ]
|
||||||
.RB [ \-\-warmup
|
.RB [ \-\-warmup
|
||||||
.IR NUM ]
|
.IR NUM ]
|
||||||
.RB [ \-\-min\-runs
|
.RB [ \-\-min\-runs
|
||||||
@@ -14,6 +15,10 @@ hyperfine \- command\-line benchmarking tool
|
|||||||
.IR NUM ]
|
.IR NUM ]
|
||||||
.RB [ \-\-setup
|
.RB [ \-\-setup
|
||||||
.IR CMD ]
|
.IR CMD ]
|
||||||
|
.RB [ \-\-reference
|
||||||
|
.IR CMD ]
|
||||||
|
.RB [ \-\-reference\-name
|
||||||
|
.IR NAME ]
|
||||||
.RB [ \-\-prepare
|
.RB [ \-\-prepare
|
||||||
.IR CMD ]
|
.IR CMD ]
|
||||||
.RB [ \-\-conclude
|
.RB [ \-\-conclude
|
||||||
@@ -109,6 +114,16 @@ for compiling your software or with the provided parameters, or to do any
|
|||||||
other work that should happen once before a series of benchmark runs,
|
other work that should happen once before a series of benchmark runs,
|
||||||
not every time as would happen with the \fB\-\-prepare\fR option.
|
not every time as would happen with the \fB\-\-prepare\fR option.
|
||||||
.HP
|
.HP
|
||||||
|
\fB\-\-reference\fR \fICMD\fP
|
||||||
|
.IP
|
||||||
|
Benchmark \fICMD\fP as the reference for the relative comparison of results.
|
||||||
|
If this option is not specified, the fastest command is used as the reference.
|
||||||
|
.HP
|
||||||
|
\fB\-\-reference\-name\fR \fINAME\fP
|
||||||
|
.IP
|
||||||
|
Give a meaningful \fINAME\fP to the reference command.
|
||||||
|
Requires \fB\-\-reference\fR.
|
||||||
|
.HP
|
||||||
\fB\-p\fR, \fB\-\-prepare\fR \fICMD...\fP
|
\fB\-p\fR, \fB\-\-prepare\fR \fICMD...\fP
|
||||||
.IP
|
.IP
|
||||||
Execute \fICMD\fP before each timing run. This is useful for clearing disk caches,
|
Execute \fICMD\fP before each timing run. This is useful for clearing disk caches,
|
||||||
@@ -207,9 +222,13 @@ things like "sleep 0.1; sleep 0.2" are not possible without a shell.
|
|||||||
.IP
|
.IP
|
||||||
An alias for '\-\-shell=none'.
|
An alias for '\-\-shell=none'.
|
||||||
.HP
|
.HP
|
||||||
\fB\-i\fR, \fB\-\-ignore\-failure\fR
|
\fB\-i\fR, \fB\-\-ignore\-failure\fR[=\fIMODE\fP]
|
||||||
.IP
|
.IP
|
||||||
Ignore non\-zero exit codes of the benchmarked programs.
|
Ignore failures of the benchmarked programs. Without a value or with
|
||||||
|
\fBall\-non\-zero\fR, all non\-zero exit codes are ignored.
|
||||||
|
Alternatively, provide a comma\-separated list of exit codes to ignore,
|
||||||
|
for example \fB\-\-ignore\-failure=1,2\fR.
|
||||||
|
An explicit value must be attached to the option with an equals sign.
|
||||||
.HP
|
.HP
|
||||||
\fB\-\-style\fR \fITYPE\fP
|
\fB\-\-style\fR \fITYPE\fP
|
||||||
.IP
|
.IP
|
||||||
|
|||||||
+15
-6
@@ -4,14 +4,23 @@ This folder contains scripts that can be used in combination with hyperfines `--
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json
|
hyperfine 'sleep 0.020' 'sleep 0.021' 'sleep 0.022' --export-json sleep.json
|
||||||
uv run plot_whisker.py sleep.json
|
./plot_whisker.py sleep.json
|
||||||
```
|
```
|
||||||
|
|
||||||
### Pre-requisites
|
### Pre-requisites
|
||||||
|
|
||||||
Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) and run the
|
To make these scripts work, you will need `numpy`, `matplotlib` and `scipy`.
|
||||||
commands above from this directory.
|
|
||||||
|
|
||||||
The scripts declare their dependencies using [PEP 723](https://peps.python.org/pep-0723/)
|
If you have a Python package manager that understands [PEP-723](https://peps.python.org/pep-0723/)
|
||||||
inline script metadata. `uv run` automatically installs these dependencies in an
|
inline script requirements like [`uv`](https://github.com/astral-sh/uv) or [`pipx`](https://github.com/pypa/pipx),
|
||||||
isolated environment before running the script.
|
you can directly run the scripts using
|
||||||
|
|
||||||
|
```bash
|
||||||
|
uv run plot_whisker.py sleep.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Otherwise, install the dependencies via your system package manager or using `pip`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install numpy matplotlib scipy # pip3, if you are using python3
|
||||||
|
```
|
||||||
Reference in new issue
Block a user