Python package for information theory.
Project description
dit is a Python package for information theory.
- Documentation:
- Downloads:
- Dependencies:
Python 2.7, 3.3, 3.4, 3.5, or 3.6
boltons
contextlib2
debtcollector
networkx
numpy
prettytable
scipy
six
- Optional Dependencies:
colorama
cython
numdifftools
- Note:
The cython extensions are currently not supported on windows. Please install using the --nocython option.
- Install:
The easiest way to install is:
pip install dit
Alternatively, you can clone this repository, move into the newly created dit directory, and then install the package:
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 Distribution
Built Distributions
Hashes for dit-1.0.0.dev25-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d1ee4dc136949825567d8df61b7597c39ed2846cdfe1ac4f6982b6d76ba6716 |
|
MD5 | cde888131ac7b33aabdf0378e4e112b1 |
|
BLAKE2b-256 | 6757758f340af33f979c9616a5253b03ae42596669463c7385c744764cfd9c74 |
Hashes for dit-1.0.0.dev25-cp36-cp36m-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00cb0915a6c611ee3ff8b03ad02b5878c99c42e9933482cea661f5d91b5c7576 |
|
MD5 | 5305e48d520874d2e49a5c2b952f60b3 |
|
BLAKE2b-256 | b54803bc1cd155e543e278ca55b9ea55b722dbe99df57d58833fda3d940c82b1 |
Hashes for dit-1.0.0.dev25-cp27-cp27m-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86ee4af9b4fd272366d5f28fdf8d4153034472a54c9ad88747b4dba2213003c5 |
|
MD5 | 1792891b6fd9238b1b57a9a5060b282c |
|
BLAKE2b-256 | 608432fea379481395270b7ca55404f21b2b5d3068358cb35145b74e1a765b26 |