Python Symbolic Information Theoretic Inequality Prover
PSITIP is a computer algebra system for information theory written in Python. Random variables, expressions and regions are objects in Python that can be manipulated easily. Moreover, it implements a versatile deduction system for automated theorem proving. PSITIP supports features such as:
Proving linear information inequalities via the linear programming method by Yeung and Zhang. The linear programming method was first implemented in the ITIP software developed by Yeung and Yan ( http://user-www.ie.cuhk.edu.hk/~ITIP/ ).
Automated inner and outer bounds for multiuser settings in network information theory (see the Jupyter Notebook examples ).
Numerical optimization over distributions, and evaluation of rate regions involving auxiliary random variables.
Interactive mode and Parsing LaTeX code.
Finding examples of distributions where a set of constraints is satisfied.
Fourier-Motzkin elimination.
Discover inequalities via the convex hull method for polyhedron projection [Lassez-Lassez 1991].
Non-Shannon-type inequalities.
Integration with Jupyter Notebook and LaTeX output.
Generation of human-readable proofs.
Drawing information diagrams.
User-defined information quantities.
Documentation: https://github.com/cheuktingli/psitip
Jupyter Notebook examples: https://nbviewer.jupyter.org/github/cheuktingli/psitip/tree/master/examples/
About
Author: Cheuk Ting Li ( https://www.ie.cuhk.edu.hk/people/ctli.shtml ). The source code of PSITIP is released under the GNU General Public License v3.0 ( https://www.gnu.org/licenses/gpl-3.0.html ). The author would like to thank Raymond W. Yeung, Chandra Nair and Pascal O. Vontobel for their invaluable comments.
The working principle of PSITIP (existential information inequalities) is described in the following article:
C. T. Li, “An Automated Theorem Proving Framework for Information-Theoretic Results,” in IEEE Transactions on Information Theory, vol. 69, no. 11, pp. 6857-6877, Nov. 2023. Link: https://ieeexplore.ieee.org/document/10185937 , Preprint: https://arxiv.org/pdf/2101.12370.pdf
If you find PSITIP useful in your research, please consider citing the above article.
WARNING
This program comes with ABSOLUTELY NO WARRANTY. This program is a work in progress, and bugs are likely to exist. The deduction system is incomplete, meaning that it may fail to prove true statements (as expected in most automated deduction programs). On the other hand, declaring false statements to be true should be less common. If you encounter a false accept in PSITIP, please let the author know.
Installation
To install PSITIP with its dependencies, use one of the following three options:
A. Default installation
Run (you might need to use python -m pip or py -m pip instead of pip):
pip install psitip
If you encounter an error when building pycddlib on Linux, refer to https://pycddlib.readthedocs.io/en/latest/quickstart.html#installation .
This will install PSITIP with default dependencies. The default solver is ortools.GLOP. If you want to choose which dependencies to install, or if you encounter an error, use one of the following two options instead.
B. Installation with conda (recommended)
Install Python via Anaconda (https://www.anaconda.com/).
Open Anaconda prompt and run:
conda install -c conda-forge glpk conda install -c conda-forge pulp conda install -c conda-forge pyomo conda install -c conda-forge lark-parser conda install conda-forge::pylatexenc pip install ortools pip install pycddlib pip install --no-deps psitipIf you encounter an error when building pycddlib on Linux, refer to https://pycddlib.readthedocs.io/en/latest/quickstart.html#installation .
(Optional) Graphviz (https://graphviz.org/) is required for drawing Bayesian networks and communication network model. It can be installed via
conda install -c conda-forge python-graphviz(Optional) If numerical optimization is needed, also install PyTorch (https://pytorch.org/).
C. Installation with pip
Install Python (https://www.python.org/downloads/).
Run (you might need to use
python -m piporpy -m pipinstead ofpip):pip install numpy pip install scipy pip install matplotlib pip install ortools pip install pulp pip install pyomo pip install lark-parser pip install pycddlib pip install pylatexenc pip install --no-deps psitipIf you encounter an error when building pycddlib on Linux, refer to https://pycddlib.readthedocs.io/en/latest/quickstart.html#installation .
(Optional) The GLPK LP solver can be installed on https://www.gnu.org/software/glpk/ or via conda.
(Optional) Graphviz (https://graphviz.org/) is required for drawing Bayesian networks and communication network model. A Python binding can be installed via
pip install graphviz(Optional) If numerical optimization is needed, also install PyTorch (https://pytorch.org/).
References
The general method of using linear programming for solving information theoretic inequality is based on the following work:
R. W. Yeung, “A new outlook on Shannon’s information measures,” IEEE Trans. Inform. Theory, vol. 37, pp. 466-474, May 1991.
R. W. Yeung, “A framework for linear information inequalities,” IEEE Trans. Inform. Theory, vol. 43, pp. 1924-1934, Nov 1997.
Z. Zhang and R. W. Yeung, “On characterization of entropy function via information inequalities,” IEEE Trans. Inform. Theory, vol. 44, pp. 1440-1452, Jul 1998.
Convex hull method for polyhedron projection:
C. Lassez and J.-L. Lassez, Quantifier elimination for conjunctions of linear constraints via a convex hull algorithm, IBM Research Report, T.J. Watson Research Center, RC 16779 (1991)
1 maintainer
Metadata
1 maintainer
Release files for psitip 1.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| psitip-1.1.7.tar.gz | 259.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| psitip-1.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 523.3 kB
Release files / psitip-1.1.7.tar.gz
| Download URL | psitip-1.1.7.tar.gz |
|---|---|
| Size | 259.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9872f3c9eff76749885b392ed55f2823d3819f6b0a342220555ba200dff37003
|
|
BLAKE2b-256 checksum How to use checksums |
49244021b6a6cb7bc28db960d27f9003e5f56f1cc2a3c3dcaf720beea744de83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.3
|
Release files / psitip-1.1.7-py3-none-any.whl
| Download URL | psitip-1.1.7-py3-none-any.whl |
|---|---|
| Size | 263.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
132e31ab99d468c93148be21ba50869978d75c9ace1a13d35ae624940690c1e3
|
|
BLAKE2b-256 checksum How to use checksums |
5ee1d563a818edc2a637aa922cef67f28f727f98e85028f789c6e90d27f6b79b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.3
|
