Skip to content

Commit fcf2d86

Browse files
pvjorisvandenbossche
authored andcommitted
DOC: contributing: explain how to set the asv reporting threshold (#13807)
The default asv reporting threshold is 100% change (2x), which probably is too large for pandas, so instruct how to set it lower.
1 parent a3cddfa commit fcf2d86

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/source/contributing.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -577,13 +577,14 @@ To install asv::
577577

578578
If you need to run a benchmark, change your directory to ``asv_bench/`` and run::
579579

580-
asv continuous upstream/master HEAD
580+
asv continuous -f 1.1 upstream/master HEAD
581581

582-
You can replace ``HEAD`` with the name of the branch you are working on.
582+
You can replace ``HEAD`` with the name of the branch you are working on,
583+
and report benchmarks that changed by more than 10%.
583584
The command uses ``conda`` by default for creating the benchmark
584585
environments. If you want to use virtualenv instead, write::
585586

586-
asv continuous -E virtualenv upstream/master HEAD
587+
asv continuous -f 1.1 -E virtualenv upstream/master HEAD
587588

588589
The ``-E virtualenv`` option should be added to all ``asv`` commands
589590
that run benchmarks. The default value is defined in ``asv.conf.json``.
@@ -595,12 +596,12 @@ regressions. You can run specific benchmarks using the ``-b`` flag, which
595596
takes a regular expression. For example, this will only run tests from a
596597
``pandas/asv_bench/benchmarks/groupby.py`` file::
597598

598-
asv continuous upstream/master HEAD -b groupby
599+
asv continuous -f 1.1 upstream/master HEAD -b ^groupby
599600

600601
If you want to only run a specific group of tests from a file, you can do it
601602
using ``.`` as a separator. For example::
602603

603-
asv continuous upstream/master HEAD -b groupby.groupby_agg_builtins
604+
asv continuous -f 1.1 upstream/master HEAD -b groupby.groupby_agg_builtins
604605

605606
will only run the ``groupby_agg_builtins`` benchmark defined in ``groupby.py``.
606607

0 commit comments

Comments
 (0)