GenSBI is a library for Simulation-Based Inference using generative models in JAX.
Project description
GenSBI: Generative Models for Simulation-Based Inference in JAX
[!IMPORTANT]
This library is at an early stage of development. The API is currently stable, but it is subject to change.
Overview
GenSBI is a powerful JAX-based library for Simulation-Based Inference (SBI) using state-of-the-art generative models, currently revolving around Optimal Transport Flow Matching and Diffusion Models.
It is designed for researchers and practitioners who need a flexible, high-performance toolkit to solve complex inference problems where the likelihood function is intractable.
Key Features
- Modern SBI Algorithms: Implements cutting-edge techniques like Optimal Transport Conditional Flow Matching and Diffusion Models for robust and flexible posterior inference.
- Built on JAX and Flax NNX: Leverages the power of JAX for automatic differentiation, vectorization, and seamless execution on CPUs, GPUs, and TPUs.
- High-Level Recipes API: A simplified interface for common workflows, allowing you to train models and run inference with just a few lines of code.
- Powerful Transformer Models: Includes implementations of recent, high-performing models like Flux1, Flux1Join, and Simformer for handling complex, high-dimensional data.
- Modular and Extensible: A clean, well-structured codebase that is easy to understand, modify, and extend for your own research.
Installation
Using uv (recommended):
uv add gensbi
# or, for a standalone install:
uv pip install gensbi
For GPU support:
uv add gensbi[cuda12]
# or
uv pip install gensbi[cuda12]
Or using pip:
pip install gensbi
For GPU support and other options, including how to install uv, see the Installation Guide.
Quick Start
To get started immediately, you can use the high-level API to train a model.
[!TIP] Check out the my_first_model.ipynb notebook for a complete, step-by-step introductory tutorial.
from flax import nnx
from gensbi.recipes import Flux1FlowPipeline
from gensbi.models import Flux1Params
train_dataset = ... # define a training dataset (infinite iterator)
val_dataset = ... # define a validation dataset (infinite iterator)
dim_obs = ... # dimension of the parameters (theta)
dim_cond = ... # dimension of the simulator observations (x)
params = Flux1Params(...) # the parameters for your model
# Instantiate the pipeline
pipeline = Flux1FlowPipeline(
train_dataset,
val_dataset,
dim_obs,
dim_cond,
params=params,
)
# Train the model
# Note: GenSBI uses Flax NNX, so we pass a random key generator
pipeline.train(rngs=nnx.Rngs(0))
# After training, get a sampler for posterior sampling
key = jax.random.PRNGKey(42)
samples = pipeline.sample(key, x_observed, num_samples=10_000)
Examples
Examples for this library are available separately in the GenSBI-examples repository.
Some key examples include:
Getting Started:
my_first_model.ipynb
A beginner-friendly notebook introducing the core concepts of GenSBI on a simple problem.
Unconditional Density Estimation:
flow_matching_2d_unconditional.ipynb
Demonstrates how to use flow matching in 2D for unconditional density estimation.diffusion_2d_unconditional.ipynb
Demonstrates how to use diffusion models in 2D for unconditional density estimation.
Conditional Density Estimation:
two_moons_flow_flux.ipynb
Uses the Flux1 model for posterior density estimation on the two-moons benchmark.two_moons_diffusion_flux.ipynb
Uses the Diffusion model for posterior density estimation on the two-moons benchmark.
[!NOTE] A complete list of the currently available examples can be found at the examples documentation page.
Citing GenSBI
If you use this library, please consider citing this work and the original methodology papers, see references.
@misc{GenSBI,
author = {Amerio, Aurelio},
title = "{GenSBI: Generative Models for Simulation-Based Inference in JAX}",
year = {2026},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/aurelio-amerio/GenSBI}}
}
Reference implementations
- Facebook Flow Matching library: https://github.com/facebookresearch/flow_matching
- Elucidating the Design Space of Diffusion-Based Generative Models: https://github.com/NVlabs/edm
- Simformer model: https://github.com/mackelab/simformer
- Flux1 model from BlackForest Lab: https://github.com/black-forest-labs/flux
- Simulation-Based Inference Benchmark: https://github.com/sbi-benchmark/sbibm
[!NOTE] AI Usage Disclosure
This project utilized large language models, specifically Google Gemini and GitHub Copilot, to assist with code suggestions, documentation drafting, and grammar corrections. All AI-generated content has been manually reviewed and verified by human authors to ensure accuracy and adherence to scientific standards.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gensbi-0.3.1.tar.gz.
File metadata
- Download URL: gensbi-0.3.1.tar.gz
- Upload date:
- Size: 122.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17f4333dcd933e09297c7ea1ffa3eaf01253df1efff95e1cf6c529252639867d
|
|
| MD5 |
747f152c5ececc888f80fc62278b9f70
|
|
| BLAKE2b-256 |
9b236769ec436a56aed395667116846ebe689dce9fe2c28c4080bd690cc301aa
|
File details
Details for the file gensbi-0.3.1-py3-none-any.whl.
File metadata
- Download URL: gensbi-0.3.1-py3-none-any.whl
- Upload date:
- Size: 172.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a08354d15a618615ee934b329350978d6d8ebc7a58241b541ecd05ec13d3566
|
|
| MD5 |
0e494b0d42fc3b894aa3d30fa54a571b
|
|
| BLAKE2b-256 |
eb624e1bc03f0997f4ca45bec1e5a07619e53861b9068338c124207d491659a9
|