Dwave-ocean-sdk

New Features

- Add `StructuredSolver.reformat_parameters()` method. This method can be used to format solver parameters for SAPI. See [\465](https://github.com/dwavesystems/dwave-cloud-client/issues/465).

- Support `dimod<0.13.0`. See [\514](https://github.com/dwavesystems/dwave-cloud-client/pull/514).

Bug Fixes

- Make sure `Future.wait_id()` fails deterministically in a case of problem submit error. Previously it would hang if SAPI didn't return problem\_id for whatever reason. See [\469](https://github.com/dwavesystems/dwave-cloud-client/issues/469) and [\#511](https://github.com/dwavesystems/dwave-cloud-client/issues/511).

- Preemptively resolve sampling answer during `dwave ping` and `dwave sample`, as to capture and properly output/format eventual errors. See [\517](https://github.com/dwavesystems/dwave-cloud-client/issues/517).

New Features

- Add Python 3.10 support.

- Add `--json` output option to `dwave sample`.

- Add `--sampling-params` option to `dwave sample`. `--num-reads` has been kept, and it now overwrites value given in sampling params.

- Add `--label` option to `dwave ping` and `dwave sample`, with a default value set. See [\481](https://github.com/dwavesystems/dwave-cloud-client/issues/481).

- Add `--full` option to `dwave setup`, propagated to `dwave config create`. Clarified `dwave setup` operation in CLI help.

- Filter out API token-like strings from logs. Most notably, we make sure to redact Solver API tokens, but will filter out any prefixed hex token. See [\391](https://github.com/dwavesystems/dwave-cloud-client/issues/391).

Bug Fixes

- Improved error and output handling in `dwave sample`. See [\300](https://github.com/dwavesystems/dwave-cloud-client/issues/300).

New Features

- Added Metadata API client, `Regions` model and API resource. See [\483](https://github.com/dwavesystems/dwave-cloud-client/pull/483).

- Added multi-region support to `dwave.cloud.Client`. See [\483](https://github.com/dwavesystems/dwave-cloud-client/pull/483).

New config option for region selection is called `region`, and environment variable is called `DWAVE_API_REGION`.

New config option for specifying Metadata API endpoint URL is exposed as `metadata_api_endpoint` and `DWAVE_METADATA_API_ENDPOINT`.

List of available regions available with `dwave.cloud.Client.get_regions`.

- Add context manager protocol support to `dwave.cloud.api.client.DWaveAPIClient` to ensure resources are easily cleaned up (session closed). Note that `close()` method is available for cases when context manager pattern is inconvenient. See [\492](https://github.com/dwavesystems/dwave-cloud-client/pull/492).

Similarly, we add `close()` method to resources in `dwave.cloud.api.resource.*`, in addition to the existing context manager protocol support.

- Add `--region` and `--endpoint` options to the relevant `dwave` CLI subcommands: `ping`, `solvers`, `sample`, `upload`. See [\496](https://github.com/dwavesystems/dwave-cloud-client/pull/496).

Upgrade Notes

- To access solvers in a non-default region (na-west-1), you can use the `region` config option and `DWAVE_API_REGION` environment variable.

- `dwave.cloud.config.load_config` used to return some minimal (but arbitrary) set of always-set options (set to `None` if undefined). Now it returns just the options set either in config file, environment, or kwargs.

Bug Fixes

- Fix `dwave.cloud.api.constants.ProblemType` enumeration to include the CQM problem type. See [\491](https://github.com/dwavesystems/dwave-cloud-client/pull/491).


Package versions


dimod==0.10.7
dwave-cloud-client==0.9.2
dwave-greedy==0.2.1
dwave-hybrid==0.6.4
dwave-inspector==0.2.7
dwave-neal==0.5.8
dwave-networkx==0.8.10
dwave-preprocessing==0.3.1.post0
dwave-qbsolv==0.3.3
dwave-system==1.10.0
dwave-tabu==0.4.2
dwavebinarycsp==0.1.3
minorminer==0.2.6
penaltymodel-cache==0.4.4
penaltymodel-lp==0.1.5
penaltymodel==0.16.5
pyqubo==1.0.13

dwave-ocean-sdk[all]
penaltymodel-maxgap==0.5.5
penaltymodel-mip==0.2.5

New Features

- Add Leap hybrid CQM solvers support. See [\489](https://github.com/dwavesystems/dwave-cloud-client/pull/489).

Upgrade Notes

- Sampling on structured solvers of problems with incompatible graph/structure now fails with `ProblemStructureError`. See [\487](https://github.com/dwavesystems/dwave-cloud-client/issues/487).

Bug Fixes

- Make `StructuredSolver.check_problem` faster (15-20%). See [\487](https://github.com/dwavesystems/dwave-cloud-client/issues/487).

New Features

- Default `dwave config create` configuration flow is now simplified to prompt only for essential parameters (at the moment that's only `token`).

Interactive configuration of an extended set of non-essential parameters (i.e. the previous default) is now available via a new flag: `--full`.

See [\304](https://github.com/dwavesystems/dwave-cloud-client/issues/304)

<!-- -->

- A low-level `dwave.cloud.api.client` added to abstract SAPI communication details (like authentication, response decoding, error handling, retries, etc).

- All SAPI requests and responses modelled in `dwave.cloud.api.models.*`. These models are used for data validation and representation.

<!-- -->

- Added model-level interfaces to SAPI resources (in a REST sense), `dwave.cloud.api.resources.Solvers` and `dwave.cloud.api.resources.Problems`.

<!-- -->

- Added mock solver data generators.

<!-- -->

- New layer of exceptions added in `dwave.cloud.api.exceptions`. Base exception `RequestError` subclasses `requests`'s exception and includes raw `.response` object, along with `.error_msg` and `.error_code` returned by SAPI.

<!-- -->

- Begin using reno for changelog.

Upgrade Notes

- `SAPIError` exception is now just an alias for `dwave.cloud.api.exceptions.RequestError`.

<!-- -->

- To configure non-essential parameters such as `endpoint`, `client` and `solver`, configuration create command now has to be called with the `--full` option:

dwave config create --full

<!-- -->

- `dwave.cloud.client` module is now a namespace containing all client subclasses as submodules. You should update your imports accordingly:

dwave.cloud.Client --> dwave.cloud.client.base.Client
dwave.cloud.hybrid.Client --> dwave.cloud.client.hybrid.Client
dwave.cloud.qpu.Client --> dwave.cloud.client.qpu.Client
dwave.cloud.sw.Client --> dwave.cloud.client.sw.Client

For backwards compatibility, old import paths still work, but are deprecated.

Deprecation Notes

- Import paths `dwave.cloud.{hybrid,qpu,sw}.Client` are deprecated and should be replaced with `dwave.cloud.client.{hybrid,qpu,sw}.Client`.

Bug Fixes

- Configured client session creation is sped up by caching user-agent construction (per client). Client session is now created \~200x faster, making it on par with `requests.Session` creation time (\~50us).

<!-- -->

- When a path to a nonexistent config file is provided to `dwave config create`, we'll now happily create that file, instead of failing.

<!-- -->

- Avoid character encoding / charset guessing for speed and [stability](https://github.com/dwavesystems/dwave-cloud-client/pull/476).

New Features

- Add support for Python 3.12

Upgrade Notes

- Drop support for Python 3.7

Bug Fixes

- Fix undefined variables for color maps. See [232](https://github.com/dwavesystems/dwave-networkx/issues/232).