Class Client

dwave/cloud/client/sw.py:29–72

D-Wave Solver API client specialized to work only with remote software solvers. This class can be instantiated explicitly, or via (base) Client's factory method, :meth:`~dwave.cloud.client.Client.from_config` by supplying ``"sw"`` for ``client``. Examples: This example

class Client(BaseClient):
    """D-Wave Solver API client specialized to work only with remote software
    solvers.

    This class can be instantiated explicitly, or via (base) Client's factory
    method, :meth:`~dwave.cloud.client.Client.from_config` by supplying ``"sw"``
    for ``client``.

    Examples:
        This example explicitly instantiates a :class:`dwave.cloud.sw.Client`.
        :meth:`~dwave.cloud.client.Client.get_solver` is guaranteed to return a
        software solver.

        .. code-block:: python

            from dwave.cloud.sw import Client

            with Client(token='...') as client:
                solver = client.get_solver()
                response = solver.sample_ising(...)

        The following example instantiates a software-solver-only client
        indirectly. Again, :meth:`~dwave.cloud.client.Client.get_solver`/
        :meth:`~dwave.cloud.client.Client.get_solvers` are guaranteed to return
        only software solver(s).

        .. code-block:: python

            from dwave.cloud import Client

            with Client.from_config(client='sw') as client:
                solver = client.get_solver()
                response = solver.sample_ising(...)

    """

    @staticmethod
    def is_solver_handled(solver):
        """Determine if the specified solver should be handled by this client.

        This predicate function (used from the base class) allows only remote
        software solvers.
        """
        return solver and solver.software