CUQIpy 1.4.0.post0.dev13__py3-none-any.whl → 1.4.0.post0.dev41__py3-none-any.whl

cuqi/legacy/sampler/_laplace_approximation.py

@@ -0,0 +1,184 @@
+import scipy as sp
+import numpy as np
+import cuqi
+from cuqi.distribution import Normal
+from cuqi.solver import CGLS
+from cuqi.legacy.sampler import Sampler
+
+
+class UGLA(Sampler):
+    """ Unadjusted (Gaussian) Laplace Approximation sampler
+    
+    Samples an approximate posterior where the prior is approximated
+    by a Gaussian distribution. The likelihood must be Gaussian.
+
+    Currently only works for LMRF priors.
+
+    The inner solver is Conjugate Gradient Least Squares (CGLS) solver.
+
+    For more details see: Uribe, Felipe, et al. "A hybrid Gibbs sampler for edge-preserving 
+    tomographic reconstruction with uncertain view angles." arXiv preprint arXiv:2104.06919 (2021).
+
+    Parameters
+    ----------
+    target : `cuqi.distribution.Posterior`
+        The target posterior distribution to sample.
+
+    x0 : ndarray
+        Initial parameters. *Optional*
+
+    maxit : int
+        Maximum number of inner iterations for solver when generating one sample.
+
+    tol : float
+        Tolerance for inner solver. Will stop before maxit if the inner solvers convergence check reaches tol.
+
+    beta : float
+        Smoothing parameter for the Gaussian approximation of the Laplace distribution. Larger beta is easier to sample but is a worse approximation.
+
+    rng : np.random.RandomState
+        Random number generator used for sampling. *Optional*
+
+    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.
+
+    Returns
+    -------
+    cuqi.samples.Samples
+        Samples from the posterior distribution.
+
+    """
+
+    def __init__(self, target, x0=None, maxit=50, tol=1e-4, beta=1e-5, rng=None, **kwargs):
+        
+        super().__init__(target, x0=x0, **kwargs)
+
+        # Check target type
+        if not isinstance(self.target, cuqi.distribution.Posterior):
+            raise ValueError(f"To initialize an object of type {self.__class__}, 'target' need to be of type 'cuqi.distribution.Posterior'.")       
+
+        # Check Affine model
+        if not isinstance(self.target.likelihood.model, cuqi.model.AffineModel):
+            raise TypeError("Model needs to be affine or linear")
+
+        # Check Gaussian likelihood
+        if not hasattr(self.target.likelihood.distribution, "sqrtprec"):
+            raise TypeError("Distribution in Likelihood must contain a sqrtprec attribute")
+
+        # Check that prior is LMRF
+        if not isinstance(self.target.prior, cuqi.distribution.LMRF):
+            raise ValueError('Unadjusted Gaussian Laplace approximation (UGLA) requires LMRF prior')
+
+        # Modify initial guess since Sampler sets it to ones.       
+        if x0 is not None:
+            self.x0 = x0
+        else:
+            self.x0 = np.zeros(self.target.prior.dim)
+        
+        # Store internal parameters
+        self.maxit = maxit
+        self.tol = tol
+        self.beta = beta
+        self.rng = rng
+
+    def _sample_adapt(self, Ns, Nb):
+        return self._sample(Ns, Nb)
+
+    def _sample(self, Ns, Nb):
+        """ Sample from the approximate posterior.
+
+        Parameters
+        ----------
+        Ns : int
+            Number of samples to draw.
+
+        Nb : int
+            Number of burn-in samples to discard.
+
+        Returns
+        -------
+        samples : ndarray
+            Samples from the approximate posterior.
+
+        target_eval : ndarray
+            Log-likelihood of each sample.
+
+        acc : ndarray
+            Acceptance rate of each sample.
+
+        """
+
+        # Extract diff_op from target prior
+        D = self.target.prior._diff_op
+        n = D.shape[0]
+
+        # Gaussian approximation of LMRF prior as function of x_k
+        def Lk_fun(x_k):
+            dd =  1/np.sqrt((D @ x_k)**2 + self.beta*np.ones(n))
+            W = sp.sparse.diags(dd)
+            return W.sqrt() @ D
+
+        # Now prepare "LinearRTO" type sampler. TODO: Use LinearRTO for this instead
+        self._shift = 0
+
+        # Pre-computations
+        self._model = self.target.likelihood.model   
+        self._data = self.target.likelihood.data - self.target.model._shift
+        self._m = len(self._data)
+        self._L1 = self.target.likelihood.distribution.sqrtprec
+
+        # If prior location is scalar, repeat it to match dimensions
+        if len(self.target.prior.location) == 1:
+            self._priorloc = np.repeat(self.target.prior.location, self.dim)
+        else:
+            self._priorloc = self.target.prior.location
+
+        # Initial Laplace approx
+        self._L2 = Lk_fun(self.x0)
+        self._L2mu = self._L2@self._priorloc
+        self._b_tild = np.hstack([self._L1@self._data, self._L2mu]) 
+        
+        #self.n = len(self.x0)
+        
+        # Least squares form
+        def M(x, flag):
+            if flag == 1:
+                out1 = self._L1 @ self._model._forward_func_no_shift(x) # Use forward function which excludes shift
+                out2 = np.sqrt(1/self.target.prior.scale)*(self._L2 @ x)
+                out  = np.hstack([out1, out2])
+            elif flag == 2:
+                idx = int(self._m)
+                out1 = self._model._adjoint_func_no_shift(self._L1.T@x[:idx])
+                out2 = np.sqrt(1/self.target.prior.scale)*(self._L2.T @ x[idx:])
+                out  = out1 + out2                
+            return out 
+        
+        # Initialize samples
+        N = Ns+Nb   # number of simulations        
+        samples = np.empty((self.target.dim, N))
+                     
+        # initial state   
+        samples[:, 0] = self.x0
+        for s in range(N-1):
+
+            # Update Laplace approximation
+            self._L2 = Lk_fun(samples[:, s])
+            self._L2mu = self._L2@self._priorloc
+            self._b_tild = np.hstack([self._L1@self._data, self._L2mu]) 
+        
+            # Sample from approximate posterior
+            e = Normal(mean=np.zeros(len(self._b_tild)), std=1).sample(rng=self.rng)
+            y = self._b_tild + e # Perturb data
+            sim = CGLS(M, y, samples[:, s], self.maxit, self.tol, self._shift)            
+            samples[:, s+1], _ = sim.solve()
+
+            self._print_progress(s+2,N) #s+2 is the sample number, s+1 is index assuming x0 is the first sample
+            self._call_callback(samples[:, s+1], s+1)
+
+        # remove burn-in
+        samples = samples[:, Nb:]
+        
+        return samples, None, None

cuqi/legacy/sampler/_mh.py

@@ -0,0 +1,190 @@
+import numpy as np
+import cuqi
+from cuqi.legacy.sampler import ProposalBasedSampler
+
+
+class MH(ProposalBasedSampler):
+    """Metropolis Hastings sampler.
+
+    Allows sampling of a target distribution by random-walk sampling of a proposal distribution along with an accept/reject step.
+
+    Parameters
+    ----------
+
+    target : `cuqi.distribution.Distribution` or lambda function
+        The target distribution to sample. Custom logpdfs are supported by using a :class:`cuqi.distribution.UserDefinedDistribution`.
+    
+    proposal : `cuqi.distribution.Distribution` or callable method
+        The proposal to sample from. If a callable method it should provide a single independent sample from proposal distribution. Defaults to a Gaussian proposal.  *Optional*.
+
+    scale : float
+        Scale parameter used to define correlation between previous and proposed sample in random-walk.  *Optional*.
+
+    x0 : ndarray
+        Initial parameters. *Optional*
+
+    dim : int
+        Dimension of parameter space. Required if target and proposal are callable functions. *Optional*.
+
+    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)
+
+        # Define distribution from logpdf as UserDefinedDistribution (sample and gradients also supported)
+        target = cuqi.distribution.UserDefinedDistribution(dim=dim, logpdf_func=logpdf_func)
+
+        # Set up sampler
+        sampler = cuqi.legacy.sampler.MH(target, scale=1)
+
+        # Sample
+        samples = sampler.sample(2000)
+
+    """
+    #target,  proposal=None, scale=1, x0=None, dim=None
+    #    super().__init__(target, proposal=proposal, scale=scale,  x0=x0, dim=dim)
+    def __init__(self, target, proposal=None, scale=None, x0=None, dim=None, **kwargs):
+        """ Metropolis-Hastings (MH) sampler. Default (if proposal is None) is random walk MH with proposal that is Gaussian with identity covariance"""
+        super().__init__(target, proposal=proposal, scale=scale,  x0=x0, dim=dim, **kwargs)
+
+
+    @ProposalBasedSampler.proposal.setter 
+    def proposal(self, value):
+        fail_msg = "Proposal should be either None, symmetric cuqi.distribution.Distribution or a lambda function."
+
+        if value is None:
+            self._proposal = cuqi.distribution.Gaussian(np.zeros(self.dim), 1)
+        elif not isinstance(value, cuqi.distribution.Distribution) and callable(value):
+            raise NotImplementedError(fail_msg)
+        elif isinstance(value, cuqi.distribution.Distribution) and value.is_symmetric:
+            self._proposal = value
+        else:
+            raise ValueError(fail_msg)
+        self._proposal.geometry = self.target.geometry
+
+    def _sample(self, N, Nb):
+        if self.scale is None:
+            raise ValueError("Scale must be set to sample without adaptation. Consider using sample_adapt instead.")
+        
+        Ns = N+Nb   # number of simulations
+
+        # allocation
+        samples = np.empty((self.dim, Ns))
+        target_eval = np.empty(Ns)
+        acc = np.zeros(Ns, dtype=int)
+
+        # initial state    
+        samples[:, 0] = self.x0
+        target_eval[0] = self.target.logd(self.x0)
+        acc[0] = 1
+
+        # run MCMC
+        for s in range(Ns-1):
+            # run component by component
+            samples[:, s+1], target_eval[s+1], acc[s+1] = self.single_update(samples[:, s], target_eval[s])
+            self._print_progress(s+2,Ns) #s+2 is the sample number, s+1 is index assuming x0 is the first sample
+            self._call_callback(samples[:, s+1], s+1)
+
+        # remove burn-in
+        samples = samples[:, Nb:]
+        target_eval = target_eval[Nb:]
+        accave = acc[Nb:].mean()   
+        print('\nAverage acceptance rate:', accave, '\n')
+        #
+        return samples, target_eval, accave
+
+    def _sample_adapt(self, N, Nb):
+        # Set intial scale if not set
+        if self.scale is None:
+            self.scale = 0.1
+            
+        Ns = N+Nb   # number of simulations
+
+        # allocation
+        samples = np.empty((self.dim, Ns))
+        target_eval = np.empty(Ns)
+        acc = np.zeros(Ns)
+
+        # initial state    
+        samples[:, 0] = self.x0
+        target_eval[0] = self.target.logd(self.x0)
+        acc[0] = 1
+
+        # initial adaptation params 
+        Na = int(0.1*N)                              # iterations to adapt
+        hat_acc = np.empty(int(np.floor(Ns/Na)))     # average acceptance rate of the chains
+        lambd = self.scale
+        star_acc = 0.234    # target acceptance rate RW
+        i, idx = 0, 0
+
+        # run MCMC
+        for s in range(Ns-1):
+            # run component by component
+            samples[:, s+1], target_eval[s+1], acc[s+1] = self.single_update(samples[:, s], target_eval[s])
+            
+            # adapt prop spread using acc of past samples
+            if ((s+1) % Na == 0):
+                # evaluate average acceptance rate
+                hat_acc[i] = np.mean(acc[idx:idx+Na])
+
+                # d. compute new scaling parameter
+                zeta = 1/np.sqrt(i+1)   # ensures that the variation of lambda(i) vanishes
+                lambd = np.exp(np.log(lambd) + zeta*(hat_acc[i]-star_acc))
+
+                # update parameters
+                self.scale = min(lambd, 1)
+
+                # update counters
+                i += 1
+                idx += Na
+
+            # display iterations
+            self._print_progress(s+2,Ns) #s+2 is the sample number, s+1 is index assuming x0 is the first sample
+
+
+        # remove burn-in
+        samples = samples[:, Nb:]
+        target_eval = target_eval[Nb:]
+        accave = acc[Nb:].mean()   
+        print('\nAverage acceptance rate:', accave, 'MCMC scale:', self.scale, '\n')
+        
+        return samples, target_eval, accave
+
+
+    def single_update(self, x_t, target_eval_t):
+        # propose state
+        xi = self.proposal.sample(1)   # sample from the proposal
+        x_star = x_t + self.scale*xi.flatten()   # MH proposal
+
+        # evaluate target
+        target_eval_star = self.target.logd(x_star)
+
+        # ratio and acceptance probability
+        ratio = target_eval_star - target_eval_t  # proposal is symmetric
+        alpha = min(0, ratio)
+
+        # accept/reject
+        u_theta = np.log(np.random.rand())
+        if (u_theta <= alpha):
+            x_next = x_star
+            target_eval_next = target_eval_star
+            acc = 1
+        else:
+            x_next = x_t
+            target_eval_next = target_eval_t
+            acc = 0
+        
+        return x_next, target_eval_next, acc

cuqi/legacy/sampler/_pcn.py

@@ -0,0 +1,244 @@
+import numpy as np
+import cuqi
+from cuqi.legacy.sampler import Sampler
+
+class pCN(Sampler):   
+    #Samples target*proposal
+    #TODO. Check proposal, needs to be Gaussian and zero mean.
+    """Preconditioned Crank-Nicolson sampler 
+    
+    Parameters
+    ----------
+    target : `cuqi.distribution.Posterior` or tuple of likelihood and prior objects
+        If target is of type cuqi.distribution.Posterior, it represents the posterior distribution.
+        If target is a tuple of (cuqi.likelihood.Likelihood, cuqi.distribution.Distribution) objects,
+        the first element is considered the likelihood and the second is considered the prior.
+
+    scale : int
+
+    x0 : `np.ndarray` 
+      Initial point for the sampler
+
+    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 
+    -------
+
+    This uses a custom logpdf and sample function.
+
+    .. code-block:: python
+
+        # Parameters
+        dim = 5 # Dimension of distribution
+        mu = np.arange(dim) # Mean of Gaussian
+        std = 1 # standard deviation of Gaussian
+
+        # Logpdf function of likelihood
+        logpdf_func = lambda x: -1/(std**2)*np.sum((x-mu)**2)
+
+        # sample function of prior N(0,I)
+        sample_func = lambda : 0 + 1*np.random.randn(dim,1)
+
+        # Define as UserDefinedDistributions
+        likelihood = cuqi.likelihood.UserDefinedLikelihood(dim=dim, logpdf_func=logpdf_func)
+        prior = cuqi.distribution.UserDefinedDistribution(dim=dim, sample_func=sample_func)
+
+        # Set up sampler
+        sampler = cuqi.legacy.sampler.pCN((likelihood,prior), scale = 0.1)
+
+        # Sample
+        samples = sampler.sample(5000)
+
+    Example
+    -------
+
+    This uses CUQIpy distributions.
+
+    .. code-block:: python
+
+        # Parameters
+        dim = 5 # Dimension of distribution
+        mu = np.arange(dim) # Mean of Gaussian
+        std = 1 # standard deviation of Gaussian
+
+        # Define as UserDefinedDistributions
+        model = cuqi.model.Model(lambda x: x, range_geometry=dim, domain_geometry=dim)
+        likelihood = cuqi.distribution.Gaussian(mean=model, cov=np.ones(dim)).to_likelihood(mu)
+        prior = cuqi.distribution.Gaussian(mean=np.zeros(dim), cov=1)
+
+        target = cuqi.distribution.Posterior(likelihood, prior)
+
+        # Set up sampler
+        sampler = cuqi.legacy.sampler.pCN(target, scale = 0.1)
+
+        # Sample
+        samples = sampler.sample(5000)
+        
+    """
+    def __init__(self, target, scale=None, x0=None, **kwargs):
+        super().__init__(target, x0=x0, dim=None, **kwargs) 
+        self.scale = scale
+    
+    @property
+    def prior(self):
+        if isinstance(self.target, cuqi.distribution.Posterior):
+            return self.target.prior
+        elif isinstance(self.target,tuple) and len(self.target)==2:
+            return self.target[1]
+
+    @property
+    def likelihood(self):
+        if isinstance(self.target, cuqi.distribution.Posterior):
+            return self.target.likelihood
+        elif isinstance(self.target,tuple) and len(self.target)==2:
+            return self.target[0]
+
+
+    @Sampler.target.setter 
+    def target(self, value):
+        if isinstance(value, cuqi.distribution.Posterior):
+            self._target = value
+            self._loglikelihood = lambda x : self.likelihood.logd(x)
+        elif isinstance(value,tuple) and len(value)==2 and \
+             (isinstance(value[0], cuqi.likelihood.Likelihood) or isinstance(value[0], cuqi.likelihood.UserDefinedLikelihood))  and \
+             isinstance(value[1], cuqi.distribution.Distribution):
+            self._target = value
+            self._loglikelihood = lambda x : self.likelihood.logd(x)
+        else:
+            raise ValueError(f"To initialize an object of type {self.__class__}, 'target' need to be of type 'cuqi.distribution.Posterior'.")
+        
+        #TODO:
+        #if not isinstance(self.prior,(cuqi.distribution.Gaussian, cuqi.distribution.Normal)):
+        #    raise ValueError("The prior distribution of the target need to be Gaussian")
+
+    @property
+    def dim(self):
+        if hasattr(self,'target') and hasattr(self.target,'dim'):
+            self._dim = self.target.dim
+        elif hasattr(self,'target') and isinstance(self.target,tuple) and len(self.target)==2:
+            self._dim = self.target[0].dim
+        return self._dim
+
+    def _sample(self, N, Nb):
+        if self.scale is None:
+            raise ValueError("Scale must be set to sample without adaptation. Consider using sample_adapt instead.")
+
+        Ns = N+Nb   # number of simulations
+
+        # allocation
+        samples = np.empty((self.dim, Ns))
+        loglike_eval = np.empty(Ns)
+        acc = np.zeros(Ns, dtype=int)
+
+        # initial state    
+        samples[:, 0] = self.x0
+        loglike_eval[0] = self._loglikelihood(self.x0)
+        acc[0] = 1
+
+        # run MCMC
+        for s in range(Ns-1):
+            # run component by component
+            samples[:, s+1], loglike_eval[s+1], acc[s+1] = self.single_update(samples[:, s], loglike_eval[s])
+
+            self._print_progress(s+2,Ns) #s+2 is the sample number, s+1 is index assuming x0 is the first sample
+            self._call_callback(samples[:, s+1], s+1)
+
+        # remove burn-in
+        samples = samples[:, Nb:]
+        loglike_eval = loglike_eval[Nb:]
+        accave = acc[Nb:].mean()   
+        print('\nAverage acceptance rate:', accave, '\n')
+        #
+        return samples, loglike_eval, accave
+
+    def _sample_adapt(self, N, Nb):
+        # Set intial scale if not set
+        if self.scale is None:
+            self.scale = 0.1
+
+        Ns = N+Nb   # number of simulations
+
+        # allocation
+        samples = np.empty((self.dim, Ns))
+        loglike_eval = np.empty(Ns)
+        acc = np.zeros(Ns)
+
+        # initial state    
+        samples[:, 0] = self.x0
+        loglike_eval[0] = self._loglikelihood(self.x0) 
+        acc[0] = 1
+
+        # initial adaptation params 
+        Na = int(0.1*N)                              # iterations to adapt
+        hat_acc = np.empty(int(np.floor(Ns/Na)))     # average acceptance rate of the chains
+        lambd = self.scale
+        star_acc = 0.44    # target acceptance rate RW
+        i, idx = 0, 0
+
+        # run MCMC
+        for s in range(Ns-1):
+            # run component by component
+            samples[:, s+1], loglike_eval[s+1], acc[s+1] = self.single_update(samples[:, s], loglike_eval[s])
+            
+            # adapt prop spread using acc of past samples
+            if ((s+1) % Na == 0):
+                # evaluate average acceptance rate
+                hat_acc[i] = np.mean(acc[idx:idx+Na])
+
+                # d. compute new scaling parameter
+                zeta = 1/np.sqrt(i+1)   # ensures that the variation of lambda(i) vanishes
+                lambd = np.exp(np.log(lambd) + zeta*(hat_acc[i]-star_acc))
+
+                # update parameters
+                self.scale = min(lambd, 1)
+
+                # update counters
+                i += 1
+                idx += Na
+
+            # display iterations
+            if ((s+1) % (max(Ns//100,1))) == 0 or (s+1) == Ns-1:
+                print("\r",'Sample', s+1, '/', Ns, end="")
+
+            self._call_callback(samples[:, s+1], s+1)
+
+        print("\r",'Sample', s+2, '/', Ns)
+
+        # remove burn-in
+        samples = samples[:, Nb:]
+        loglike_eval = loglike_eval[Nb:]
+        accave = acc[Nb:].mean()   
+        print('\nAverage acceptance rate:', accave, 'MCMC scale:', self.scale, '\n')
+        
+        return samples, loglike_eval, accave
+
+    def single_update(self, x_t, loglike_eval_t):
+        # propose state
+        xi = self.prior.sample(1).flatten()   # sample from the prior
+        x_star = np.sqrt(1-self.scale**2)*x_t + self.scale*xi   # pCN proposal
+
+        # evaluate target
+        loglike_eval_star =  self._loglikelihood(x_star) 
+
+        # ratio and acceptance probability
+        ratio = loglike_eval_star - loglike_eval_t  # proposal is symmetric
+        alpha = min(0, ratio)
+
+        # accept/reject
+        u_theta = np.log(np.random.rand())
+        if (u_theta <= alpha):
+            x_next = x_star
+            loglike_eval_next = loglike_eval_star
+            acc = 1
+        else:
+            x_next = x_t
+            loglike_eval_next = loglike_eval_t
+            acc = 0
+        
+        return x_next, loglike_eval_next, acc
+    
+