Improve deprecation of unit and duration #13247
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The unit and duration attributes of QuantumCircuit and Instruction were introduced in Qiskit#13224 however the way the PR went about this was a bit to abbreviated and it had several downsides. The most noticable was that it introduced a significant runtime regression as the rust internals were accessing the deprecated getter. This is fixed so that the rust code doesn't try to access any deprecated attributes. However, more importantly there were several edge cases not accoutned for in the PR. Mainly, DAGCircuit's matching attribute were not deprecated, but then also specific use cases of the attributes were not addressed. The primary driver of the per instruction duration and unit were the timeline visualization which didn't have a method to function without these data attributes. This commit addresses this by adding a new target argument that is used to provide a backend's target which is the source of truth for durations in a post unit/duration `Instruction`. The other notable edge case is the `Delay` instruction which will need to retain the duration and unit attributes as the fields are integral for that instruction. The `Delay` is updated to handle them explicitly outside of the `Instrution` data model to avoid complications around the deprecation.
mtreinish
added
Changelog: Deprecation
mtreinish
added
the
Changelog: New Feature
Pull Request Test Coverage Report for Build 11218352731Details
💛 - Coveralls |
ElePT
reviewed
Oct 1, 2024
releasenotes/notes/deprecate-unit-duration-48b76c957bac5691.yaml
Outdated
Show resolved
Hide resolved
ElePT
reviewed
Oct 1, 2024
releasenotes/notes/deprecate-unit-duration-48b76c957bac5691.yaml
Outdated
Show resolved
Hide resolved
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
ElePT
reviewed
Oct 7, 2024
There was a problem hiding this comment.
Mostly LGTM, just missing running black to fix CI. One comment is that it might be nicer to point to alternatives in the deprecation messages that say that unit/duration are deprecated. Something like "If this information is required for transpilation, it will be extracted from the target directly".
This was referenced Dec 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The unit and duration attributes of QuantumCircuit and Instruction were introduced in #13224 however the way the PR went about this was a bit to abbreviated and it had several downsides. The most noticable was that it introduced a significant runtime regression as the rust internals were accessing the deprecated getter. This is fixed so that the rust code doesn't try to access any deprecated attributes. However, more importantly there were several edge cases not accoutned for in the PR. Mainly, DAGCircuit's matching attribute were not deprecated, but then also specific use cases of the attributes were not addressed. The primary driver of the per instruction duration and unit were the timeline visualization which didn't have a method to function without these data attributes. This commit addresses this by adding a new target argument that is used to provide a backend's target which is the source of truth for durations in a post unit/duration
Instruction. The other notable edge case is theDelayinstruction which will need to retain the duration and unit attributes as the fields are integral for that instruction. TheDelayis updated to handle them explicitly outside of theInstrutiondata model to avoid complications around the deprecation.Details and comments