Skip to main content

Build Status

Installation

For installing through pip:

pip install veroku

To clone this git repo:

git clone https://github.com/ejlouw/veroku.git 
cd veroku/
pip install -r requirements.txt

It is recommended to use a separate conda virtual environment when installing the dependencies, to avoid interfering with existing packages. To get started with conda environments, see the installation guide. For more information on using conda environments see managing environments guide

Overview

Veroku is an open source library for building and performing inference with probabilistic graphical models (PGMs) in python. PGMs provide a framework for performing efficient probabilistic inference with very high dimensional distributions. A typical example of a well-known type of PGM is the Kalman filter that can be used to obtain probabilistic estimates of a hidden state of a process or system, given noisy measurements. PGMs can in principle be used for any problem that involves uncertainty and is therefore applicable to many problems.

Veroku currently supports the following probability distributions:

  • Categorical (sparse and dense implementations)
  • Gaussian
  • Gaussian mixture1
  • Linear Gaussian2
  • Non-linear Gaussian3

1 This class still has some experimental functionality (specifically the Gaussian mixture division methods) and is, therefore, still in the factors.experimental sub-package.
2 Using the Gaussian class - see the Kalman filter example notebook.
3This implementation is still experimental (see the factors.experimental sub-package).

These distributions can be used as factors to represent a factorised distribution. These factors can be used, together with the cluster_graph module to automatically create valid cluster graphs. Inference can be performed in these graphs using message passing algorithms. Currently only the LBU (Loopy Belief Update) message-passing algorithm is supported.

Example notebooks:

On the Roadmap

The following distributions, models and features are on the roadmap to be added to veroku:

  • Conditional Gaussian
  • Dirichlet distribution
  • Wishart distribution
  • Normal-Wishart distribution
  • Plate models
  • Structure Learning
  • Causal Inference

Dependencies

For the python dependencies see the requirements file. The following additional dependencies are also required for some functionality (these are not installed automatically with the pip install):

Graphviz

See https://graphviz.org/download/ for installation instructions.

Contributing

If you would like to contribute to veroku, please see the contributing guide.

License

Veroku is released under a 3-Clause BSD license. You can view the license here.

Metadata

Release files for veroku 1.0.171

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for veroku 1.0.171
File Size Uploaded
veroku-1.0.171.tar.gz 166.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for veroku 1.0.171
File Interpreter ABI Platform
veroku-1.0.171-py3-none-any.whl Python 3 none any Details

Total release size: 263.0 kB

Release files / veroku-1.0.171.tar.gz

Download URL veroku-1.0.171.tar.gz
Size 166.5 kB
Tags Source
SHA-256 checksum
How to use checksums
8b5d4174709a6a523d081ad714db87eec2a92cdd11c6f02b7a4d21d9f55f487e
BLAKE2b-256 checksum
How to use checksums
8255ea160d2b13cc3179e6b3443d143b58bd4d815fc924229dfe7070c9849aea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.5

Release files / veroku-1.0.171-py3-none-any.whl

Download URL veroku-1.0.171-py3-none-any.whl
Size 96.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5216ef79d3310d616077faa5a4f340ee9b0d24e4ec86057981cde81bba77a398
BLAKE2b-256 checksum
How to use checksums
d13527db9bcc72ec998490d81079540ec3b416efe8230460138c63a223389d14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.8.5

Release history Release notifications | RSS feed

This release

1.0.171 This release

2 release files

0.1.85

2 release files

0.1.84

2 release files

0.1.83

2 release files

0.1.82

2 release files

0.1.81

2 release files

0.0.70

2 release files

0.0.69

2 release files

0.0.55

2 release files

0.0.54

2 release files

0.0.53

2 release files

0.0.52

2 release files

0.0.50

2 release files

0.0.49

2 release files

0.0.42

2 release files

0.0.29

2 release files

0.0.28

2 release files

0.0.27

2 release files

0.0.26

2 release files

0.0.25

2 release files

0.0.24

2 release files

0.0.23

2 release files

0.0.22

2 release files

0.0.21

2 release files

0.0.20

2 release files

0.0.19

2 release files

0.0.18

2 release files

0.0.9

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page