DWaveSamplerClient

class DWaveSamplerClient

Bases: BaseClient

Methods

__init__
solve	Send the objective function and the constraints to the solver.

Attributes

acceptable_degrees	Degrees of the polynomial that the solver accepts.
compress_qpu_problem_data
graph
parameters	Parameters that the client sends with every request.
properties
proxy	URL of the proxy that the client goes through, or None for no proxy.
solver
solver_names
token	API token of the user.
url	URL of the service that the client sends to.
version	Version of the service.
write_request_data	Path of the file that receives a copy of the request, or None to write none.
write_response_data	Path of the file that receives a copy of the response, or None to write none.

class AnswerMode

Bases: Enum

classmethod __contains__(value)

Return True if value is in cls.

value is in cls if: 1) value is a member of cls, or 2) value is the value of one of the cls’s members. 3) value is a pseudo-member (flags)

classmethod __getitem__(name)

Return the member matching name.

classmethod __iter__()

Return members in definition order.

classmethod __len__()

Return the number of members (no aliases)

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

__members__ = mappingproxy({'histogram': DWaveSamplerClientAnswerMode.histogram, 'raw': DWaveSamplerClientAnswerMode.raw})

__name__ = 'AnswerMode'

__nb_enum__ = <capsule object NULL>

__qualname__ = 'DWaveSamplerClient.AnswerMode'

histogram = 0

raw = 1

class Parameters

Parameters that the client sends with every request.

__init__(self) → None

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

property anneal_offsets

property anneal_schedule

property annealing_time

The value in microseconds. Fractional values are preserved.

Return type:

float | None

property answer_mode

property auto_scale

property fast_anneal

property flux_biases

property flux_drift_compensation

property h_gain_schedule

property initial_state

property label

property num_reads

property programming_thermalization

The value in microseconds. Fractional values are preserved.

Return type:

float | None

property readout_thermalization

The value in microseconds. Fractional values are preserved.

Return type:

float | None

property reduce_intersample_correlation

property reinitialize_state

__init__(self) → None

__init__(self, token: str = '', solver: str = '', url: str = '', proxy: str | None = None) → None

Parameters:

• token (str) – Defaults to ''.

• solver (str) – Defaults to ''.

• url (str) – Defaults to ''.

• proxy (str | None) – Defaults to None.

__repr__(self) → str

Return type:

str

__str__(self) → str

Return type:

str

solve(self, objective: Poly, dry_run: Literal[False] = False) → SampleSet

solve(self, objective: Poly, dry_run: Literal[True]) → None

Send the objective function and the constraints to the solver.

This method takes the polynomial that the solver accepts, so it runs no conversion of the model. Use solve() to solve a model that needs a conversion. It returns the raw response of the solver.

Overload 1.

Args:

• objective (amplify.Poly): The objective function that the solver minimizes.

• dry_run (typing.Literal[False]): When True, ask the service to check the request, and return None. Defaults to False.

Returns:

dimod.sampleset.SampleSet:

Overload 2.

Args:

• objective (amplify.Poly): The objective function that the solver minimizes.

• dry_run (typing.Literal[True]): When True, ask the service to check the request, and return None.

property acceptable_degrees

Degrees of the polynomial that the solver accepts.

solve() reads it to decide the conversion of the model.

Return type:

AcceptableDegrees

property compress_qpu_problem_data

property graph

property parameters

Parameters that the client sends with every request.

Return type:

Parameters

property properties

property proxy

URL of the proxy that the client goes through, or None for no proxy.

Return type:

str | None

property solver

property solver_names

property token

API token of the user.

The client needs it for every request. Its text never appears in the output of repr().

Return type:

str

property url

URL of the service that the client sends to.

Return type:

str

property version

Version of the service.

Reading this property sends a request to the service.

Return type:

str

property write_request_data

Path of the file that receives a copy of the request, or None to write none.

Use it to inspect what the client sends.

Return type:

Path | None

property write_response_data

Path of the file that receives a copy of the response, or None to write none.

Return type:

Path | None