amazon-braket / amazon-braket/amazon-braket-sdk-python

Better error message when using local detuning without experimental capabilities enabled

Open
#1,070 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
373
Forks
195
Avg merge
4d 15h
Merged PRs (30d)
8

Description

**What did you find confusing? Please describe.**
If local detuning is not enabled, the `local_detuning_parameters` is `None`, and [the discretization is not performed](https://github.com/amazon-braket/amazon-braket-sdk-python/blob/58593bcb4338f51615d2410aa72244b59399fcb1/src/braket/ahs/local_detuning.py#L143). When running a program with local detuning, one would get error `All driving and local detuning time series must cover the same time span. (type=value_error)"` because discretization is done in driving but not in local detuning. However, the fundamental reason is that local detuning is not enabled. The current error message is confusing and not actionable.

**Describe how documentation can be improved**
Inform about the experimental capabilities, rather than only throwing error related discretization at a later stage.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.