Skip to main content

Computational Uncertainty Quantification for Inverse problems in Python

Project description

CUQIpy logo

Computational Uncertainty Quantification for Inverse Problems in python

pytest docs

Computational Uncertainty Quantification for Inverse Problems in python (CUQIpy) is a python package for modeling and solving inverse problems in a Bayesian inference framework. CUQIpy provides a simple high-level interface to perform UQ analysis of inverse problems, while still allowing full control of the models and methods. The package comes equipped with a number of predefined distributions, samplers, models and test problems and is built to be easily further extended when needed.

You can find the full CUQIpy documentation here.

This software package is part of the CUQI project funded by the Villum Foundation.

Quickstart

Install CUQIpy using pip:

pip install cuqipy

For more detailed instructions, see the Getting Started guide.

Quick Example - UQ in 5 steps

Image deconvolution with uncertainty quantification

# Imports
import numpy as np
import matplotlib.pyplot as plt
from cuqi.testproblem import Deconvolution2D
from cuqi.data import grains
from cuqi.distribution import LMRF, Gaussian
from cuqi.problem import BayesianProblem

# Step 1: Model and data, y = Ax
A, y_data, info = Deconvolution2D.get_components(dim=128, phantom=grains())

# Step 2: Prior, x ~ LMRF(0,0.01)
x = LMRF(location=0,
         scale=0.01,
         bc_type='neumann',
         geometry = A.domain_geometry)

# Step 3: Likelihood, y ~ N(Ax, 0.0036^2)
y = Gaussian(mean=A@x, cov=0.0036**2)

# Step 4: Set up Bayesian problem and sample posterior
BP = BayesianProblem(y, x).set_data(y=y_data)
samples = BP.sample_posterior(200)

# Step 5: Analysis
info.exactSolution.plot(); plt.title("Exact solution")
y_data.plot(); plt.title("Data")
samples.plot_mean(); plt.title("Posterior mean")
samples.plot_std(); plt.title("Posterior standard deviation")

Exact solution Data Posterior mean Posterior standard deviation

Plugins

CUQIpy can be extended with additional functionality by installing optional plugins. These can be found at CUQI-DTU.

Contributing

We welcome contributions to CUQIpy. Please see our contributing guidelines for more information.

Contributors

See the list of contributors who participated in this project.

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

CUQIpy-0.4.0.post0.dev115.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

CUQIpy-0.4.0.post0.dev115-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file CUQIpy-0.4.0.post0.dev115.tar.gz.

File metadata

  • Download URL: CUQIpy-0.4.0.post0.dev115.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for CUQIpy-0.4.0.post0.dev115.tar.gz
Algorithm Hash digest
SHA256 92d60a5af310f691204b65a1cd9f1f74493a8e46bff0d8f284e970645716f194
MD5 090c6f05bb399151ed6df80d2030c673
BLAKE2b-256 a2076b9a4b89d188df6d9585447d56ffd20787863b79be310ee41e3454923461

See more details on using hashes here.

File details

Details for the file CUQIpy-0.4.0.post0.dev115-py3-none-any.whl.

File metadata

File hashes

Hashes for CUQIpy-0.4.0.post0.dev115-py3-none-any.whl
Algorithm Hash digest
SHA256 c02af216d116a7151b71e083c72f8d0f5ca7f70299445dcbd556aedc6c4fc26d
MD5 942c59acfd570e583b0bdf184f3b9a7d
BLAKE2b-256 42b4be20542a7ec8f97df901a43b495e9d402ede1f2187a254c6a963acb3e908

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