Metadata-Version: 2.1
Name: ir-metrics
Version: 0.1.2rc6
Summary: The most common information retrieval (IR) metrics
Home-page: https://github.com/kqf/ir-metrics
License: UNKNOWN
Description: ir-metrics |build| |downloads|
        ------------------------------
        .. |build| image:: https://travis-ci.com/kqf/ir-metrics.svg?branch=master
            :alt: Build Status
            :scale: 100%
            :target: https://travis-ci.com/kqf/ir-metrics
        
        .. |downloads| image:: https://img.shields.io/pypi/dm/ir-metrics
            :alt: PyPi downloads
            :scale: 100%
            :target: https://img.shields.io/pypi/dm/ir-metrics
        
        A set of the most common metrics in used in information retrieval.
        
        ============
        Usage
        ============
        
        The metrics are designed to work for array-like structures and integers:
        
        .. code:: python
        
            >>> from irmetrics.topk import rr
            >>> y_true = "apple"
            >>> y_pred = ["banana", "apple", "grapes"]
            >>> rr(y_true, y_pred)
            0.5
        
        The same function works also for the matrix-like structures:
        
        .. code:: python
        
            >>> import numpy as np
            >>> from irmetrics.topk import rr
            >>> y_trues = np.repeat(y_true, 128)
            >>> y_preds = np.repeat([y_pred], 128, axis=0)
            >>> # Calculate the Mean Reciprocal Rank
            >>> rr(y_trues, y_preds).mean()
            0.5
            >>> # Calculate the standard deviation for Reciprocal Ranks
            >>> rr(y_trues, y_preds).std()
            0.0
        
        ============
        Installation
        ============
        
        To install with pip, run:
        
        .. code:: bash
        
            pip install ir-metrics
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6, <4
Provides-Extra: pandas
