<commit_before>``dit`` is a Python package for information theory.

|build| |build_windows| |codecov| |health| |docs| |deps| |zenodo| |gitter| |saythanks|

Documentation:
   http://docs.dit.io

Downloads:
   https://pypi.org/project/dit/

Dependencies:
   * Python 2.7, 3.3, 3.4, 3.5, or 3.6
   * `boltons <https://boltons.readthedocs.io>`_
   * `contextlib2 <https://contextlib2.readthedocs.io>`_
   * `debtcollector <https://docs.openstack.org/debtcollector/>`_
   * `networkx <https://networkx.github.io/>`_
   * `numpy <http://www.numpy.org/>`_
   * `prettytable <https://code.google.com/archive/p/prettytable/>`_
   * `scipy <https://www.scipy.org/>`_
   * `six <http://pythonhosted.org/six/>`_

Optional Dependencies:
   * `colorama <https://pypi.python.org/pypi/colorama>`_
   * `cython <http://cython.org/>`_
   * `numdifftools <https://pypi.python.org/pypi/Numdifftools>`_
   * `pint <https://pint.readthedocs.io>`_
   * `scikit-learn <http://scikit-learn.org/>`_

Note:
   The cython extensions are currently not supported on windows. Please install
   using the ``--nocython`` option.

Install:
   The easiest way to install is:

   .. code-block:: bash

      pip install dit

   Alternatively, you can clone this repository, move into the newly created
   ``dit`` directory, and then install the package:

   .. code-block:: bash

      git clone https://github.com/dit/dit.git
      cd dit
      pip install .

Mailing list:
   None

Code and bug tracker:
   https://github.com/dit/dit

License:
   BSD 2-Clause, see LICENSE.txt for details.

Implemented Measures
--------------------

``dit`` implements the following information measures. Most of these are implemented in multivariate & conditional
generality, where such generalizations either exist in the literature or are relatively obvious --- for example,
though it is not in the literature, the multivariate conditional exact common information is implemented here.

- Entropies:

  * Shannon Entropy
  * Renyi Entropy
  * Tsallis Entropy
  * Necessary Conditional Entropy
  * Residual Entropy / Independent Information / Variation of Information

- Mutual Informations:

  * Co-Information
  * Interaction Information
  * Total Correlation / Multi-Information
  * Dual Total Correlation / Binding Information
  * CAEKL Multivariate Mutual Information

- Divergences

  * Variational Distance
  * Kullback-Leibler Divergence
  * Cross Entropy
  * Jensen-Shannon Divergence
  * Earth Mover's Distance

- Common Informations:

  * Gacs-Korner Common Information
  * Wyner Common Information
  * Exact Common Information
  * Functional Common Information
  * MSS Common Information

- Secret Key Agreement bounds:

  * Intrinsic Mutual Information
  * Reduced Intrinsic Mutual Information
  * Minimal Intrinsic Mutual Information
  * Necessary Intrinsic Mutual Information
  * Secrecy Capacity

- Partial Information Decompositions:

  * :math:`I_{min}`
  * :math:`I_{\wedge}`
  * :math:`I_{\downarrow}`
  * :math:`I_{proj}`
  * :math:`I_{BROJA}`
  * :math:`I_{ccs}`
  * :math:`I_{\pm}`
  * :math:`I_{dep}`

- Other measures
<commit_msg>add I_RAV to the readme<commit_after>``dit`` is a Python package for information theory.

|build| |build_windows| |codecov| |health| |docs| |deps| |zenodo| |gitter| |saythanks|

Documentation:
   http://docs.dit.io

Downloads:
   https://pypi.org/project/dit/

Dependencies:
   * Python 2.7, 3.3, 3.4, 3.5, or 3.6
   * `boltons <https://boltons.readthedocs.io>`_
   * `contextlib2 <https://contextlib2.readthedocs.io>`_
   * `debtcollector <https://docs.openstack.org/debtcollector/>`_
   * `networkx <https://networkx.github.io/>`_
   * `numpy <http://www.numpy.org/>`_
   * `prettytable <https://code.google.com/archive/p/prettytable/>`_
   * `scipy <https://www.scipy.org/>`_
   * `six <http://pythonhosted.org/six/>`_

Optional Dependencies:
   * `colorama <https://pypi.python.org/pypi/colorama>`_
   * `cython <http://cython.org/>`_
   * `numdifftools <https://pypi.python.org/pypi/Numdifftools>`_
   * `pint <https://pint.readthedocs.io>`_
   * `scikit-learn <http://scikit-learn.org/>`_

Note:
   The cython extensions are currently not supported on windows. Please install
   using the ``--nocython`` option.

Install:
   The easiest way to install is:

   .. code-block:: bash

      pip install dit

   Alternatively, you can clone this repository, move into the newly created
   ``dit`` directory, and then install the package:

   .. code-block:: bash

      git clone https://github.com/dit/dit.git
      cd dit
      pip install .

Mailing list:
   None

Code and bug tracker:
   https://github.com/dit/dit

License:
   BSD 2-Clause, see LICENSE.txt for details.

Implemented Measures
--------------------

``dit`` implements the following information measures. Most of these are implemented in multivariate & conditional
generality, where such generalizations either exist in the literature or are relatively obvious --- for example,
though it is not in the literature, the multivariate conditional exact common information is implemented here.

- Entropies:

  * Shannon Entropy
  * Renyi Entropy
  * Tsallis Entropy
  * Necessary Conditional Entropy
  * Residual Entropy / Independent Information / Variation of Information

- Mutual Informations:

  * Co-Information
  * Interaction Information
  * Total Correlation / Multi-Information
  * Dual Total Correlation / Binding Information
  * CAEKL Multivariate Mutual Information

- Divergences

  * Variational Distance
  * Kullback-Leibler Divergence
  * Cross Entropy
  * Jensen-Shannon Divergence
  * Earth Mover's Distance

- Common Informations:

  * Gacs-Korner Common Information
  * Wyner Common Information
  * Exact Common Information
  * Functional Common Information
  * MSS Common Information

- Secret Key Agreement bounds:

  * Intrinsic Mutual Information
  * Reduced Intrinsic Mutual Information
  * Minimal Intrinsic Mutual Information
  * Necessary Intrinsic Mutual Information
  * Secrecy Capacity

- Partial Information Decompositions:

  * :math:`I_{min}`
  * :math:`I_{\wedge}`
  * :math:`I_{\downarrow}`
  * :math:`I_{proj}`
  * :math:`I_{BROJA}`
  * :math:`I_{ccs}`
  * :math:`I_{\pm}`
  * :math:`I_{dep}`
  * :math:`I_{RAV}`

- Other measures

{'fraction_non_alphanumeric': 0.12508007687379885, 'fraction_numerical': 0.004163997437540038, 'mean_word_length': 3.522085445329471, 'pattern_counts': {'":': 0, '<': 29, '<?xml version=': 0, '>': 29, 'https://': 24, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7163290', 'n_tokens_mistral': 2114, 'n_tokens_neox': 1972, 'n_words': 547}