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.dev133.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.dev133-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: CUQIpy-0.4.0.post0.dev133.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.dev133.tar.gz
Algorithm Hash digest
SHA256 b5ce27035eb34034962e7461061d1fdcb13fbfc6172503d9ef84e1e50a58b6ae
MD5 14bf45a8b4d233851069a6825bb6238f
BLAKE2b-256 929739472a246d7e4fbe4a4ad505e186c548cc772c1b1bedb300373fe5169f59

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for CUQIpy-0.4.0.post0.dev133-py3-none-any.whl
Algorithm Hash digest
SHA256 a23c8d1ddcd7e918d5d91b12710aae2f6d8cb4bebbae73d0ccda262bac6268f6
MD5 41ef8dec31a42817f5b9147e8a7f4ae2
BLAKE2b-256 fb74d54ea46c89c94d853caef0bc566e73bcb40dd43b2ec0caa32b2781760cba

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