Metadata-Version: 2.0
Name: perfume-bench
Version: 0.1.2
Summary: Interactive performance benchmarking in Jupyter
Home-page: https://github.com/leifwalsh/perfume
Author: Leif Walsh
Author-email: leif.walsh@gmail.com
License: BSD license
Keywords: perfume python performance benchmarking jupyter interactive
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.4, <4
Requires-Dist: bokeh (>=0.12)
Requires-Dist: ipython (>=5.0)
Requires-Dist: ipywidgets (>=5.0)
Requires-Dist: matplotlib (>=2.0)
Requires-Dist: notebook (>=5.0)
Requires-Dist: numpy (>=1.11)
Requires-Dist: pandas (>=0.19)
Requires-Dist: seaborn (>=0.7)
Requires-Dist: statsmodels (>=0.8)

=======
perfume
=======


.. image:: https://img.shields.io/pypi/v/perfume-bench.svg
        :target: https://pypi.python.org/pypi/perfume-bench

.. image:: https://img.shields.io/travis/leifwalsh/perfume.svg
        :target: https://travis-ci.org/leifwalsh/perfume

.. image:: https://readthedocs.org/projects/perfume/badge/?version=latest
        :target: https://perfume.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/leifwalsh/perfume/shield.svg
        :target: https://pyup.io/repos/github/leifwalsh/perfume/
        :alt: Updates


Interactive performance benchmarking in Jupyter


* Free software: BSD license
* Documentation: https://perfume.readthedocs.io.

Overview
--------

`perfume` is a performance benchmarking tool that provides quick
feedback on the systems under test.

The primary goals are:

* Prioritize analysis of *distributions* of latency, not averages.
* Support both immediate feedback and robust benchmarking with many
  samples, through a UI that updates as we collect more information.
* Provide raw data back to the user, for flexible custom analysis.
* Provide helpful post-processing analysis and charting tools.

Features
--------

* Live-updating histogram chart and descriptive statistics during a
  benchmark run.
* Jupyter notebook integration.
* Tunable benchmarking overhead.
* Comparative analysis of multiple functions under test.
* Powerful post-processing analysis tools.

Demo
----

You can check out `an example notebook <docs/example.ipynb>`__ using
perfume.

.. image:: docs/perfume.gif

.. image:: docs/cumulative_quantiles.png

Installing
----------

.. code-block:: none

    pip install perfume-bench

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage



=======
History
=======

0.1.2 (2017-09-10)
------------------

* Fix when only benchmarking one function (no K-S test).

0.1.1 (2017-08-27)
------------------

* Add dependency on matplotlib.

0.1.0 (2017-08-27)
------------------

* First release on PyPI.
* Interactive histogram while benchmarking with bokeh.
* Interactive descriptive stats and K-S test.
* Cumulative distribution plots.
* Bucketed resampling.


