.. |gitlogo| image:: _static/git_logo.png
             :height: 20

.. image:: https://github.com/sdpython/pymlbenchmark/blob/master/_doc/sphinxdoc/source/_static/project_ico.png?raw=true
    :target: https://github.com/sdpython/pymlbenchmark/

Benchmarks around Machine Learning with Python
==============================================

This project started with my first attempt
to bring a modification to :epkg:`scikit-learn`.
My first `pull request <https://github.com/scikit-learn/scikit-learn/pull/13290>`_
was about optimizing the computation of polynomial features.
I reused the template to measure various implementations
or models.

.. toctree::
    :maxdepth: 1

    api/index
    gyexamples/index
    all_notebooks
    blog/blogindex
    i_ex
    technical
    i_faq
    i_index
    LICENSE
    HISTORY

The project is used to avoid too much replications
of code in projects :epkg:`Benchmarks about Machine Learning`.
It produces the following figures.

.. html::

    <img src="_images/sphx_glr_plot_bench_onnxruntime_logistic_regression_001.png" width="500" />

**Links:** `github <https://github.com/sdpython/pymlbenchmark/>`_,
`documentation <http://www.xavierdupre.fr/app/pymlbenchmark/helpsphinx/index.html>`_,
:ref:`l-README`,
:ref:`blog <ap-main-0>`

.. image:: https://travis-ci.com/sdpython/pymlbenchmark.svg?branch=master
    :target: https://app.travis-ci.com/github/sdpython/pymlbenchmark
    :alt: Build status

.. image:: https://ci.appveyor.com/api/projects/status/l2lk7a0r2pccpg3r?svg=true
    :target: https://ci.appveyor.com/project/sdpython/pymlbenchmark
    :alt: Build Status Windows

.. image:: https://circleci.com/gh/sdpython/pymlbenchmark/tree/master.svg?style=svg
    :target: https://circleci.com/gh/sdpython/pymlbenchmark/tree/master

.. image:: https://badge.fury.io/py/pymlbenchmark.svg
    :target: https://pypi.org/project/pymlbenchmark/

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :alt: MIT License
    :target: http://opensource.org/licenses/MIT

.. image:: https://codecov.io/github/sdpython/pymlbenchmark/coverage.svg?branch=master
    :target: https://codecov.io/github/sdpython/pymlbenchmark?branch=master

.. image:: http://img.shields.io/github/issues/sdpython/pymlbenchmark.png
    :alt: GitHub Issues
    :target: https://github.com/sdpython/pymlbenchmark/issues

.. image:: nbcov.png
    :target: http://www.xavierdupre.fr/app/pymlbenchmark/helpsphinx/all_notebooks_coverage.html
    :alt: Notebook Coverage

+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`l-modules`     |  :ref:`l-functions` | :ref:`l-classes`    | :ref:`l-methods`   | :ref:`l-staticmethods` | :ref:`l-properties`                            |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`modindex`      |  :ref:`l-EX2`       | :ref:`search`       | :ref:`l-license`   | :ref:`l-changes`       | :ref:`l-README`                                |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`genindex`      |  :ref:`l-FAQ2`      | :ref:`l-notebooks`  |                    | :ref:`l-statcode`      | `Unit Test Coverage <coverage/index.html>`_    |
+----------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+