Skip to content

Commit 6dcf053

Browse files
committed
DOC: update the README (how to run asv locally)
1 parent 9911a94 commit 6dcf053

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ Web version: http://www.openmathlib.org/BLAS-Benchmarks/
55

66
Text timings are visible from the [Actions tab](https://github.com/OpenMathLib/BLAS-Benchmarks/actions), for individual arches --- click on an "ASV Benchmarks" workflow run, then select a desired architecture, and expand the "Run benchmarks" section. Here is [one example](https://github.com/OpenMathLib/BLAS-Benchmarks/actions/runs/9616185161/job/26525115646).
77

8+
9+
Benchmark suite
10+
===============
11+
12+
The suite is similar to the one which runs on PRs to the OpenBLAS repository
13+
via codspeed: https://github.com/OpenMathLib/OpenBLAS/tree/develop/benchmark/pybench
14+
15+
816
CI orchestration
917
================
1018

@@ -39,15 +47,40 @@ benchmarking run.
3947
Running benchmarks locally
4048
==========================
4149

42-
4350
To run the benchmark suite locally, first do
4451

4552
```
4653
$ python -c "import scipy_openblas32; print(scipy_openblas32.get_pkg_config())" > scipy_openblas.pc
4754
$ export PKG_CONFIG_PATH=$PWD
4855
```
4956

50-
and then
57+
Then either edit `asv.conf.json` to point to the `main` branch:
58+
59+
```diff
60+
$ git diff
61+
diff --git a/asv.conf.json b/asv.conf.json
62+
index ded988b..99e4ff3 100644
63+
--- a/asv.conf.json
64+
+++ b/asv.conf.json
65+
@@ -40,7 +40,7 @@
66+
67+
// List of branches to benchmark. If not provided, defaults to "main"
68+
// (for git) or "default" (for mercurial).
69+
- "branches": ["tracker"], // for git
70+
+ "branches": ["main"], // for git
71+
// "branches": ["default"], // for mercurial
72+
```
73+
74+
or update the `tracker` branch to follow `main`:
75+
76+
```
77+
$ git co tracker
78+
$ git revert HEAD
79+
$ git merge --squash main
80+
$ git co main
81+
```
82+
83+
Finally, run
5184

5285
```
5386
$ asv run -v

0 commit comments

Comments
 (0)