neal.sampler.SimulatedAnnealingSampler.parameters

SimulatedAnnealingSampler.parameters = None

A dict where keys are the keyword parameters accepted by the sampler methods (allowed kwargs) and values are lists of SimulatedAnnealingSampler.properties relevant to each parameter.

See SimulatedAnnealingSampler.sample() for a description of the parameters.

Examples

This example looks at a sampler’s parameters and some of their values.

>>> import neal
>>> sampler = neal.SimulatedAnnealingSampler()
>>> for kwarg in sorted(sampler.parameters):
...     print(kwarg)
beta_range
beta_schedule_type
initial_states
initial_states_generator
interrupt_function
num_reads
num_sweeps
seed
>>> sampler.parameters['beta_range']
[]
>>> sampler.parameters['beta_schedule_type']
['beta_schedule_options']

Type

dict