Skip to content

DOC: contributing: explain how to set the asv reporting threshold #13807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 27, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -577,13 +577,14 @@ To install asv::

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

asv continuous upstream/master HEAD
asv continuous -f 1.1 upstream/master HEAD

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

asv continuous -E virtualenv upstream/master HEAD
asv continuous -f 1.1 -E virtualenv upstream/master HEAD

The ``-E virtualenv`` option should be added to all ``asv`` commands
that run benchmarks. The default value is defined in ``asv.conf.json``.
Expand All @@ -595,12 +596,12 @@ 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::

asv continuous upstream/master HEAD -b groupby
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
using ``.`` as a separator. For example::

asv continuous upstream/master HEAD -b groupby.groupby_agg_builtins
asv continuous -f 1.1 upstream/master HEAD -b groupby.groupby_agg_builtins

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

Expand Down