DOC: Add details on benchmarking versions

1 files changed, 20 insertions, 0 deletions

diff --git a/benchmarks/README.rst b/benchmarks/README.rst
index 2700e95e7..59f503e35 100644
--- a/benchmarks/README.rst
+++ b/benchmarks/README.rst
@@ -69,6 +69,26 @@ Command-line help is available as usual via ``asv --help`` and
 
 .. _ASV documentation: https://asv.readthedocs.io/
 
+Benchmarking versions
+---------------------
+
+To benchmark or visualize only releases on different machines locally, the tags with their commits can be generated, before being run with ``asv``, that is::
+
+    cd benchmarks
+    # Get commits for tags
+    # delete tag_commits.txt before re-runs
+    for gtag in $(git tag --list --sort taggerdate | grep "^v"); do
+    git log $gtag --oneline -n1 --decorate=no | awk -v gtg="$gtag" '{print $1, gtg;}' >> tag_commits.txt
+    done
+    # Take last 20
+    for commitLine in $(tail --lines=20 tag_commits.txt); do
+    asv run $(echo $commitLine | awk '{print $1}')^!
+    done
+    # Publish and view
+    asv publish
+    asv preview
+
+Note that this can still be a significant time commitment. Do not open pull requests to the main repository with these results.
 
 Writing benchmarks
 ------------------