Refresh samplers

docs/conf.py

@@ -45,7 +45,8 @@
 
 add_module_names = False
 
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'sdk_index.rst']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'sdk_index.rst',
+                    'README.rst',]
 
 linkcheck_retries = 2
 linkcheck_anchors = False
@@ -80,8 +81,8 @@
 html_sidebars = {"**": ["search-field", "sidebar-nav-bs"]}  # remove ads
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
-    'networkx': ('https://networkx.github.io/documentation/stable/', None),
-    'numpy': ('http://numpy.org/doc/stable/', None),
+    'networkx': ('https://networkx.org/documentation/stable/', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
     'dwave': ('https://docs.dwavequantum.com/en/latest/', None),
     }
 

docs/samplers.rst

@@ -25,7 +25,7 @@ DWaveSampler
 ============
 
 .. autoclass:: DWaveSampler
-   :show-inheritance:
+    :show-inheritance:
 
 Properties
 ----------
@@ -34,27 +34,32 @@ For parameters and properties of D-Wave systems, see the
 :ref:`qpu_index_solver_properties` and :ref:`qpu_solver_parameters` sections.
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
-   DWaveSampler.properties
-   DWaveSampler.parameters
-   DWaveSampler.nodelist
-   DWaveSampler.edgelist
-   DWaveSampler.adjacency
-   DWaveSampler.structure
+    ~DWaveSampler.adjacency
+    ~DWaveSampler.edgelist
+    ~DWaveSampler.nodelist
+    ~DWaveSampler.parameters
+    ~DWaveSampler.properties
+    ~DWaveSampler.structure
+    ~DWaveSampler.warnings_default
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
+
+    ~DWaveSampler.close
+    ~DWaveSampler.remove_unknown_kwargs
+    ~DWaveSampler.sample
+    ~DWaveSampler.sample_ising
+    ~DWaveSampler.sample_qubo
+    ~DWaveSampler.to_networkx_graph
+    ~DWaveSampler.trigger_failover
+    ~DWaveSampler.valid_bqm_graph
+    ~DWaveSampler.validate_anneal_schedule
 
-   DWaveSampler.sample
-   DWaveSampler.sample_ising
-   DWaveSampler.sample_qubo
-   DWaveSampler.validate_anneal_schedule
-   DWaveSampler.to_networkx_graph
-   DWaveSampler.close
 
 DWaveCliqueSampler
 ==================
@@ -65,27 +70,29 @@ Properties
 ----------
 
 .. autosummary::
-   :toctree: generated/
-
-   DWaveCliqueSampler.largest_clique_size
-   DWaveCliqueSampler.qpu_linear_range
-   DWaveCliqueSampler.qpu_quadratic_range
-   DWaveCliqueSampler.properties
-   DWaveCliqueSampler.parameters
-   DWaveCliqueSampler.target_graph
+    :toctree: generated/
 
+    ~DWaveCliqueSampler.largest_clique_size
+    ~DWaveCliqueSampler.parameters
+    ~DWaveCliqueSampler.properties
+    ~DWaveCliqueSampler.qpu_linear_range
+    ~DWaveCliqueSampler.qpu_quadratic_range
+    ~DWaveCliqueSampler.target_graph
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
-   DWaveCliqueSampler.largest_clique
-   DWaveCliqueSampler.sample
-   DWaveCliqueSampler.sample_ising
-   DWaveCliqueSampler.sample_qubo
-   DWaveCliqueSampler.close
+    ~DWaveCliqueSampler.clique
+    ~DWaveCliqueSampler.close
+    ~DWaveCliqueSampler.largest_clique
+    ~DWaveCliqueSampler.remove_unknown_kwargs
+    ~DWaveCliqueSampler.sample
+    ~DWaveCliqueSampler.sample_ising
+    ~DWaveCliqueSampler.sample_qubo
+    ~DWaveCliqueSampler.trigger_failover
 
 
 LeapHybridSampler
@@ -97,24 +104,25 @@ Properties
 ----------
 
 .. autosummary::
-   :toctree: generated/
-
-   LeapHybridSampler.properties
-   LeapHybridSampler.parameters
-   LeapHybridSampler.default_solver
+    :toctree: generated/
 
+    ~LeapHybridSampler.default_solver
+    ~LeapHybridSampler.parameters
+    ~LeapHybridSampler.properties
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
+
+    ~LeapHybridSampler.close
+    ~LeapHybridSampler.min_time_limit
+    ~LeapHybridSampler.remove_unknown_kwargs
+    ~LeapHybridSampler.sample
+    ~LeapHybridSampler.sample_ising
+    ~LeapHybridSampler.sample_qubo
 
-   LeapHybridSampler.sample
-   LeapHybridSampler.sample_ising
-   LeapHybridSampler.sample_qubo
-   LeapHybridSampler.min_time_limit
-   LeapHybridSampler.close
 
 LeapHybridCQMSampler
 ====================
@@ -125,21 +133,22 @@ Properties
 ----------
 
 .. autosummary::
-   :toctree: generated/
-
-   LeapHybridCQMSampler.properties
-   LeapHybridCQMSampler.parameters
+    :toctree: generated/
 
+    ~LeapHybridCQMSampler.default_solver
+    ~LeapHybridCQMSampler.properties
+    ~LeapHybridCQMSampler.parameters
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
+
+    ~LeapHybridCQMSampler.close
+    ~LeapHybridCQMSampler.min_time_limit
+    ~LeapHybridCQMSampler.sample_cqm
 
-   LeapHybridCQMSampler.sample_cqm
-   LeapHybridCQMSampler.min_time_limit
-   LeapHybridCQMSampler.close
 
 LeapHybridNLSampler
 ====================
@@ -150,21 +159,22 @@ Properties
 ----------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
-   LeapHybridNLSampler.properties
-   LeapHybridNLSampler.parameters
-   LeapHybridNLSampler.default_solver
+    ~LeapHybridNLSampler.default_solver
+    ~LeapHybridNLSampler.parameters
+    ~LeapHybridNLSampler.properties
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
+
+    ~LeapHybridNLSampler.close
+    ~LeapHybridNLSampler.estimated_min_time_limit
+    ~LeapHybridNLSampler.sample
 
-   LeapHybridNLSampler.sample
-   LeapHybridNLSampler.estimated_min_time_limit
-   LeapHybridNLSampler.close
 
 LeapHybridDQMSampler
 ====================
@@ -175,19 +185,18 @@ Properties
 ----------
 
 .. autosummary::
-   :toctree: generated/
-
-   LeapHybridDQMSampler.properties
-   LeapHybridDQMSampler.parameters
-   LeapHybridDQMSampler.default_solver
+    :toctree: generated/
 
+    ~LeapHybridDQMSampler.default_solver
+    ~LeapHybridDQMSampler.parameters
+    ~LeapHybridDQMSampler.properties
 
 Methods
 -------
 
 .. autosummary::
-   :toctree: generated/
+    :toctree: generated/
 
-   LeapHybridDQMSampler.sample_dqm
-   LeapHybridDQMSampler.min_time_limit
-   LeapHybridDQMSampler.close
+    ~LeapHybridDQMSampler.close
+    ~LeapHybridDQMSampler.min_time_limit
+    ~LeapHybridDQMSampler.sample_dqm

docs/utilities.rst

@@ -4,6 +4,8 @@
 Utilities
 =========
 
+.. todo:: add dwave_sampler.qpu_graph post https://github.com/dwavesystems/dwave-system/pull/585
+
 .. automodule:: dwave.system.utilities
 
 .. currentmodule:: dwave.system

dwave/system/exceptions.py

@@ -14,12 +14,12 @@
 
 
 class FailoverCondition(Exception):
-    """QPU or Solver API call failed with an error that might be mitigated by
-    retrying on a different solver.
+    """QPU or :term:`SAPI` call failed with an error that might be mitigated by
+    retrying on a different :term:`solver`.
     """
 
 
 class RetryCondition(FailoverCondition):
-    """QPU or Solver API call failed with an error that might be mitigated by
-    retrying on the same solver.
+    """QPU or :term:`SAPI` call failed with an error that might be mitigated by
+    retrying (on the same :term:`solver`).
     """