Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add class and instance-level Client config defaults #427

Merged
merged 9 commits into from
Sep 21, 2020
Merged

Add class and instance-level Client config defaults #427

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
255ad6f
Add client instance-based defaults
randomir Sep 18, 2020
cc61b7a
Separate env config load, simplify load_config
randomir Sep 20, 2020
34ed872
Unify option value derivation from defaults/config
randomir Sep 20, 2020
72e5a9a
Move polling parameters to shared options/config
randomir Sep 20, 2020
f1ddc4f
Remove dead code for clock drift testing
randomir Sep 20, 2020
cab5546
Parse boolean config options correctly
randomir Sep 20, 2020
32f356b
Document all Client args and de-dup config loading desc
randomir Sep 20, 2020
24247c4
Expand scope of docs built (add some missing meth/attr)
randomir Sep 21, 2020
c74aa02
Update docs as per review comments
randomir Sep 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions docs/reference/resources.rst
View file
Open in desktop
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.solvers
Client.retrieve_answer
Client.get_solver
Client.get_solvers
Client.is_solver_handled
Client.close
randomir marked this conversation as resolved.
Show resolved Hide resolved


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

.. autosummary::
:toctree: generated

qpu.Client.is_solver_handled

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

randomir marked this conversation as resolved.
Show resolved Hide resolved
.. automodule:: dwave.cloud.sw
.. currentmodule:: dwave.cloud.sw


Class
-----

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

Methods
-------

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

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

Class
-----

sw.Client.is_solver_handled
.. autoclass:: dwave.cloud.hybrid.Client
Loading