summaryrefslogtreecommitdiff
path: root/benchmarks/README.rst
diff options
context:
space:
mode:
authorRohit Goswami <rog32@hi.is>2023-01-01 22:55:09 +0530
committerRohit Goswami <rog32@hi.is>2023-01-01 22:56:20 +0530
commit922c477213244f668af27b4b1f833e02bd914c9c (patch)
tree7021194a7be59f0ec8c6123a9f51b9cc06789c88 /benchmarks/README.rst
parenta299a1afeaf06d6d4a5f24db2acd447c6a40e120 (diff)
downloadnumpy-922c477213244f668af27b4b1f833e02bd914c9c.tar.gz
DOC: Update to clarify local benchmark testing
Diffstat (limited to 'benchmarks/README.rst')
-rw-r--r--benchmarks/README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/benchmarks/README.rst b/benchmarks/README.rst
index 4a79ba393..c02ccfb5d 100644
--- a/benchmarks/README.rst
+++ b/benchmarks/README.rst
@@ -22,6 +22,9 @@ By default, `asv` ships with support for anaconda and virtualenv::
pip install asv
pip install virtualenv
+After contributing new benchmarks, you should test them locally before
+submitting a pull request.
+
To run all benchmarks, navigate to the root NumPy directory at
the command line and execute::
@@ -33,6 +36,14 @@ defined in ``benchmarks/``. (Note: this could take a while. Each
benchmark is run multiple times to measure the distribution in
execution times.)
+For **testing** benchmarks locally, it may be better to run these without
+replications::
+
+ cd benchmarks/
+ asv run -n -e --python=same -q -b $REGEXP
+
+Where the regular expression used to match benchmarks is stored in ``$REGEXP``.
+
To run benchmarks from a particular benchmark module, such as
``bench_core.py``, simply append the filename without the extension::