Skip to main content

A light-weight library for large-scale Markov Chain Monte Carlo sampling

Project description

CI Docs License Ruff

Large Scale MCMC Library

A lightweight, modular library developed for large-scale Markov Chain Monte Carlo. In particular, it implements algorithms that are infinite-dimensionally consistent to ensure discretization independent acceptance probabilities. The library is lightweight in the sense, that it tries to keep the overhead for the user as small as possible and relies heavily on modularization, so extensions can be easily implemented. It focuses on large-scale problems by supporting disk-based storage and reusing computed results as much as possible. It is most likely not the fastest MCMC library out there, but it is quick to use and supports most features that are essential for MCMC on function spaces.

Key Features

  • pCN and MALA support
  • On-Disk sample storage
  • Graceful exit on errors

Markov-Chain-Monte-Carlo Methods aim to sample from an unknown probability measure $\mu$ that is known up to a normalization constant. We assume the density is known w.r.t. a reference Gaussian measure $\mu_0 = N(0, C)$, i.e.

$$ \frac{d\mu}{d\mu_0} \propto L(u) = \exp(-\Phi(u)). $$

In this case the user only needs to supply the covariance operator of the reference measure $C$ and the potential function $\Phi$.

Installation and Development

Releases of this version can be downloaded from pip directly:

pip install ls-mcmc

This library relies on uv for packaging. To install a development environment, clone the Github repository and run

uv sync --all-groups

in the projects root folder.

Documentation

Usage

The usage section describes a basic setup for sampling from a distribution, configuring logging output, disk-storage and restarting of chains.

API Reference

The API reference contains documentation for all parts of the library.

Examples

Other examples can be found here.

Acknowledgement and License

This package is developed by the Uncertainty Quantification Research Group at KIT. It is distributed under the MIT License.

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

ls_mcmc-0.0.3.tar.gz (489.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ls_mcmc-0.0.3-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file ls_mcmc-0.0.3.tar.gz.

File metadata

  • Download URL: ls_mcmc-0.0.3.tar.gz
  • Upload date:
  • Size: 489.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.8

File hashes

Hashes for ls_mcmc-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d7d0772b6e6c7737487eda2fd52ad29dd61428b99511121302cfa4408bf25ae7
MD5 b59491dabf40914b9c5e76b6a30376b5
BLAKE2b-256 af135f1792b9e9766d66b17741c81edb899d45aaf45631b72164e24830df3aa0

See more details on using hashes here.

File details

Details for the file ls_mcmc-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: ls_mcmc-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.8

File hashes

Hashes for ls_mcmc-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1f9a362655bbd0a0fc1abb7ff7d0ca93853849ba31f11a04057c6336dbfdba2e
MD5 67b0de60a5805def7442e1c0a5c04694
BLAKE2b-256 7dde88bdb67de3bba7df4cf8ffe36b6574d9b9ed82abbe97b690af0bc6c4a0de

See more details on using hashes here.

Supported by

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