CUQIpy 1.2.0.post0.dev109__tar.gz → 1.2.0.post0.dev245__tar.gz

{cuqipy-1.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/CUQIpy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CUQIpy
-Version: 1.2.0.post0.dev109
+Version: 1.2.0.post0.dev245
 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.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/CUQIpy.egg-info/SOURCES.txt

@@ -65,6 +65,7 @@ cuqi/implicitprior/__init__.py
 cuqi/implicitprior/_regularizedGMRF.py
 cuqi/implicitprior/_regularizedGaussian.py
 cuqi/implicitprior/_regularizedUnboundedUniform.py
+cuqi/implicitprior/_restorator.py
 cuqi/likelihood/__init__.py
 cuqi/likelihood/_likelihood.py
 cuqi/model/__init__.py

{cuqipy-1.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CUQIpy
-Version: 1.2.0.post0.dev109
+Version: 1.2.0.post0.dev245
 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.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/cuqi/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-11-08T11:08:22+0100",
+ "date": "2024-11-08T12:37:05+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "17570092caf729244ade9c6d647cfa1d2b9ef5f0",
- "version": "1.2.0.post0.dev109"
+ "full-revisionid": "113dd1dc30ade5f182e79d003153bcce9aee1894",
+ "version": "1.2.0.post0.dev245"
 }
 '''  # END VERSION_JSON
 

{cuqipy-1.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/cuqi/experimental/mcmc/__init__.py

@@ -109,7 +109,7 @@ Main changes for users
 
 
 from ._sampler import Sampler, ProposalBasedSampler
-from ._langevin_algorithm import ULA, MALA
+from ._langevin_algorithm import ULA, MALA, MYULA, PnPULA
 from ._mh import MH
 from ._pcn import PCN
 from ._rto import LinearRTO, RegularizedLinearRTO

cuqipy-1.2.0.post0.dev245/cuqi/experimental/mcmc/_langevin_algorithm.py

@@ -0,0 +1,389 @@
+import numpy as np
+import cuqi
+from cuqi.experimental.mcmc import Sampler
+from cuqi.implicitprior import RestorationPrior, MoreauYoshidaPrior
+from cuqi.array import CUQIarray
+from copy import deepcopy
+
+class ULA(Sampler): # Refactor to Proposal-based sampler?
+    """Unadjusted Langevin algorithm (ULA) (Roberts and Tweedie, 1996)
+
+    It approximately samples a distribution given its logpdf gradient based on
+    the Langevin diffusion dL_t = dW_t + 1/2*Nabla target.logd(L_t)dt, where
+    W_t is the `dim`-dimensional standard Brownian motion.
+    ULA results from the Euler-Maruyama discretization of this Langevin stochastic
+    differential equation (SDE). 
+
+    For more details see: Roberts, G. O., & Tweedie, R. L. (1996). Exponential convergence
+    of Langevin distributions and their discrete approximations. Bernoulli, 341-363.
+
+    Parameters
+    ----------
+
+    target : `cuqi.distribution.Distribution`
+        The target distribution to sample. Must have logd and gradient method. Custom logpdfs 
+        and gradients are supported by using a :class:`cuqi.distribution.UserDefinedDistribution`.
+    
+    initial_point : ndarray
+        Initial parameters. *Optional*
+
+    scale : float
+        The Langevin diffusion discretization time step (In practice, scale must
+        be smaller than 1/L, where L is the Lipschitz of the gradient of the log
+        target density, logd).
+
+    callback : callable, *Optional*
+        If set this function will be called after every sample.
+        The signature of the callback function is `callback(sample, sample_index)`,
+        where `sample` is the current sample and `sample_index` is the index of the sample.
+        An example is shown in demos/demo31_callback.py.
+
+
+    Example
+    -------
+    .. code-block:: python
+
+        # Parameters
+        dim = 5 # Dimension of distribution
+        mu = np.arange(dim) # Mean of Gaussian
+        std = 1 # standard deviation of Gaussian
+
+        # Logpdf function
+        logpdf_func = lambda x: -1/(std**2)*np.sum((x-mu)**2)
+        gradient_func = lambda x: -2/(std**2)*(x - mu)
+
+        # Define distribution from logpdf and gradient as UserDefinedDistribution
+        target = cuqi.distribution.UserDefinedDistribution(dim=dim, logpdf_func=logpdf_func,
+            gradient_func=gradient_func)
+
+        # Set up sampler
+        sampler = cuqi.experimental.mcmc.ULA(target, scale=1/dim**2)
+
+        # Sample
+        sampler.sample(2000)
+
+    A Deblur example can be found in demos/demo27_ULA.py
+    # TODO: update demo once sampler merged
+    """
+
+    _STATE_KEYS = Sampler._STATE_KEYS.union({'scale', 'current_target_grad'})
+
+    def __init__(self, target=None, scale=1.0, **kwargs):
+
+        super().__init__(target, **kwargs)
+        self.initial_scale = scale
+
+    def _initialize(self):
+        self.scale = self.initial_scale
+        self.current_target_grad = self._eval_target_grad(self.current_point)
+
+    def validate_target(self):
+        try:
+            self._eval_target_grad(np.ones(self.dim))
+            pass
+        except (NotImplementedError, AttributeError):
+            raise ValueError("The target needs to have a gradient method")
+
+    def _eval_target_logd(self, x):
+        return None
+
+    def _eval_target_grad(self, x):
+        return self.target.gradient(x)
+
+    def _accept_or_reject(self, x_star, target_eval_star, target_grad_star):
+        """
+        Accepts the proposed state and updates the sampler's state accordingly, i.e.,
+        current_point, current_target_eval, and current_target_grad_eval.
+
+        Parameters
+        ----------
+        x_star : 
+            The proposed state
+
+        target_eval_star: 
+            The log likelihood evaluated at x_star
+
+        target_grad_star: 
+            The gradient of log likelihood evaluated at x_star
+
+        Returns
+        -------
+        scalar
+            1 (accepted)
+        """
+
+        self.current_point = x_star
+        self.current_target_grad = target_grad_star
+        acc = 1
+
+        return acc
+
+    def step(self):
+        # propose state
+        xi = cuqi.distribution.Normal(mean=np.zeros(self.dim), std=np.sqrt(self.scale)).sample()
+        x_star = self.current_point + 0.5*self.scale*self.current_target_grad + xi
+
+        # evaluate target
+        target_eval_star = self._eval_target_logd(x_star)
+        target_grad_star = self._eval_target_grad(x_star)
+
+        # accept or reject proposal
+        acc = self._accept_or_reject(x_star, target_eval_star, target_grad_star)
+
+        return acc
+
+    def tune(self, skip_len, update_count):
+        pass
+
+
+class MALA(ULA): # Refactor to Proposal-based sampler?
+    """  Metropolis-adjusted Langevin algorithm (MALA) (Roberts and Tweedie, 1996)
+
+    Samples a distribution given its logd and gradient (up to a constant) based on
+    Langevin diffusion dL_t = dW_t + 1/2*Nabla target.logd(L_t)dt,
+    W_t is the `dim`-dimensional standard Brownian motion.
+    A sample is firstly proposed by ULA and is then accepted or rejected according
+    to a Metropolis–Hastings step.
+    This accept-reject step allows us to remove the asymptotic bias of ULA.
+
+    For more details see: Roberts, G. O., & Tweedie, R. L. (1996). Exponential convergence
+    of Langevin distributions and their discrete approximations. Bernoulli, 341-363.
+
+    Parameters
+    ----------
+
+    target : `cuqi.distribution.Distribution`
+        The target distribution to sample. Must have logpdf and gradient method. Custom logpdfs 
+        and gradients are supported by using a :class:`cuqi.distribution.UserDefinedDistribution`.
+    
+    initial_point : ndarray
+        Initial parameters. *Optional*
+
+    scale : float
+        The Langevin diffusion discretization time step (In practice, scale must
+        be smaller than 1/L, where L is the Lipschitz of the gradient of the log
+        target density, logd).
+
+    callback : callable, *Optional*
+        If set this function will be called after every sample.
+        The signature of the callback function is `callback(sample, sample_index)`,
+        where `sample` is the current sample and `sample_index` is the index of the sample.
+        An example is shown in demos/demo31_callback.py.
+
+
+    Example
+    -------
+    .. code-block:: python
+
+        # Parameters
+        dim = 5 # Dimension of distribution
+        mu = np.arange(dim) # Mean of Gaussian
+        std = 1 # standard deviation of Gaussian
+
+        # Logpdf function
+        logpdf_func = lambda x: -1/(std**2)*np.sum((x-mu)**2)
+        gradient_func = lambda x: -2/(std**2)*(x-mu)
+
+        # Define distribution from logpdf as UserDefinedDistribution (sample and gradients also supported)
+        target = cuqi.distribution.UserDefinedDistribution(dim=dim, logpdf_func=logpdf_func,
+            gradient_func=gradient_func)
+
+        # Set up sampler
+        sampler = cuqi.experimental.mcmc.MALA(target, scale=1/5**2)
+
+        # Sample
+        sampler.sample(2000)
+
+    A Deblur example can be found in demos/demo28_MALA.py
+    # TODO: update demo once sampler merged
+    """
+
+    _STATE_KEYS = ULA._STATE_KEYS.union({'current_target_logd'})
+
+    def _initialize(self):
+        super()._initialize()
+        self.current_target_logd = self.target.logd(self.current_point)
+
+    def _eval_target_logd(self, x):
+        return self.target.logd(x)
+
+    def _accept_or_reject(self, x_star, target_eval_star, target_grad_star):
+        """
+        Accepts the proposed state according to a Metropolis step and updates
+        the sampler's state accordingly, i.e., current_point, current_target_eval,
+        and current_target_grad_eval.
+
+        Parameters
+        ----------
+        x_star : 
+            The proposed state
+
+        target_eval_star: 
+            The log likelihood evaluated at x_star
+
+        target_grad_star: 
+            The gradient of log likelihood evaluated at x_star
+
+        Returns
+        -------
+        scaler
+            1 if accepted, 0 otherwise
+        """
+        log_target_ratio = target_eval_star - self.current_target_logd
+        log_prop_ratio = self._log_proposal(self.current_point, x_star, target_grad_star) \
+            - self._log_proposal(x_star, self.current_point,  self.current_target_grad)
+        log_alpha = min(0, log_target_ratio + log_prop_ratio)
+
+        # accept/reject with Metropolis
+        acc = 0
+        log_u = np.log(np.random.rand())
+        if (log_u <= log_alpha) and \
+           (not np.isnan(target_eval_star)) and \
+           (not np.isinf(target_eval_star)):
+            self.current_point = x_star
+            self.current_target_logd = target_eval_star
+            self.current_target_grad = target_grad_star
+            acc = 1
+        return acc
+
+    def tune(self, skip_len, update_count):
+        pass
+
+    def _log_proposal(self, theta_star, theta_k, g_logpi_k):
+        mu = theta_k + ((self.scale)/2)*g_logpi_k
+        misfit = theta_star - mu
+        return -0.5*((1/(self.scale))*(misfit.T @ misfit))
+
+
+class MYULA(ULA):
+    """Moreau-Yoshida Unadjusted Langevin algorithm (MYUULA) (Durmus et al., 2018)
+
+    Samples a smoothed target distribution given its smoothed logpdf gradient.
+    It is based on the Langevin diffusion dL_t = dW_t + 1/2*Nabla target.logd(L_t)dt, 
+    where W_t is a `dim`-dimensional standard Brownian motion.
+    It targets a differentiable density (partially) smoothed by the Moreau-Yoshida
+    envelope. The smoothed target density can be made arbitrarily closed to the
+    true unsmoothed target density.
+
+    For more details see: Durmus, Alain, Eric Moulines, and Marcelo Pereyra.
+    "Efficient Bayesian
+    computation by proximal Markov chain Monte Carlo: when Langevin meets Moreau."
+    SIAM Journal on Imaging Sciences 11.1 (2018): 473-506.
+
+    Parameters
+    ----------
+
+    target : `cuqi.distribution.Distribution`
+        The target distribution to sample from. The target distribution results from
+        a differentiable likelihood and prior of type RestorationPrior.
+    
+    initial_point : ndarray
+        Initial parameters. *Optional*
+
+    scale : float
+        The Langevin diffusion discretization time step (In practice, scale must
+        be smaller than 1/L, where L is the Lipschitz of the gradient of the log
+        target density, logd).
+        
+    smoothing_strength : float
+        This parameter controls the smoothing strength of MYULA.
+
+    callback : callable, *Optional*
+        If set this function will be called after every sample.
+        The signature of the callback function is `callback(sample, sample_index)`,
+        where `sample` is the current sample and `sample_index` is the index of
+        the sample.
+        An example is shown in demos/demo31_callback.py.
+
+    A Deblur example can be found in demos/howtos/myula.py
+    # TODO: update demo once sampler merged
+    """
+    def __init__(self, target=None, scale=1.0, smoothing_strength=0.1, **kwargs):
+        self.smoothing_strength = smoothing_strength
+        super().__init__(target=target, scale=scale, **kwargs)
+
+    @Sampler.target.setter
+    def target(self, value):
+        """ Set the target density. Runs validation of the target. """
+        self._target = value
+
+        if self._target is not None:
+            # Create a smoothed target
+            self._smoothed_target = self._create_smoothed_target(value)
+
+            # Validate the target
+            self.validate_target()
+
+    def _create_smoothed_target(self, value):
+        """ Create a smoothed target using a Moreau-Yoshida envelope. """
+        copied_value = deepcopy(value)
+        if isinstance(copied_value.prior, RestorationPrior):
+            copied_value.prior = MoreauYoshidaPrior(
+                copied_value.prior,
+                self.smoothing_strength)
+        return copied_value
+
+    def validate_target(self):
+        # Call ULA target validation
+        super().validate_target()
+
+        # Additional validation for MYULA target
+        if isinstance(self.target.prior, MoreauYoshidaPrior):
+            raise ValueError(("The prior is already smoothed, apply"
+                              " ULA when using a MoreauYoshidaPrior."))
+        if not hasattr(self.target.prior, "restore"):
+            raise NotImplementedError(
+                ("Using MYULA with a prior that does not have a restore method"
+                " is not supported.")
+            )
+
+    def _eval_target_grad(self, x):
+        return self._smoothed_target.gradient(x)
+
+class PnPULA(MYULA):
+    """Plug-and-Play Unadjusted Langevin algorithm (PnP-ULA)
+    (Laumont et al., 2022)
+
+    Samples a smoothed target distribution given its smoothed logpdf gradient based on
+    Langevin diffusion dL_t = dW_t + 1/2*Nabla target.logd(L_t)dt, where W_t is
+    a `dim`-dimensional standard Brownian motion.
+    It targets a differentiable density (partially) smoothed by a convolution
+    with Gaussian kernel with zero mean and smoothing_strength variance. The
+    smoothed target density can be made arbitrarily closed to the
+    true unsmoothed target density. 
+
+    For more details see: Laumont, R., Bortoli, V. D., Almansa, A., Delon, J.,
+    Durmus, A., & Pereyra, M. (2022). Bayesian imaging using plug & play priors:
+    when Langevin meets Tweedie. SIAM Journal on Imaging Sciences, 15(2), 701-737.
+
+    Parameters
+    ----------
+
+    target : `cuqi.distribution.Distribution`
+        The target distribution to sample. The target distribution result from
+        a differentiable likelihood and prior of type RestorationPrior.
+    
+    initial_point : ndarray
+        Initial parameters. *Optional*
+
+    scale : float
+        The Langevin diffusion discretization time step (In practice, a scale of
+        1/L, where L is the Lipschitz of the gradient of the log target density
+        is recommended but not guaranteed to be the optimal choice).
+        
+    smoothing_strength : float
+        This parameter controls the smoothing strength of PnP-ULA.
+
+
+    callback : callable, *Optional*
+        If set this function will be called after every sample.
+        The signature of the callback function is `callback(sample, sample_index)`,
+        where `sample` is the current sample and `sample_index` is the index of
+        the sample.
+        An example is shown in demos/demo31_callback.py.
+
+    # TODO: update demo once sampler merged
+    """
+    def __init__ (self, target=None, scale=1.0, smoothing_strength=0.1, **kwargs):
+        super().__init__(target=target, scale=scale, 
+                         smoothing_strength=smoothing_strength, **kwargs)

{cuqipy-1.2.0.post0.dev109 → cuqipy-1.2.0.post0.dev245}/cuqi/implicitprior/__init__.py

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

cuqipy-1.2.0.post0.dev245/cuqi/implicitprior/_restorator.py

@@ -0,0 +1,223 @@
+from abc import ABC, abstractmethod
+from cuqi.distribution import Distribution
+import numpy as np
+    
+class RestorationPrior(Distribution):
+    """    
+    This class defines an implicit distribution associated with a restoration operator
+    (eg denoiser). They are several works relating restorations operators with
+    priors, see 
+        -Laumont et al. https://arxiv.org/abs/2103.04715
+        -Hu et al. https://openreview.net/pdf?id=x7d1qXEn1e
+    We cannot sample from this distribution, neither compute its logpdf except in
+    some cases. It allows us to apply algorithms such as MYULA and PnPULA.
+    
+    Parameters
+    ---------- 
+    restorator : callable f(x, restoration_strength)
+        Function f that accepts input x to be restored and returns the
+        restored version of x and information about the restoration operation.
+            
+    restorator_kwargs : dictionary
+        Dictionary containing information about the restorator.
+        It contains keyword argument parameters that will be passed to the
+        restorator f. An example could be algorithm parameters such as the number
+        of iterations or the stopping criteria.
+    
+    potential : callable function, optional
+        The potential corresponds to the negative logpdf when it is accessible.
+        This function is a mapping from the parameter domain to the real set. 
+        It can be provided if the user knows how to relate it to the restorator.
+        Ex: restorator is the proximal operator of the total variation (TV), then
+        potential is the TV function. 
+    """
+    def __init__(self, restorator, restorator_kwargs
+                =None, potential=None, **kwargs):
+        if restorator_kwargs is None:
+            restorator_kwargs = {}
+        self.restorator = restorator 
+        self.restorator_kwargs = restorator_kwargs
+        self.potential = potential
+        super().__init__(**kwargs)
+
+    def restore(self, x, restoration_strength):
+        """This function allows us to restore the input x and returns the
+        restored version of x.
+        
+        Parameters
+        ---------- 
+        x : ndarray
+            parameter we want to restore.
+        
+        restoration_strength: positive float
+            Strength of the restoration operation. In the case where the
+            restorator is a denoiser, this parameter might correspond to the
+            noise level.
+        """
+        solution, info = self.restorator(x, restoration_strength=restoration_strength,
+                                         **self.restorator_kwargs)
+        self.info = info
+        return solution
+    
+    def logpdf(self, x):
+        """The logpdf function. It returns nan because we don't know the 
+        logpdf of the implicit prior."""
+        if self.potential is None:
+            return np.nan
+        else:
+            return -self.potential(x)
+    
+    def _sample(self, N, rng=None):
+        raise NotImplementedError("The sample method is not implemented for the"
+                                  + "RestorationPrior class.")
+
+    @property
+    def _mutable_vars(self):
+        """ Returns the mutable variables of the distribution. """
+        # Currently mutable variables are not supported for user-defined
+        # distributions.
+        return []
+
+    def get_conditioning_variables(self):
+        """ Returns the conditioning variables of the distribution. """
+        # Currently conditioning variables are not supported for user-defined
+        # distributions.
+        return []
+
+
+class MoreauYoshidaPrior(Distribution):
+    """    
+    This class defines (implicit) smoothed priors for which we can apply 
+    gradient-based algorithms. The smoothing is performed using
+    the Moreau-Yoshida envelope of the target prior potential.
+    
+    In the following we give a detailed explanation of the
+    Moreau-Yoshida smoothing.
+    
+    We consider a density such that - \log\pi(x) = -g(x) with g convex, lsc,
+    proper but not differentiable. Consequently, we cannot apply any
+    algorithm requiring the gradient of g.
+    Idea:
+    We consider the Moreau envelope of g defined as
+    
+    g_{smoothing_strength} (x) = inf_z 0.5*\| x-z \|_2^2/smoothing_strength + g(z).
+    
+    g_{smoothing_strength} has some nice properties
+        - g_{smoothing_strength}(x)-->g(x) as smoothing_strength-->0 for all x
+        - \nabla g_{smoothing_strength} is 1/smoothing_strength-Lipschitz
+        - \nabla g_{smoothing_strength}(x) = (x - prox_g^{smoothing_strength}(x))/smoothing_strength for all x with 
+        
+        prox_g^{smoothing_strength}(x) = argmin_z 0.5*\| x-z \|_2^2/smoothing_strength + g(z) .
+
+    Consequently, we can apply any gradient-based algorithm with
+    g_{smoothing_strength} in lieu of g. These algorithms do not require the
+    full knowledge of g_{smoothing_strength} but only its gradient. The gradient
+    of g_{smoothing_strength} is fully determined by prox_g^{smoothing_strength}
+    and smoothing_strength.
+    It is important as, although there exists an explicit formula for
+    g_{smoothing_strength}, it is rarely used in practice, as it would require
+    us to solve an optimization problem each time we want to 
+    estimate g_{smoothing_strength}. Furthermore, there exist cases where we dont't
+    the regularization g with which the mapping prox_g^{smoothing_strength} is
+    associated.
+
+    Remark (Proximal operators are denoisers):
+        We consider the denoising inverse problem x = u + n, with
+        n \sim \mathcal{N}(0, smoothing_strength I).
+        A mapping solving a denoising inverse problem is called denoiser. It takes
+        the noisy observation x as an input and returns a less noisy version of x
+        which is an estimate of u.
+        We assume a prior density \pi(u) \propto exp(- g(u)).
+        Then the MAP estimate is given by 
+            x_MAP = \argmin_z 0.5 \| x - z \|_2^2/smoothing_strength + g(z) = prox_g^smoothing_strength(x)
+        Then proximal operators are denoisers. 
+    
+    Remark (Denoisers are not necessarily proximal operators): Data-driven
+    denoisers are not necessarily proximal operators
+    (see https://arxiv.org/pdf/2201.13256)
+    
+    Parameters
+    ---------- 
+    prior : RestorationPrior
+        Prior of the RestorationPrior type. In order to stay within the MYULA
+        framework the restorator of RestorationPrior must be a proximal operator.
+        
+    smoothing_strength : float
+        Smoothing strength of the Moreau-Yoshida envelope of the prior potential.
+    """
+
+    def __init__(self, prior:RestorationPrior, smoothing_strength=0.1, 
+                 **kwargs):
+        self.prior = prior
+        self.smoothing_strength = smoothing_strength
+
+        # if kwargs does not contain the geometry,
+        # we set it to the geometry of the prior, if it exists
+        if "geometry" in kwargs:
+            raise ValueError(
+                "The geometry parameter is not supported for the"
+                + "MoreauYoshidaPrior class. The geometry is"
+                + "automatically set to the geometry of the prior.")
+        try:
+            geometry = prior.geometry
+        except:
+            geometry = None
+
+        super().__init__(geometry=geometry, **kwargs)
+
+    @property
+    def geometry(self):
+        return self.prior.geometry
+
+    @geometry.setter
+    def geometry(self, value):
+        self.prior.geometry = value
+
+    @property
+    def smoothing_strength(self):
+        """ smoothing_strength of the distribution"""
+        return self._smoothing_strength
+
+    @smoothing_strength.setter
+    def smoothing_strength(self, value):
+        self._smoothing_strength = value
+        
+    @property
+    def prior(self):
+        """Getter for the MoreauYoshida prior."""
+        return self._prior
+
+    @prior.setter
+    def prior(self, value):
+        self._prior = value
+    
+    def gradient(self, x):
+        """This is the gradient of the regularizer ie gradient of the negative
+        logpdf of the implicit prior."""
+        return -(x - self.prior.restore(x, self.smoothing_strength))/self.smoothing_strength
+        
+    def logpdf(self, x):
+        """The logpdf function. It returns nan because we don't know the 
+        logpdf of the implicit prior."""
+        if self.prior.potential == None:
+            return np.nan
+        else:
+            return -(self.prior.potential(self.prior.restore(x, self.smoothing_strength))*self.smoothing_strength +
+                     0.5*((x-self.prior.restore(x, self.smoothing_strength))**2).sum())
+    
+    def _sample(self, N, rng=None):
+        raise NotImplementedError("The sample method is not implemented for the"
+                                  + f"{self.__class__.__name__} class.")
+
+    @property
+    def _mutable_vars(self):
+        """ Returns the mutable variables of the distribution. """
+        # Currently mutable variables are not supported for user-defined
+        # distributions.
+        return []
+
+    def get_conditioning_variables(self):
+        """ Returns the conditioning variables of the distribution. """
+        # Currently conditioning variables are not supported for user-defined
+        # distributions.
+        return []