Merge pull request #1316 from arcondello/feature/keyword-only-sampler…

…-args

Make optional sampler args keyword-only

dimod/reference/samplers/exact_solver.py

@@ -214,8 +214,10 @@ def __init__(self):
  self.properties = {}
  self.parameters = {}
 
- def sample_cqm(self, cqm: ConstrainedQuadraticModel, rtol: float = 1e-6,
- atol: float = 1e-8, **kwargs) -> SampleSet:
+ def sample_cqm(self, cqm: ConstrainedQuadraticModel, *,
+ rtol: float = 1e-6,
+ atol: float = 1e-8,
+ **kwargs) -> SampleSet:
  """Sample from a constrained quadratic model.
 
  Args:

dimod/reference/samplers/identity_sampler.py

@@ -73,7 +73,7 @@ class IdentitySampler(Sampler, Initialized):
 
  properties = {}
 
- def sample(self, bqm: BinaryQuadraticModel,
+ def sample(self, bqm: BinaryQuadraticModel, *,
  initial_states: typing.Optional[SamplesLike] = None,
  initial_states_generator: InitialStateGenerator = 'random',
  num_reads: typing.Optional[int] = None,

dimod/reference/samplers/random_sampler.py

@@ -45,7 +45,7 @@ def __init__(self):
  self.parameters = {'num_reads': []}
  self.properties = {}
 
- def sample(self, bqm, num_reads=10, seed=None, **kwargs):
+ def sample(self, bqm, *, num_reads=10, seed=None, **kwargs):
  """Return random samples for a binary quadratic model.
 
  Variable assignments are chosen by coin flip.

dimod/reference/samplers/simulated_annealing.py

@@ -58,7 +58,7 @@ def __init__(self):
  'num_sweeps': []}
  self.properties = {}
 
- def sample(self, bqm, beta_range=None, num_reads=10, num_sweeps=1000, **kwargs):
+ def sample(self, bqm, *, beta_range=None, num_reads=10, num_sweeps=1000, **kwargs):
  """Sample from low-energy spin states using simulated annealing.
 
  Args:

releasenotes/notes/sampler-kwarg-only-args-060c1b5ac2615463.yaml

@@ -0,0 +1,6 @@
+---
+upgrade:
+ - Make ``beta_range``, ``num_reads``, and ``num_sweeps`` keyword-only arguments for ``SimulatedAnnealingSampler.sample()``.
+ - Make ``num_reads`` and ``seed`` keyword-only arguments for ``RandomSampler.sample()``.
+ - Make ``initial_states``, ``initial_states_generator``, ``num_reads`` and ``seed`` keyword-only arguments for ``IdentitySampler.sample()``.
+ - Make ``rtol`` and ``atol`` keyword-only arguments for ``ExactCQMSolver.sample_cqm()``.