Skip to content

Commit

Permalink
Merge pull request OpenMathLib#5009 from martin-frbg/pybenchdoc
Browse files Browse the repository at this point in the history
DOCS, pybench : Add build notes for Windows and flang from gh Discussion 5008
  • Loading branch information
martin-frbg authored Dec 6, 2024
2 parents 81666de + 0f8ff82 commit 72f7b70
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion benchmark/pybench/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,17 @@ have all what it takes to build OpenBLAS from source, plus `python` and
$ python -mpip install numpy meson ninja pytest pytest-benchmark
```

The benchmark syntax is consistent with that of `pytest-benchmark` framework. The incantation to run the suite locally is `$ pytest benchmark/pybench/benchmarks/test_blas.py`.
The Meson build system looks for the installed OpenBLAS using pkgconfig, so the openblas.pc created during the OpenBLAS build needs
to be somewhere on the search path of pkgconfig or in a folder pointed to by the environment variable PKG_CONFIG_PATH.

If you want to build the benchmark suite using flang (or flang-new) instead of gfortran for the Fortran parts, you currently need
to edit the meson.build file and change the line `'fortran_std=legacy'` to `'fortran_std=none'` to work around an incompatibility
between Meson and flang.

If you are building and running the benchmark under MS Windows, it may be necessary to copy the generated openblas_wrap module from
your build folder to the `benchmarks` folder.

The benchmark syntax is consistent with that of `pytest-benchmark` framework. The incantation to run the suite locally is `$ pytest benchmark/pybench/benchmarks/bench_blas.py`.

An ASV compatible benchmark suite is planned but currently not implemented.

0 comments on commit 72f7b70

Please sign in to comment.