Skip to content

Commit 2c5fce7

Browse files
committed
Added minor documentation
1 parent 4b97f88 commit 2c5fce7

2 files changed

Lines changed: 36 additions & 2 deletions

File tree

asv.conf.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"version":1,
33
"benchmark_dir": "./benchmarks",
4-
"repo":"git@github.com:ms2892/pystack.git",
4+
"repo":"git@github.com:bloomberg/pystack.git",
55
"project": "pystack",
6-
"project_url": "https://github.com/ms2892/pystack",
6+
"project_url": "https://github.com/bloomberg/pystack",
77
"env_dir":".asv/env",
88
"results_dir":".asv/results",
99
"html_dir":".asv/html",

benchmarks/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Using the Benchmarking Tool
2+
3+
One of the prerequisites is to have the respective libraries installed. Hence do install the following libraries
4+
5+
- libdw
6+
- libelf
7+
8+
These can be installed via the command `apt-get install libdw-dev libelf-dev`.
9+
10+
To benchmark the packages present another tool is used called `airspeed velocity`. To install it please run the follow command
11+
12+
```pip install asv```
13+
14+
In the parent directory run the following command to get a brief benchmark of your current packages
15+
16+
```asv run```
17+
18+
Use the `-v` flag to get a verbose output.
19+
20+
To compare the all the commits across all the branches you may make use of the following command.
21+
22+
```asv run ALL```
23+
24+
To run benchmarks from a particular commit or tag you can use the commit hash or the tag
25+
26+
```asv run [TAG|HASH]..[branch]```
27+
28+
To compare between tags
29+
30+
```asv show [TAG]..[branch]```
31+
32+
To have a local server to display all the graphs
33+
34+
```asv publish```

0 commit comments

Comments
 (0)