dit is a Python package for information theory on discrete random variables.
Project description
dit is a Python package for information theory.
- Documentation:
- Downloads:
Coming soon.
- Dependencies:
Python 2.7, 3.3, 3.4, 3.5, or 3.6
numpy
iterutils
six
contextlib2
prettytable
networkx
- Optional Dependencies:
cython
cvxopt
numdifftools
scipy
- Note:
The cython extensions are currently not supported on windows. Please install using the --nocython option.
- Install:
Until dit is available on PyPI, the easiest way to install is:
pip install git+https://github.com/dit/dit/#egg=dit
Alternatively, you can clone this repository, move into the newly created dit directory, and then install the package. Be sure to include the period (.) in the install command:
git clone https://github.com/dit/dit.git cd dit pip install .
- Mailing list:
None
- Code and bug tracker:
- License:
BSD 2-Clause, see LICENSE.txt for details.
Quickstart
The basic usage of dit corresponds to creating distributions, modifying them if need be, and then computing properties of those distributions. First, we import:
>>> import dit
Suppose we have a really thick coin, one so thick that there is a reasonable chance of it landing on its edge. Here is how we might represent the coin in dit.
>>> d = dit.Distribution(['H', 'T', 'E'], [.4, .4, .2])
>>> print d
Class: Distribution
Alphabet: ('E', 'H', 'T') for all rvs
Base: linear
Outcome Class: str
Outcome Length: 1
RV Names: None
x p(x)
E 0.2
H 0.4
T 0.4
Calculate the probability of H and also of the combination H or T.
>>> d['H']
0.4
>>> d.event_probability(['H','T'])
0.8
Calculate the Shannon entropy and extropy of the joint distribution.
>>> dit.shannon.entropy(d)
1.5219280948873621
>>> dit.other.extropy(d)
1.1419011889093373
Create a distribution where Z = xor(X, Y).
>>> import dit.example_dists
>>> d = dit.example_dists.Xor()
>>> d.set_rv_names(['X', 'Y', 'Z'])
>>> print d
Class: Distribution
Alphabet: ('0', '1') for all rvs
Base: linear
Outcome Class: str
Outcome Length: 3
RV Names: ('X', 'Y', 'Z')
x p(x)
000 0.25
011 0.25
101 0.25
110 0.25
Calculate the Shannon mutual informations I[X:Z], I[Y:Z], and I[X,Y:Z].
>>> dit.shannon.mutual_information(d, ['X'], ['Z'])
0.0
>>> dit.shannon.mutual_information(d, ['Y'], ['Z'])
0.0
>>> dit.shannon.mutual_information(d, ['X', 'Y'], ['Z'])
1.0
Calculate the marginal distribution P(X,Z). Then print its probabilities as fractions, showing the mask.
>>> d2 = d.marginal(['X', 'Z'])
>>> print d2.to_string(show_mask=True, exact=True)
Class: Distribution
Alphabet: ('0', '1') for all rvs
Base: linear
Outcome Class: str
Outcome Length: 2 (mask: 3)
RV Names: ('X', 'Z')
x p(x)
0*0 1/4
0*1 1/4
1*0 1/4
1*1 1/4
Convert the distribution probabilities to log (base 3.5) probabilities, and access its probability mass function.
>>> d2.set_base(3.5)
>>> d2.pmf
array([-1.10658951, -1.10658951, -1.10658951, -1.10658951])
Draw 5 random samples from this distribution.
>>> dit.math.prng.seed(1)
>>> d2.rand(5)
['01', '10', '00', '01', '00']
Enjoy!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for dit-1.0.0.dev2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d8cbbeb0cc7f34bb3d51c6fd0cae29d67124ca2885b53b626eb6949b2cbf79b |
|
MD5 | 6252326ca1d15747dbebc2701cc5bb3a |
|
BLAKE2b-256 | 2c70e09a7a64ff6909130f27249544d06be2ed6be1c8dd6ccd275ec84054350a |
Hashes for dit-1.0.0.dev2-cp36-cp36m-macosx_10_11_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d719da82a9a149f2088c48c4717c391b4c4314d683e7cd57976648b4b930ef3a |
|
MD5 | d62f595943fe85df98bfd7c72f200032 |
|
BLAKE2b-256 | 78b6c877491dd62dd1c6073bb4418d59ddb7d81623f8de1d00287ea3c2f9a97d |
Hashes for dit-1.0.0.dev2-cp27-cp27m-macosx_10_11_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb49655f616b3b04c6d58c0fc4efeecae0c06c40d9af743048be6425dbb67a2e |
|
MD5 | 7d61896f916956184598f0e3d0375d9b |
|
BLAKE2b-256 | d6e5c23651f2bf8287eaca2150b7d472a944015c265a4d54a35d1475549d36b2 |