CUQIpy 1.3.0.post0.dev237__py3-none-any.whl → 1.3.0.post0.dev266__py3-none-any.whl

cuqi/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2025-05-15T09:06:20+0300",
+ "date": "2025-06-23T11:22:39+0300",
  "dirty": false,
  "error": null,
- "full-revisionid": "b9a5dd37abfe2ee51d5594630de54dd3469bfeca",
- "version": "1.3.0.post0.dev237"
+ "full-revisionid": "0ad94a56cb0776e3b0964f9aebbc01c1b7b41ac1",
+ "version": "1.3.0.post0.dev266"
 }
 '''  # END VERSION_JSON
 

cuqi/experimental/__init__.py

@@ -2,3 +2,4 @@
 from . import mcmc
 from . import algebra
 from . import geometry
+from ._recommender import SamplerRecommender

cuqi/experimental/_recommender.py

@@ -0,0 +1,200 @@
+import cuqi
+import inspect
+import numpy as np
+
+# This import makes suggest_sampler easier to read
+import cuqi.experimental.mcmc as samplers 
+
+
+class SamplerRecommender(object):
+    """
+    This class can be used to automatically choose a sampler.
+
+    Parameters
+    ----------
+    target: Density or JointDistribution
+        Distribution to get sampler recommendations for.
+
+    exceptions: list[cuqi.experimental.mcmc.Sampler], *optional*
+        Samplers not to be recommended.
+    """
+
+    def __init__(self, target:cuqi.density.Density, exceptions = []):
+        self._target = target
+        self._exceptions = exceptions
+        self._create_ordering()
+
+    @property
+    def target(self) -> cuqi.density.Density:
+        """ Return the target Distribution. """
+        return self._target
+    
+    @target.setter
+    def target(self, value:cuqi.density.Density):
+        """ Set the target Distribution. Runs validation of the target. """
+        if value is None:
+            raise ValueError("Target needs to be of type cuqi.density.Density.")
+        self._target = value
+
+    def _create_ordering(self):
+        """
+        Every element in the ordering consists of a tuple:
+        (
+            Sampler: Class
+            boolean: additional conditions on the target
+            parameters: additional parameters to be passed to the sampler once initialized
+        )
+        """
+        number_of_components = np.sum(self._target.dim)
+
+        self._ordering = [
+            # Direct and Conjugate samplers
+            (samplers.Direct, True, {}),
+            (samplers.Conjugate, True, {}),
+            (samplers.ConjugateApprox, True, {}),
+            # Specialized samplers
+            (samplers.LinearRTO, True, {}),
+            (samplers.RegularizedLinearRTO, True, {}),
+            (samplers.UGLA, True, {}),
+            # Gradient.based samplers (Hamiltonian and Langevin)
+            (samplers.NUTS, True, {}),
+            (samplers.MALA, True, {}),
+            (samplers.ULA, True, {}),
+            # Gibbs and Componentwise samplers
+            (samplers.HybridGibbs, True, {"sampling_strategy" : self.recommend_HybridGibbs_sampling_strategy(as_string = False)}),
+            (samplers.CWMH, number_of_components <= 100, {"scale" : 0.05*np.ones(number_of_components),
+                            "initial_point" : 0.5*np.ones(number_of_components)}),
+            # Proposal based samplers
+            (samplers.PCN, True, {"scale" : 0.02}),
+            (samplers.MH, number_of_components <= 1000, {}),
+        ]
+
+    @property
+    def ordering(self):
+        """ Returns the ordered list of recommendation rules used by the recommender. """
+        return self._ordering
+    
+    def valid_samplers(self, as_string = True):
+        """
+        Finds all possible samplers that can be used for sampling from the target distribution.
+
+        Parameters
+        ----------
+
+        as_string : boolean
+            Whether to return the name of the sampler as a string instead of instantiating a sampler. *Optional*
+
+        """
+
+        all_samplers = [(name, cls) for name, cls in inspect.getmembers(cuqi.experimental.mcmc, inspect.isclass) if issubclass(cls, cuqi.experimental.mcmc.Sampler)]
+        valid_samplers = []
+
+        for name, sampler in all_samplers:
+            try:
+                sampler(self.target)
+                valid_samplers += [name if as_string else sampler]
+            except:
+                pass
+
+        # Need a separate case for HybridGibbs
+        if self.valid_HybridGibbs_sampling_strategy() is not None:
+            valid_samplers += [cuqi.experimental.mcmc.HybridGibbs.__name__ if as_string else cuqi.experimental.mcmc.HybridGibbs]
+
+        return valid_samplers
+    
+
+    def valid_HybridGibbs_sampling_strategy(self, as_string = True):
+        """
+            Find all possible sampling strategies to be used with the HybridGibbs sampler.
+            Returns None if no sampler could be suggested for at least one conditional distribution.
+
+            Parameters
+            ----------
+
+            as_string : boolean
+                Whether to return the name of the samplers in the sampling strategy as a string instead of instantiating samplers. *Optional*
+        
+
+        """
+
+        if not isinstance(self.target, cuqi.distribution.JointDistribution):
+            return None
+
+        par_names = self.target.get_parameter_names()
+
+        valid_samplers = dict()
+        for par_name in par_names:
+            conditional_params = {par_name_: np.ones(self.target.dim[i]) for i, par_name_ in enumerate(par_names) if par_name_ != par_name}
+            conditional = self.target(**conditional_params)
+
+            recommender = SamplerRecommender(conditional)
+            samplers = recommender.valid_samplers(as_string)
+            if len(samplers) == 0:
+                return None
+            
+            valid_samplers[par_name] = samplers
+
+        return valid_samplers
+    
+
+    def recommend(self, as_string = False):
+        """
+            Suggests a possible sampler that can be used for sampling from the target distribution.
+            Return None if no sampler could be suggested.
+
+            Parameters
+            ----------
+
+            as_string : boolean
+                Whether to return the name of the sampler as a string instead of instantiating a sampler. *Optional*
+
+        """
+
+        valid_samplers = self.valid_samplers(as_string = False)
+
+        for suggestion, flag, values in self._ordering:
+            if flag and (suggestion in valid_samplers) and (suggestion not in self._exceptions):
+                # Sampler found
+                if as_string:
+                    return suggestion.__name__
+                else:
+                    return suggestion(self.target, **values)
+
+        # No sampler can be suggested
+        raise ValueError("Cannot suggest any sampler. Either the provided distribution is incorrectly defined or there are too many exceptions provided.")
+
+    def recommend_HybridGibbs_sampling_strategy(self, as_string = False):
+        """
+            Suggests a possible sampling strategy to be used with the HybridGibbs sampler.
+            Returns None if no sampler could be suggested for at least one conditional distribution.
+
+            Parameters
+            ----------
+
+            target : `cuqi.distribution.JointDistribution`
+                The target distribution get a sampling strategy for.
+            
+            as_string : boolean
+                Whether to return the name of the samplers in the sampling strategy as a string instead of instantiating samplers. *Optional*
+        
+        """
+
+        if not isinstance(self.target, cuqi.distribution.JointDistribution):
+            return None
+
+        par_names = self.target.get_parameter_names()
+
+        suggested_samplers = dict()
+        for par_name in par_names:
+            conditional_params = {par_name_: np.ones(self.target.dim[i]) for i, par_name_ in enumerate(par_names) if par_name_ != par_name}
+            conditional = self.target(**conditional_params)
+
+            recommender = SamplerRecommender(conditional, exceptions = self._exceptions.copy())
+            sampler = recommender.recommend(as_string = as_string)
+
+            if sampler is None:
+                return None
+            
+            suggested_samplers[par_name] = sampler
+
+        return suggested_samplers

cuqi/experimental/mcmc/__init__.py

@@ -120,4 +120,3 @@ from ._gibbs import HybridGibbs
 from ._conjugate import Conjugate
 from ._conjugate_approx import ConjugateApprox
 from ._direct import Direct
-from ._utilities import find_valid_samplers

{cuqipy-1.3.0.post0.dev237.dist-info → cuqipy-1.3.0.post0.dev266.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CUQIpy
-Version: 1.3.0.post0.dev237
+Version: 1.3.0.post0.dev266
 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.dev237.dist-info → cuqipy-1.3.0.post0.dev266.dist-info}/RECORD

@@ -1,6 +1,6 @@
 cuqi/__init__.py,sha256=LsGilhl-hBLEn6Glt8S_l0OJzAA1sKit_rui8h-D-p0,488
 cuqi/_messages.py,sha256=fzEBrZT2kbmfecBBPm7spVu7yHdxGARQB4QzXhJbCJ0,415
-cuqi/_version.py,sha256=T-xOiDXchZq_KrCheA_86YhVx3HMHSXQflIX3VRywVQ,510
+cuqi/_version.py,sha256=Fy9rwbT3nuGJzIHPUCFz7PEcw7IArqAqvMtmm3okneE,510
 cuqi/config.py,sha256=wcYvz19wkeKW2EKCGIKJiTpWt5kdaxyt4imyRkvtTRA,526
 cuqi/diagnostics.py,sha256=5OrbJeqpynqRXOe5MtOKKhe7EAVdOEpHIqHnlMW9G_c,3029
 cuqi/array/__init__.py,sha256=-EeiaiWGNsE3twRS4dD814BIlfxEsNkTCZUc5gjOXb0,30
@@ -34,14 +34,15 @@ cuqi/distribution/_posterior.py,sha256=zAfL0GECxekZ2lBt1W6_LN0U_xskMwK4VNce5xAF7
 cuqi/distribution/_smoothed_laplace.py,sha256=p-1Y23mYA9omwiHGkEuv3T2mwcPAAoNlCr7T8osNkjE,2925
 cuqi/distribution/_truncated_normal.py,sha256=_ez3MmO6qpBeP6BKCUlW3IgxuF7k--A7jPGPUhtYK0g,4240
 cuqi/distribution/_uniform.py,sha256=fVgj_4SBav8JMc1pNAO1l_CZ9ZwdoMIpN9iQ3i9_Z0Q,3255
-cuqi/experimental/__init__.py,sha256=bIQ9OroeitHbwgNe3wI_JvzkILK0N25Tt7wpquPoU3w,129
+cuqi/experimental/__init__.py,sha256=9DidfQuoFPr8DnhYzI78N2J0fT4pp-jNle0Rou1fcrM,174
+cuqi/experimental/_recommender.py,sha256=IawSXwsaYs0T7t6SIXjchX4sj5D1rwbs3bs_nMXAxD0,7400
 cuqi/experimental/algebra/__init__.py,sha256=btRAWG58ZfdtK0afXKOg60AX7d76KMBjlZa4AWBCCgU,81
 cuqi/experimental/algebra/_ast.py,sha256=PdPz19cJMjvnMx4KEzhn4gvxIZX_UViE33Mbttj_5Xw,9873
 cuqi/experimental/algebra/_orderedset.py,sha256=fKysh4pmI4xF7Y5Z6O86ABzg20o4uBs-v8jmLBMrdpo,2849
 cuqi/experimental/algebra/_randomvariable.py,sha256=isbFtIWsWXF-yF5Vb56nLy4MCkQM6akjd-dQau4wfbE,19725
 cuqi/experimental/geometry/__init__.py,sha256=kgoKegfz3Jhr7fpORB_l55z9zLZRtloTLyXFDh1oF2o,47
 cuqi/experimental/geometry/_productgeometry.py,sha256=IlBmmKsWE-aRZHp6no9gUXGRfkHlgM0CdPBx1hax9HI,7199
-cuqi/experimental/mcmc/__init__.py,sha256=zSqLZmxOqQ-F94C9-gPv7g89TX1XxlrlNm071Eb167I,4487
+cuqi/experimental/mcmc/__init__.py,sha256=hTAssTgtgLhdVZLFX7hpLJYtWmXrmfXb4bWee6ELqwE,4443
 cuqi/experimental/mcmc/_conjugate.py,sha256=vqucxC--pihBCUcupdcIo4ymDPPjmMKGb7OL1THjaKE,22059
 cuqi/experimental/mcmc/_conjugate_approx.py,sha256=jmxe2FEbO9fwpc8opyjJ2px0oed3dGyj0qDwyHo4aOk,3545
 cuqi/experimental/mcmc/_cwmh.py,sha256=cAvtc3tex53ZUKPMGwj2RIkHAZurpqphko8nk8_DmJs,7340
@@ -54,7 +55,6 @@ cuqi/experimental/mcmc/_mh.py,sha256=MXo0ahXP4KGFkaY4HtvcBE-TMQzsMlTmLKzSvpz7drU
 cuqi/experimental/mcmc/_pcn.py,sha256=wqJBZLuRFSwxihaI53tumAg6AWVuceLMOmXssTetd1A,3374
 cuqi/experimental/mcmc/_rto.py,sha256=BY55Njw3-dcmjd-V1vQ58CisEDllQ8zaEj92pWB6LCM,15158
 cuqi/experimental/mcmc/_sampler.py,sha256=VK-VsPRaYET43C5quhu2f1OstEX5DKYKVyjKABTRHZE,20288
-cuqi/experimental/mcmc/_utilities.py,sha256=kUzHbhIS3HYZRbneNBK41IogUYX5dS_bJxqEGm7TQBI,525
 cuqi/geometry/__init__.py,sha256=Tz1WGzZBY-QGH3c0GiyKm9XHN8MGGcnU6TUHLZkzB3o,842
 cuqi/geometry/_geometry.py,sha256=W-oQTZPelVS7fN9qZj6bNBuh-yY0eqOHJ39UwB-WmQY,47562
 cuqi/implicitprior/__init__.py,sha256=6z3lvw-tWDyjZSpB3pYzvijSMK9Zlf1IYqOVTtMD2h4,309
@@ -93,8 +93,8 @@ cuqi/testproblem/_testproblem.py,sha256=EJWG_zXUtmo6GlHBZFqHlRpDC_48tE0XZEu0_C66
 cuqi/utilities/__init__.py,sha256=d5QXRzmI6EchS9T4b7eTezSisPWuWklO8ey4YBx9kI0,569
 cuqi/utilities/_get_python_variable_name.py,sha256=wxpCaj9f3ZtBNqlGmmuGiITgBaTsY-r94lUIlK6UAU4,2043
 cuqi/utilities/_utilities.py,sha256=as8cFswoxROS0Z7WUKzLIE-ZtEKCXes5M3Gdmmb47No,18414
-cuqipy-1.3.0.post0.dev237.dist-info/licenses/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
-cuqipy-1.3.0.post0.dev237.dist-info/METADATA,sha256=ZXvYGwj_lUbv3_vDiKRWtkRpjlAH5PfpaZqx-aMgwJg,18624
-cuqipy-1.3.0.post0.dev237.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-cuqipy-1.3.0.post0.dev237.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
-cuqipy-1.3.0.post0.dev237.dist-info/RECORD,,
+cuqipy-1.3.0.post0.dev266.dist-info/licenses/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
+cuqipy-1.3.0.post0.dev266.dist-info/METADATA,sha256=m3jmxO185qu_BLJWaQh31JKe5alD02bvk7BIKSR0AOk,18624
+cuqipy-1.3.0.post0.dev266.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cuqipy-1.3.0.post0.dev266.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
+cuqipy-1.3.0.post0.dev266.dist-info/RECORD,,

{cuqipy-1.3.0.post0.dev237.dist-info → cuqipy-1.3.0.post0.dev266.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cuqi/experimental/mcmc/_utilities.py

@@ -1,17 +0,0 @@
-import cuqi
-import inspect
-
-def find_valid_samplers(target):
-    """ Finds all samplers in the cuqi.experimental.mcmc module that accept the provided target. """
-
-    all_samplers = [(name, cls) for name, cls in inspect.getmembers(cuqi.experimental.mcmc, inspect.isclass) if issubclass(cls, cuqi.experimental.mcmc.Sampler)]
-    valid_samplers = []
-
-    for name, sampler in all_samplers:
-        try:
-            sampler(target)
-            valid_samplers += [name]
-        except:
-            pass
-
-    return valid_samplers