Skip to content

Commit 6b5d96d

Browse files
committed
Describe the usage for benchmarks
1 parent 97bd9c2 commit 6b5d96d

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

extras/profiling/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,25 @@ to automate this testing accross versions.
66

77
## Usage
88

9-
### Requirements
10-
9+
Ensure the following requirements are satisfied:
1110
- Python 3.7+
1211
- `pyperf`
1312

13+
Then, run the `extras/benchmarks/run.py`:
14+
```
15+
$ python extras/profiling/run.py
16+
```
17+
18+
Without any options, this command will initially create
19+
an isolated environment and install `httpie` from the
20+
latest commit. Then it will create a second environment
21+
with the `master` of the current repository and run the
22+
benchmarks on both of them. It will compare the results
23+
and print it as a markdown table:
24+
25+
| Benchmark | master | this_branch |
26+
|----------------------------------------|:------:|:--------------------:|
27+
| `http --version` (startup) | 201 ms | 174 ms: 1.16x faster |
28+
| `http --offline pie.dev/get` (startup) | 200 ms | 174 ms: 1.15x faster |
29+
| Geometric mean | (ref) | 1.10x faster |
30+

0 commit comments

Comments
 (0)