From a10e818368838a6687907ea1521629701969ff63 Mon Sep 17 00:00:00 2001 From: Avinash Pancham Date: Sat, 3 Oct 2020 17:31:29 +0200 Subject: [PATCH] Update docs on estimated time of running full asv suite --- doc/source/development/contributing.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index d6955c5d4b8d2..e96da41918259 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1362,16 +1362,16 @@ environments. If you want to use virtualenv instead, write:: The ``-E virtualenv`` option should be added to all ``asv`` commands that run benchmarks. The default value is defined in ``asv.conf.json``. -Running the full test suite can take up to one hour and use up to 3GB of RAM. -Usually it is sufficient to paste only a subset of the results into the pull -request to show that the committed changes do not cause unexpected performance -regressions. You can run specific benchmarks using the ``-b`` flag, which -takes a regular expression. For example, this will only run tests from a -``pandas/asv_bench/benchmarks/groupby.py`` file:: +Running the full benchmark suite can be an all-day process, depending on your +hardware and its resource utilization. However, usually it is sufficient to paste +only a subset of the results into the pull request to show that the committed changes +do not cause unexpected performance regressions. You can run specific benchmarks +using the ``-b`` flag, which takes a regular expression. For example, this will +only run benchmarks from a ``pandas/asv_bench/benchmarks/groupby.py`` file:: asv continuous -f 1.1 upstream/master HEAD -b ^groupby -If you want to only run a specific group of tests from a file, you can do it +If you want to only run a specific group of benchmarks from a file, you can do it using ``.`` as a separator. For example:: asv continuous -f 1.1 upstream/master HEAD -b groupby.GroupByMethods