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 Laplace_diff, 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 ~ Laplace_diff(0, 0.01)
x = Laplace_diff(location=np.zeros(A.domain_dim),
                 scale=0.01,
                 bc_type='neumann',
                 physical_dim=2)

# 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.2.0.post0.dev123.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.2.0.post0.dev123-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file CUQIpy-0.2.0.post0.dev123.tar.gz.

File metadata

  • Download URL: CUQIpy-0.2.0.post0.dev123.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for CUQIpy-0.2.0.post0.dev123.tar.gz
Algorithm Hash digest
SHA256 caf8c776fc123939ab82648396e36666fcb13819d783dfb5bde31ada7c9bed00
MD5 6d1884b1eaf765635b53f537834b68c0
BLAKE2b-256 f41dbd51d24a8bb703b23c42006c31b9dee85496758775a9622bf899b88115c9

See more details on using hashes here.

File details

Details for the file CUQIpy-0.2.0.post0.dev123-py3-none-any.whl.

File metadata

File hashes

Hashes for CUQIpy-0.2.0.post0.dev123-py3-none-any.whl
Algorithm Hash digest
SHA256 b9c3849417d77cbb99b624c65f860666462250fe7e37c89473de8170e311abad
MD5 ea16b53538d9a07dc86ec95a8cac95b6
BLAKE2b-256 e7dda49bef173331cecdf34f9db6701618f0d7e5413c5ce68a84d2f87cd0c735

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