flowMC
A JAX-based normalizing-flow-enhanced MCMC sampler for probabilistic inference
flowMC is a JAX-based package for normalizing-flow-enhanced Markov chain Monte Carlo (MCMC) sampling. By using normalizing flows as a global proposal, flowMC accelerates convergence for multi-modal and high-dimensional posteriors while running natively on GPU with minimal hyperparameter tuning.
For a quick introduction, see the Quick Start guide.
Installation
The simplest way to install flowMC is through pip:
pip install flowMC
This will install the latest stable release and its dependencies. flowMC is built on JAX. By default, this installs the CPU version of JAX. If you have an NVIDIA GPU, install the CUDA-enabled version:
pip install flowMC[cuda]
If you want to install the latest version of flowMC, you can clone this repo and install it locally:
git clone https://github.com/GW-JAX-Team/flowMC.git
cd flowMC
pip install -e .
We recommend using uv to manage your Python environment.
After cloning the repository, run uv sync to create a virtual environment with all dependencies installed.
Origins
flowMC was originally developed as kazewong/flowMC by Kaze W. K. Wong and others. The original repository is no longer actively maintained; this fork is the active continuation of the project.
Attribution
If you use flowMC in your research, please cite the following papers:
@article{Wong:2022xvh,
author = "Wong, Kaze W. K. and Gabri\'e, Marylou and Foreman-Mackey, Daniel",
title = "{flowMC: Normalizing flow enhanced sampling package for probabilistic inference in JAX}",
eprint = "2211.06397",
archivePrefix = "arXiv",
primaryClass = "astro-ph.IM",
doi = "10.21105/joss.05021",
journal = "J. Open Source Softw.",
volume = "8",
number = "83",
pages = "5021",
year = "2023"
}
@article{Gabrie:2021tlu,
author = "Gabri\'e, Marylou and Rotskoff, Grant M. and Vanden-Eijnden, Eric",
title = "{Adaptive Monte Carlo augmented with normalizing flows}",
eprint = "2105.12603",
archivePrefix = "arXiv",
primaryClass = "physics.data-an",
doi = "10.1073/pnas.2109420119",
journal = "Proc. Nat. Acad. Sci.",
volume = "119",
number = "10",
pages = "e2109420119",
year = "2022"
}
2 maintainers
Metadata
2 maintainers
Release files for flowMC 0.6.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| flowmc-0.6.4.tar.gz | 2.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| flowmc-0.6.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 3.0 MB
Release files / flowmc-0.6.4.tar.gz
| Download URL | flowmc-0.6.4.tar.gz |
|---|---|
| Size | 2.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
488f9e116d123e1519d4a681dc468403b62107b88f8d1123a9c1b785ef54685d
|
|
BLAKE2b-256 checksum How to use checksums |
359f002099fcd78017dd5e62fe1602ca63a9503f4c1268646d75f354d03e62c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / flowmc-0.6.4-py3-none-any.whl
| Download URL | flowmc-0.6.4-py3-none-any.whl |
|---|---|
| Size | 94.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bbabb7bafa377bcbe4189b27fa203aea2bbb06c0d9e8bf94d7b116abf0fbe1eb
|
|
BLAKE2b-256 checksum How to use checksums |
062b5ef39dad2e1d7a8ce5081b6a610a9b09113f8e8f789bfe20a28dacb450e8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
