Metadata-Version: 2.1
Name: pygini
Version: 1.0.0
Summary: Compute the Gini index.
Home-page: https://github.com/mckib2/pygini
Author: Nicholas McKibben
Author-email: nicholas.bgp@gmail.com
License: GPLv3
Keywords: gini gini-index sparsity
Platform: UNKNOWN
Requires-Python: >=3.6
Requires-Dist: numpy (>=1.17.4)

pygini
======

Very simple module that computes the Gini index of a numpy array.

Installation
============

.. code-block:: bash

    pip install pygini

Usage
=====

.. code-block:: python

    import numpy as np
    from pygini import gini

    RG = np.random.default_rng(0)
    A = RG.random(100)
    GI = gini(A)

    # Also compute along axis
    A = RG.random((100, 80, 80))
    GI = gini(A, axis=0)

    # GI.shape = (80, 80)

See `examples` directory.


