Skip to content

DOC: clarification on -b flag in asv #10935

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
Aug 31, 2015
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
26 changes: 24 additions & 2 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -517,15 +517,18 @@ performance regressions. *pandas* is in the process of migrating to the
`asv library <https://github.com/spacetelescope/asv>`__
to enable easy monitoring of the performance of critical *pandas* operations.
These benchmarks are all found in the ``pandas/asv_bench`` directory. *asv*
supports both python2 and python3.
supports both python2 and python3.

.. note::

The *asv* benchmark suite was translated from the previous framework, vbench,
so many stylistic issues are likely a result of automated transformation of the
code.

To install asv::
To use ''asv'' you will need either ''conda'' or ''virtualenv''. For more details
please check installation webpage http://asv.readthedocs.org/en/latest/installing.html

To install ''asv''::

pip install git+https://github.com/spacetelescope/asv

Expand All @@ -546,6 +549,25 @@ to 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::

asv continuous master -b groupby

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

asv continuous master -b groupby.groupby_agg_builtins1

will only run a ``groupby_agg_builtins1`` test defined in a ``groupby`` file.

It is also useful to run tests in your current environment. You can simply do it by::

asv dev

which would be equivalent to ``asv run --quick --show-stderr --python=same``. This
will launch every test only once, display stderr from the benchmarks and use your
local ``python'' that comes from your $PATH.

Information on how to write a benchmark can be found in
`*asv*'s documentation http://asv.readthedocs.org/en/latest/writing_benchmarks.html`.
Expand Down