https://github.com/hpyproject/asv

Airspeed Velocity: A simple Python benchmarking tool with web-based reporting
https://github.com/hpyproject/asv

Last synced: about 2 months ago
JSON representation

Airspeed Velocity: A simple Python benchmarking tool with web-based reporting

• Host: GitHub
• URL: https://github.com/hpyproject/asv
• Owner: hpyproject
• License: bsd-3-clause
• Created: 2023-07-09T20:26:21.000Z (over 1 year ago)
• Default Branch: graal-team
• Last Pushed: 2023-07-09T21:17:58.000Z (over 1 year ago)
• Last Synced: 2024-02-23T16:31:39.719Z (11 months ago)
• Language: Python
• Size: 3.4 MB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

        
airspeed velocity

=================

**airspeed velocity** (``asv``) is a tool for benchmarking Python

packages over their lifetime.

It is primarily designed to benchmark a single project over its

lifetime using a given suite of benchmarks.  The results are displayed

in an interactive web frontend that requires only a basic static

webserver to host.

See an `example airspeed velocity site `__.

See the `full documentation `__

for more information.

The latest release can be installed from PyPI using::

    pip install asv

Are you using ``asv``?  Consider adding a badge to your project's

README like this:

.. image:: http://img.shields.io/badge/benchmarked%20by-asv-blue.svg?style=flat

By using the following markdown::

  [![asv](http://img.shields.io/badge/benchmarked%20by-asv-blue.svg?style=flat)](http://your-url-here/)

**HPy project contributions**:

* Add support for reporing max-rss to asv::

    --maxrss ATTRIBUTE    

        

        Calculate maxrss of a timed benchmarks. 

        This will only collect maxrss instead of time. 

        Using 'once' will run the benchmark once.

        Using 'full' Calculate maxrss of a timed 

        benchmarks with all the configured options, e.g. repeat, warmup, etc

e.g.::

    asv run --python=python3 -v -e --set-commit-hash 42xxxfoo_project_commit_hashxxx42 -b 'foo_benchmark*' --maxrss once

* add warmup count option to Airspeed Velocity framework::

    --attribute warmup_count=, -a warmup_count=

        will run the benchmark this number of time(s), 

        e.g. ``warmup_count=10``, before starting to 

        run the actual benchmark.

e.g.::

    asv run --python=python3 -v -e --set-commit-hash 42xxxfoo_project_commit_hashxxx42 -b 'foo_benchmark*' -a warmup_count=1

* Add machines comparison list to Airspeed Velocity framework::

    

    --baseline-machine BASELINE_MACHINE

        Optional baseline comparisons between machines. 

        Provide machine name

e.g.::

    # adjust foo project to use configuration1

    asv run --python=python3 -v -e --set-commit-hash 42xxxfoo_project_commit_hashxxx42 -b 'foo_benchmark*' -m configuration1

    # adjust foo project to use configuration2

    asv run --python=python3 -v -e --set-commit-hash 42xxxfoo_project_commit_hashxxx42 -b 'foo_benchmark*' -m configuration2

    # adjust foo project to use configuration3

    asv run --python=python3 -v -e --set-commit-hash 42xxxfoo_project_commit_hashxxx42 -b 'foo_benchmark*' -m configuration3

    asv publish --baseline-machine configuration1 --generate-markdown

    asv preview

License: `BSD three-clause license

`__.

Authors: Michael Droettboom, Pauli Virtanen