Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GaussianPulse for consistent parameter validation results whether validation occurs during or after construction. #8151

Merged
merged 10 commits into from
Jun 13, 2022
Merged

Update GaussianPulse for consistent parameter validation results whether validation occurs during or after construction. #8151

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
da767ad
Clarifying that qiskit.pulse.library.ParametricPulse.validate_paramet…
upsideon Jun 8, 2022
dcb05cf
Adding release note for documentation update.
upsideon Jun 8, 2022
e6876dc
Fixing release note.
upsideon Jun 8, 2022
81df307
Making GaussianSquare pulse validation consistent before and after co…
upsideon Jun 10, 2022
a0ce817
Removing old release note.
upsideon Jun 10, 2022
e7038be
Adding a new release note.
upsideon Jun 10, 2022
916d303
Merge branch 'main' into update-parametric-pulse-validate-parameters-…
upsideon Jun 12, 2022
f879f2b
Make Sphinx link anonymous
jakelishman Jun 13, 2022
b7ec5ae
Include issue link in regression test
jakelishman Jun 13, 2022
fb24525
Merge remote-tracking branch 'ibm/main' into update-parametric-pulse-…
jakelishman Jun 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion qiskit/pulse/library/parametric_pulses.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ def get_waveform(self) -> Waveform:
@abstractmethod
def validate_parameters(self) -> None:
"""
Validate parameters.
Validate parameters. This is an internal check for subclasses and should
not be interpreted or used as part of the user-facing API.

Raises:
PulseError: If the parameters passed are not valid.
Expand Down
8 changes: 8 additions & 0 deletions releasenotes/notes/update-parametric-pulse-documentation-b1fd3c39064aabe5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
fixes:
- |
Additional documentation has been added to
:meth:`~.pulse.library.ParametricPulse.validate_parameters`
which clarifies that this method serves only as an internal check for subclasses
and should not be interpreted or used as a part of the user-facing API. Refer to
`#7882 <https://github.com/Qiskit/qiskit-terra/issues/7882>` for more details.