Merge pull request #668 from CUQI-DTU/add_recommender_example

Add example for using recommender class

Author: amal-ghamdi

cuqi/experimental/_recommender.py

@@ -17,6 +17,24 @@ class SamplerRecommender(object):
 
     exceptions: list[cuqi.experimental.mcmc.Sampler], *optional*
         Samplers not to be recommended.
+    
+    Example
+    -------
+    .. code-block:: python
+        import numpy as np
+        from cuqi.distribution import Gamma, Gaussian, JointDistribution
+        from cuqi.experimental import SamplerRecommender
+
+        x = Gamma(1, 1)
+        y = Gaussian(np.zeros(2), cov=lambda x: 1 / x)
+        target = JointDistribution(y, x)(y=1)
+
+        recommender = SamplerRecommender(target)
+        valid_samplers = recommender.valid_samplers()
+        recommended_sampler = recommender.recommend()
+        print("Valid samplers:", valid_samplers)
+        print("Recommended sampler:\n", recommended_sampler)
+
     """
 
     def __init__(self, target:cuqi.density.Density, exceptions = []):
@@ -28,7 +46,7 @@ def __init__(self, target:cuqi.density.Density, exceptions = []):
     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. """
@@ -73,7 +91,7 @@ def _create_ordering(self):
     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.
@@ -101,7 +119,6 @@ def valid_samplers(self, as_string = True):
             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):
         """
@@ -131,11 +148,10 @@ def valid_HybridGibbs_sampling_strategy(self, as_string = True):
             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):
         """
@@ -194,7 +210,7 @@ def recommend_HybridGibbs_sampling_strategy(self, as_string = False):
 
             if sampler is None:
                 return None
-            
+
             suggested_samplers[par_name] = sampler
 
-        return suggested_samplers
+        return suggested_samplers