COMPASS: A Python package for bayesian model comparison in a simulation based setting
Project description
COMPASS: Comparison Of Models using Probabilistic Assessment in Simulation-based Settings
COMPASS is a Python package designed for Bayesian Model Comparison in simulation-based settings. By comparing the predictive power of various models, it aims to identify the most suitable model for a given dataset.
It is especially suited for fields like astrophysics and computational biology, where simulation is integral to the modeling process.
Features
- Perform Bayesian model comparison in simulation-based settings with
ModelTransfuser - Perform Simulation-Based Inference with
ScoreBasedInferenceModel
Installation
Install the package using pip:
pip install bayes-compass
Usage
Model Comparison Example
The ModelTransfuser class provides a framework for the model comparison workflow.
It uses the ScoreBasedInferenceModel class to perform the simulation-based inference, predicts the posterior distribution and samples from the Likelihood function with the inferred parameters.
With a Gaussian Kernel Density Estimator, it evaluates the observed data at the Likelihood function and computes the posterior model probabilities.
from compass import ModelTransfuser
# Initialize the ModelTransfuser
mtf = ModelTransfuser()
# Add data from simulators
mtf.add_data(model_name="Model1", train_data=data_1, val_data=val_data_1)
mtf.add_data(model_name="Model2", train_data=data_2, val_data=val_data_2)
# Initialize ScoreBasedInferenceModels
mtf.init_models()
# Train the models
mtf.train_models()
# Compare Posterior Model Probabilities
observations = load_your_observations
mtf.compare(x=observations, err=observations_err)
stats = mtf.stats
# Plot results
mtf.plot_comparison()
mtf.plot_attention()
mtf.stats is a dictionary containing all inferred parameters and their uncertainties, the posterior model probabilities, and the log-likelihood values for each model.
Simulation-Based Inference Model
The ScoreBasedInferenceModel is a Diffusion Model with a score predicting Transformer network.
It is able to sample from the posterior and likelihood function by utalizing the attention mechanism of the Transformer architecture.
The model is also able to handle observational uncertainties and is designed to run on all available GPUs.
from compass import ScoreBasedInferenceModel as SBIm
sbimodel = SBIm(nodes_size=nodes_size, sigma=sigma, depth=depth, hidden_size=hidden_size, num_heads=num_heads, mlp_ratio=mlp_ratio)
sbimodel.train(train_data, val_data=val_data, path=path, device="cuda")
nodes_size - The number of parameters $\theta$ and the number of data points $x$.
sigma - The noise level of the initial noise distribution of the diffusion model.
depth - The number of layers in the Transformer
hidden_size - The size of the embedding in the Transformer
num_heads - The number of attention heads in the Transformer
mlp_ratio - The ratio of the hidden size to the number of Nodes in the MLPs in the Transformer
To sample from the posterior distribution, you can use the sample() function and provide the observations x and the observational uncertainties err (optional):
# Sample from the posterior distribution
posterior_samples = sbimodel.sample(x=observations, err=observations_err, timesteps=100)
To sample from the Likelihood function, you can again use the sample() function and provide the Maximum-A-Posteriori $\hat\theta$ values in theta and the standard deviation err (optional):
# Samlpe from the likelihood function
likelihood_samples = sbimodel.sample_likelihood(theta=theta_hat, err=std_theta_hat, timesteps=100)
Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve this package.
Project details
Release history Release notifications | RSS feed
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 bayes_compass-1.0.2.tar.gz.
File metadata
- Download URL: bayes_compass-1.0.2.tar.gz
- Upload date:
- Size: 12.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de3c5a5ad59b9b573bb106dc50fbdc64e772a0d5bb9cffef2e44b273f0b7ccf3
|
|
| MD5 |
76c2819bf9709eb60b4619d1529fdd25
|
|
| BLAKE2b-256 |
4375eba093f0bde8e51ec64681f8c91a563554943c713a65464ebcc7c652402c
|
File details
Details for the file bayes_compass-1.0.2-py3-none-any.whl.
File metadata
- Download URL: bayes_compass-1.0.2-py3-none-any.whl
- Upload date:
- Size: 42.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e3bed42ef88124bd54ca1ec95ee41498dc4c6d4481468380e8964f4f1aa2cfee
|
|
| MD5 |
10ec7f964b4557df779492fa6c688c5c
|
|
| BLAKE2b-256 |
9c319b67cbba387694d37ca6dee7ff1088b685257363c4c4da2748cc4cc636ea
|