Skip to main content

Fast evaluation of multivariate normal distribution

Project description

Fast evaluation of multivariate normal distributions

This package provides a fast way to evaluate the pdf and cdf of a standardized multivariate normal distribution. Currently, it only contains code for the bivariate normal distribution.

The implementation in this package is based on the following references:

  1. Drezner, Zvi, and George O. Wesolowsky. "On the computation of the bivariate normal integral." Journal of Statistical Computation and Simulation 35.1-2 (1990): 101-107.
  2. Genz, Alan, and Frank Bretz. "Computation of multivariate normal and t probabilities." Lecture Notes in Statistics 195 (2009)

Simply put, the method comes down to an interpolation specifically tailored to the multivariate normal distribution. Although it is an approximation, the method is near to exact and fast. The implementation in Scipy is based on the same methodology, see here and [here](https://github.com/scipy/scipy/blob/v1.13.0/scipy/stats/_qmvnt.py.

With scalar input, the speed is comparable to the Scipy implementation. The Scipy implemantation, however, is slow for vector valued input. This packages containes a vectorized implementation which is signficantly faster albeit still slower than a native C implementation such as the one in the approxcdf package. The advantage of this package is that it is pure Python and does not require any (build) dependencies.

Rough findings for speed improvements compared to the Scipy implementation.

Module Correlation Speed improvement single Speed improvement vectorized
fastnorm abs < 0.925 >1000 x faster than Scipy 10 x faster than Scipy
approxcdf abs < 0.925 >1000 x faster than Scipy 10 x faster than Scipy
fastnorm abs > 0.925 >1000 x faster than Scipy 3 x faster than Scipy
approxcdf abs > 0.925 >1000 x faster than Scipy 10 x faster than Scipy

These finds are based on an average of 100 runs and can be reproduced by running the example.py script.

Basic example

import fastnorm as fn
correl = 0.5

x=[1,1]
fn.bivar_norm_pdf(x, correl)
fn.bivar_norm_cdf(x, correl)

x=[[1,1],[2,2]]
fn.bivar_norm_pdf(x, correl)
fn.bivar_norm_cdf(x, correl)

Installation

To install from PyPI:

pip install fastnorm

To install the latest development version from github:

pip install git+https://github.com/mvds314/fastnorm.git

Development

For development purposes, clone the repo:

git clone https://github.com/mvds314/fastnorm.git

Then navigate to the folder containing setup.py and run

pip install -e .

to install the package in edit mode.

Run unittests with pytest.

Roadmap

  • Add support for the trivariate and quadrivariate normal distribution.
  • Add support for the higher dimensional normal distribution.
  • Maybe extend to the multivariate t-distribution.

Related software

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastnorm-24.4.2.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

fastnorm-24.4.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file fastnorm-24.4.2.tar.gz.

File metadata

  • Download URL: fastnorm-24.4.2.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for fastnorm-24.4.2.tar.gz
Algorithm Hash digest
SHA256 187c62a5e3a75ab902304046d1331e7a79e477223b18a88e78f27e2a69027673
MD5 ff432d2336aabdd9144c97f550c1acda
BLAKE2b-256 6b15daaa5c954e594b4f85274834ccbd9a27cd64a1388df39f186a6e28a42d51

See more details on using hashes here.

File details

Details for the file fastnorm-24.4.2-py3-none-any.whl.

File metadata

  • Download URL: fastnorm-24.4.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for fastnorm-24.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7214067a15cf1ec939f2af1739cee2d4d8174f9af4634101e9e8f299b9816e4e
MD5 895f60f154039dbe1bcb2dde336c5f41
BLAKE2b-256 b18378fcd76ab95aa0bc446034394dfb33d89aa7fefa2d497486fc6fbd6c05ce

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page