Skip to content

Commit

Permalink
Merge pull request #427 from randomir/feature/zero-level-config/issue…
Browse files Browse the repository at this point in the history
…-425

Add class and instance-level Client config defaults
  • Loading branch information
randomir authored Sep 21, 2020
2 parents b4b004f + c74aa02 commit 277a752
Show file tree
Hide file tree
Showing 11 changed files with 394 additions and 287 deletions.
7 changes: 7 additions & 0 deletions docs/reference/computation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,12 @@ Methods
:toctree: generated

Future.result
Future.error
Future.exception
Future.as_completed
Future.wait
Future.wait_id
Future.wait_sampleset
Future.wait_multiple
Future.done
Future.cancel
Expand All @@ -36,7 +40,10 @@ Properties
Future.samples
Future.variables
Future.energies
Future.num_occurrences
Future.occurrences
Future.sampleset

Future.id
Future.problem_type
Future.timing
63 changes: 32 additions & 31 deletions docs/reference/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,40 @@ that it later explicitly closes.
Typically you use the :class:`~dwave.cloud.client.Client` class. By default, it instantiates
a QPU client. You can also use the specialized QPU and CPU/GPU clients directly.


Client (Base Client)
====================

.. automodule:: dwave.cloud.client
.. currentmodule:: dwave.cloud.client

Class
-----

.. autoclass:: dwave.cloud.client.Client
.. autoclass:: Client

Properties
----------

.. autosummary::
:toctree: generated

Client.DEFAULTS

Methods
-------

.. currentmodule:: dwave.cloud

.. autosummary::
:toctree: generated

client.Client.from_config
client.Client.solvers
client.Client.retrieve_answer
client.Client.get_solver
client.Client.get_solvers
client.Client.is_solver_handled
client.Client.close
Client.from_config
Client.get_solver
Client.get_solvers
Client.solvers
Client.is_solver_handled
Client.retrieve_answer
Client.close


Specialized Clients
===================
Expand All @@ -62,42 +71,34 @@ a QPU client. You can also instantiate a QPU or CPU/GPU client directly.
QPU Client
----------

.. currentmodule:: dwave.cloud.qpu

.. automodule:: dwave.cloud.qpu
.. currentmodule:: dwave.cloud.qpu

Class
-----
~~~~~

.. autoclass:: dwave.cloud.qpu.Client

Methods
-------

.. currentmodule:: dwave.cloud
Hybrid-Samplers Client
------------------------

.. autosummary::
:toctree: generated
.. automodule:: dwave.cloud.hybrid
.. currentmodule:: dwave.cloud.hybrid

Class
~~~~~

.. autoclass:: dwave.cloud.hybrid.Client

qpu.Client.is_solver_handled

Software-Samplers Client
------------------------

.. automodule:: dwave.cloud.sw
.. currentmodule:: dwave.cloud.sw


Class
-----
~~~~~

.. autoclass:: dwave.cloud.sw.Client

Methods
-------

.. currentmodule:: dwave.cloud

.. autosummary::
:toctree: generated

sw.Client.is_solver_handled
7 changes: 5 additions & 2 deletions docs/reference/solver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@ Methods
:toctree: generated

StructuredSolver.check_problem
StructuredSolver.max_num_reads
StructuredSolver.sample_ising
StructuredSolver.sample_qubo
StructuredSolver.max_num_reads
StructuredSolver.sample_bqm

UnstructuredSolver.sample_ising
UnstructuredSolver.sample_qubo
UnstructuredSolver.sample_bqm
UnstructuredSolver.upload_bqm


Properties
Expand All @@ -41,9 +43,10 @@ Properties
:toctree: generated

BaseSolver.name
BaseSolver.online
BaseSolver.avg_load
BaseSolver.online
BaseSolver.qpu
BaseSolver.hybrid
BaseSolver.software

StructuredSolver.num_active_qubits
Expand Down
Loading

0 comments on commit 277a752

Please sign in to comment.