infomeasure Documentation

infomeasure Documentation#

On these pages you can find documentation for infomeasure.

What is infomeasure?#

infomeasure is a Python library for computing information measures, such as entropy, mutual information and conditional mutual information. It provides a simple and efficient way to compute these measures on large datasets. The Reference pages provide a comprehensive, theoretical background on the concepts behind these measures, while the Demos provide practical examples of how to use infomeasure in real-world applications.

Setup and use#

To set up infomeasure, see the Getting started page, more on the details of the inner workings can be found on the Reference pages. Furthermore, you can also find the API documentation.

How to cite#

If you use infomeasure in your research, find the CITATION.cff file in the repository and cite it accordingly. GitHub provides a “Cite this repository” button on the right side of the page for an APA and BibTeX citation.

Contributing#

If you want to contribute to the development of infomeasure, please read the CONTRIBUTING.md file.