Skip to main content

A toolbox for practical applications of information theory.

Project description

UNITE Toolbox

Unified diagnostic evaluation of scientific models based on information theory

PyPI - Version Tests Badge Coverage Identifier

The UNITE Toolbox is a Python library for incorporating Information Theory into data analysis and modeling workflows. The toolbox collects different methods of estimating information-theoretic quantities in one easy-to-use Python package. Currently, UNITE includes functions to calculate entropy $H(X)$, Kullback-Leibler divergence $D_{KL}(p||q)$, and mutual information $I(X; Y)$, using three methods:

  • Kernel density-based estimation (KDE)
  • Binning using histograms
  • k-nearest neighbor-based estimation (k-NN)

Installation

Although the code is still highly experimental and in very active development, a release version is available on PyPI and can be installed using pip.

pip install unite_toolbox

Or uv.

uv add unite_toolbox

Check the pyproject.toml for requirements.

How-to

In the documentation please find tutorials on the general usage of the toolbox and some applications.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unite_toolbox-0.2.1.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unite_toolbox-0.2.1-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file unite_toolbox-0.2.1.tar.gz.

File metadata

  • Download URL: unite_toolbox-0.2.1.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unite_toolbox-0.2.1.tar.gz
Algorithm Hash digest
SHA256 50639b4be958a952994fa10523b2d8734f50351c850a157348bb12cc9a6a02b1
MD5 2607498ab372641a6bcde8821231122a
BLAKE2b-256 7480965225608ba8dcc9f04e7522f97bea9462ecf3b38741e81a6459cc3547b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for unite_toolbox-0.2.1.tar.gz:

Publisher: publish-to-pypi.yml on manuel-alvarez-chaves/unite_toolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file unite_toolbox-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: unite_toolbox-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unite_toolbox-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ab22daaa4092562fe04f0d5f397794e59d5f4136cd30bcea04e1a8e49a9a7f9d
MD5 8dc8657d0b67f564cfdd7d1649a0e17b
BLAKE2b-256 6e0c860693f38f832df20ed8466eee26f59563b51161706005e3b31fdfda84e6

See more details on using hashes here.

Provenance

The following attestation bundles were made for unite_toolbox-0.2.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on manuel-alvarez-chaves/unite_toolbox

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page