dimod.Sampler.parameters

Sampler.parameters

dict – A dict where keys are the keyword parameters accepted by the sampler methods and values are lists of the properties relevent to each parameter.

Examples

This example adds a verbose parameter to an Ising sampler.

class IsingSampler(dimod.Sampler):
    def __init__(self):
        self._parameters = {'verbose': []}

    def sample_ising(self, h, J, verbose=False):
        sample = linear_ising(h, J) # Implemented elsewhere
        energy = dimod.ising_energy(sample, h, J)
        if verbose:
            print(sample)
        return dimod.Response.from_dicts([sample], {'energy': [energy]})

    @property
    def properties(self):
        return dict()

    @property
    def parameters(self):
        return self._parameters