Dwave-cloud-client

Bug Fixes

- Previously it was possible for mutually exclusive config options, if all specified on the same level, and depending on the order used, to not be correctly combined with options from a lower level. See [\524](https://github.com/dwavesystems/dwave-cloud-client/issues/524), now fixed.

New Features

- Add `poll_backoff_base` configuration option to control the exponential base of the (problem status) polling schedule. Available as a config file option and `dwave.cloud.Client` keyword argument.

Upgrade Notes

- Make polling schedule denser in the beginning (by lowering the exponential base from `2` to `1.3`), thus enabling much faster answer download for SAPI response times under two minutes.

<!-- -->

- Remove `Client.solvers()` method in favor of `Client.get_solvers()`. It was previously deprecated in `dwave-cloud-client==0.5.0`.

<!-- -->

- Remove `dwave.cloud.computation.Future.error` property in favor of `dwave.cloud.computation.future.exception()` method. The property was previously deprecated in `dwave-cloud-client==0.7.3`.

<!-- -->

- Remove `dwave.cloud.computation.Future.{eta_min,eta_max}`. These properties were previously deprecated in `dwave-cloud-client==0.8.5` when the underlying SAPI feature/field was removed.

<!-- -->

- Remove `dwave.cloud.computation.Future.occurrences` alias in favor of `dwave.cloud.computation.Future.num_occurrences` property. The alias was previously deprecated in `dwave-cloud-client==0.8.0`.

<!-- -->

- CLI: use of `-c` for `--config-file` has been deprecated since `dwave-cloud-client==0.8.5` in favor of `-f`, and the option is now removed in 0.10.0. Use `--config-file` or `-f` instead.

<!-- -->

- Remove support for dimod 0.8.x. Upgrade dimod to 0.9.0+.

<!-- -->

- Upgrade your python to 3.7+. We no longer support python 3.6 and below.

Deprecation Notes

- Alias keys (`samples` and `occurrences`) in `dwave.cloud.computation.Future.result()`-returned dictionary are deprecated since `dwave-cloud-client==0.8.0` and will be removed in `dwave-cloud-client==0.12.0`.

<!-- -->

- Positional arguments to `dwave.cloud.Client` constructor are deprecated since `dwave-cloud-client==0.10.0` and will be removed in `dwave-cloud-client==0.12.0`. Use keywords arguments instead.

Bug Fixes

- 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 `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`.

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).

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).