approximating mutual information in high dimensions
Project description
latentmi
Latent MI (LMI) approximation is a method for estimating mutual information high dimensions. It is built on the idea that real world high-dimensional data has underlying low-dimensional structure. For more details, see our manuscript. latentmi is our Python implementation of LMI approximation, built with the hope that practicioners can use it with minimal pain and suffering :)
Installation
$ pip install latentmi
Usage
from latentmi import lmi
Xs = # some samples of a high dimensional variable
Ys = # some samples of a high dimensional variable
pmis, embedding, model = lmi.lmi(Xs, Ys)
MI_estimate = np.nanmean(pmis) # voila !
More detailed instructions can be found in the example usage notebook.
License
latentmi was created by Gokul Gowri. It is licensed under the terms of the MIT license.
Credits
latentmi was created with cookiecutter and the py-pkgs-cookiecutter template.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file latentmi-0.1.3.tar.gz.
File metadata
- Download URL: latentmi-0.1.3.tar.gz
- Upload date:
- Size: 8.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8b8e3ca266d9cb08afc760229234a84c3d247f00729cbfa2793af40f0f88d732 |
|
| MD5 | 35e10e46b0bc2ba63c4819108224410d |
|
| BLAKE2b-256 | 614c8de81c4e66f1eae10de649380f62ec1ba79cfe7298cdfbcaeb702c80cf95 |
File details
Details for the file latentmi-0.1.3-py3-none-any.whl.
File metadata
- Download URL: latentmi-0.1.3-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c860fb375bcfd681b1833d399bf5ca6cfeb22bbc5034e64087c7647266352533 |
|
| MD5 | b6a985d0224cb06fe3203e64e0665042 |
|
| BLAKE2b-256 | e0aefb518b17b6e6df920ea14e77ccfa1e6aadc99e710a485af0f15f54464071 |
