https://github.com/crypdick/precision-recall-gain

Precision-recall-gain for Python
https://github.com/crypdick/precision-recall-gain

classification machine-learning metrics precision recall

Last synced: 2 months ago
JSON representation

Precision-recall-gain for Python

• Host: GitHub
• URL: https://github.com/crypdick/precision-recall-gain
• Owner: crypdick
• License: mit
• Created: 2021-03-20T18:33:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-17T01:56:40.000Z (over 1 year ago)
• Last Synced: 2025-07-27T06:39:44.602Z (2 months ago)
• Topics: classification, machine-learning, metrics, precision, recall
• Language: Python
• Homepage: https://precision-recall-gain.readthedocs.io/en/latest/
• Size: 127 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

          
========

Overview

========

.. start-badges

.. list-table::

    :stub-columns: 1

    * - docs

      - |docs|

    * - tests

      - | |github-actions|

        | |coveralls| |codecov|

        | |scrutinizer|

    * - package

      - | |version| |wheel| |supported-versions| |supported-implementations|

        | |commits-since|

.. |docs| image:: https://readthedocs.org/projects/precision-recall-gain/badge/?style=flat

    :target: https://precision-recall-gain.readthedocs.io/

    :alt: Documentation Status

.. |github-actions| image:: https://github.com/crypdick/precision-recall-gain/actions/workflows/github-actions.yml/badge.svg

    :alt: GitHub Actions Build Status

    :target: https://github.com/crypdick/precision-recall-gain/actions

.. |coveralls| image:: https://coveralls.io/repos/github/crypdick/precision-recall-gain/badge.svg?branch=master

    :alt: Coverage Status

    :target: https://coveralls.io/github/crypdick/precision-recall-gain?branch=master

.. |codecov| image:: https://codecov.io/gh/crypdick/precision-recall-gain/branch/master/graphs/badge.svg?branch=master

    :alt: Coverage Status

    :target: https://app.codecov.io/github/crypdick/precision-recall-gain

.. |version| image:: https://img.shields.io/pypi/v/precision-recall-gain.svg

    :alt: PyPI Package latest release

    :target: https://pypi.org/project/precision-recall-gain

.. |wheel| image:: https://img.shields.io/pypi/wheel/precision-recall-gain.svg

    :alt: PyPI Wheel

    :target: https://pypi.org/project/precision-recall-gain

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/precision-recall-gain.svg

    :alt: Supported versions

    :target: https://pypi.org/project/precision-recall-gain

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/precision-recall-gain.svg

    :alt: Supported implementations

    :target: https://pypi.org/project/precision-recall-gain

.. |commits-since| image:: https://img.shields.io/github/commits-since/crypdick/precision-recall-gain/v0.1.3.svg

    :alt: Commits since latest release

    :target: https://github.com/crypdick/precision-recall-gain/compare/v0.1.3...master

.. |scrutinizer| image:: https://img.shields.io/scrutinizer/quality/g/crypdick/precision-recall-gain/master.svg

    :alt: Scrutinizer Status

    :target: https://scrutinizer-ci.com/g/crypdick/precision-recall-gain/

.. end-badges

Precision-recall-gain curves for Python

* Free software: MIT license

Installation

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

::

    pip install precision-recall-gain

You can also install the in-development version with::

    pip install https://github.com/crypdick/precision-recall-gain/archive/master.zip

Documentation

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

https://precision-recall-gain.readthedocs.io/

Development

===========

To run all the tests run::

    tox

Note, to combine the coverage data from all the tox environments run:

.. list-table::

    :widths: 10 90

    :stub-columns: 1

    - - Windows

      - ::

            set PYTEST_ADDOPTS=--cov-append

            tox

    - - Other

      - ::

            PYTEST_ADDOPTS=--cov-append tox

References

===========

* [Precision-Recall-Gain Curves: PR Analysis Done Right (2015) by Peter A. Flach and Meelis Kull](https://papers.nips.cc/paper/2015/file/33e8075e9970de0cfea955afd4644bb2-Paper.pdf)

* [sklearn-compatible implementation](https://github.com/scikit-learn/scikit-learn/pull/24121) by [Bradley Fowler](https://github.com/bradleyfowler123)

* [Blog post by Bradley Fowler](https://snorkel.ai/improving-upon-precision-recall-and-f1-with-gain-metrics/)

* [Original implementation](https://github.com/meeliskull/prg) by [Meelis Kull](https://github.com/meeliskull)