CUQIpy 1.3.0.post0.dev371__tar.gz → 1.3.0.post0.dev383__tar.gz

{cuqipy-1.3.0.post0.dev371 → cuqipy-1.3.0.post0.dev383}/CUQIpy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CUQIpy
-Version: 1.3.0.post0.dev371
+Version: 1.3.0.post0.dev383
 Summary: Computational Uncertainty Quantification for Inverse problems in Python
 Maintainer-email: "Nicolai A. B. Riis" <nabr@dtu.dk>, "Jakob S. Jørgensen" <jakj@dtu.dk>, "Amal M. Alghamdi" <amaal@dtu.dk>, Chao Zhang <chaz@dtu.dk>
 License:                                  Apache License

{cuqipy-1.3.0.post0.dev371 → cuqipy-1.3.0.post0.dev383}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CUQIpy
-Version: 1.3.0.post0.dev371
+Version: 1.3.0.post0.dev383
 Summary: Computational Uncertainty Quantification for Inverse problems in Python
 Maintainer-email: "Nicolai A. B. Riis" <nabr@dtu.dk>, "Jakob S. Jørgensen" <jakj@dtu.dk>, "Amal M. Alghamdi" <amaal@dtu.dk>, Chao Zhang <chaz@dtu.dk>
 License:                                  Apache License

{cuqipy-1.3.0.post0.dev371 → cuqipy-1.3.0.post0.dev383}/cuqi/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-09-12T10:46:36+0200",
+ "date": "2025-09-12T11:00:39+0200",
  "dirty": false,
  "error": null,
- "full-revisionid": "1bd165981a9e7200ec642e2845ffde05a7e8a168",
- "version": "1.3.0.post0.dev371"
+ "full-revisionid": "37e1d4431766233eccce97c09eb773486ed25032",
+ "version": "1.3.0.post0.dev383"
 }
 '''  # END VERSION_JSON
 

{cuqipy-1.3.0.post0.dev371 → cuqipy-1.3.0.post0.dev383}/cuqi/implicitprior/__init__.py

@@ -1,5 +1,5 @@
 from ._regularizedGaussian import RegularizedGaussian, ConstrainedGaussian, NonnegativeGaussian
 from ._regularizedGMRF import RegularizedGMRF, ConstrainedGMRF, NonnegativeGMRF
 from ._regularizedUnboundedUniform import RegularizedUnboundedUniform
-from ._restorator import RestorationPrior, MoreauYoshidaPrior
+from ._restorator import RestorationPrior, MoreauYoshidaPrior, TweediePrior
 

{cuqipy-1.3.0.post0.dev371 → cuqipy-1.3.0.post0.dev383}/cuqi/implicitprior/_restorator.py

@@ -232,4 +232,38 @@ class MoreauYoshidaPrior(Distribution):
         """ Returns the conditioning variables of the distribution. """
         # Currently conditioning variables are not supported for user-defined
         # distributions.
-        return []
+        return []
+
+class TweediePrior(MoreauYoshidaPrior):
+    """
+    Alias for MoreauYoshidaPrior following Tweedie's formula framework. TweediePrior 
+    defines priors where gradients are computed based on Tweedie's identity that links 
+    MMSE (Minimum Mean Square Error) denoisers with the underlying smoothed prior, see:
+        - Laumont et al. https://arxiv.org/abs/2103.04715 or https://doi.org/10.1137/21M1406349
+
+    Tweedie's Formula
+    -------------------------
+    In the context of denoising, Tweedie's identity states that for a signal x
+    corrupted by Gaussian noise:
+
+        ∇_x log p_e(x) = (D_e(x) - x) / e
+
+    where D_e(x) is the MMSE denoiser output and e is the noise variance.
+    This enables us to perform gradient-based sampling with algorithms like ULA.
+
+    At implementation level, TweediePrior shares identical functionality with MoreauYoshidaPrior. 
+    Thus, it is implemented as an alias of MoreauYoshidaPrior, meaning all methods, 
+    properties, and behavior are identical. The separate name provides clarity when 
+    working specifically with Tweedie's formula-based approaches.
+
+    Parameters
+    ----------
+    prior : RestorationPrior
+        Prior of the RestorationPrior type containing a denoiser/restorator.
+        
+    smoothing_strength : float, default=0.1
+        Corresponds to the noise variance e in Tweedie's formula context.
+
+    See MoreauYoshidaPrior for the underlying implementation with complete documentation.
+    """
+    pass