This repository has been archived by the owner on Dec 7, 2021. It is now read-only.
Properly deprecate quadratic program ising converter classes #1178
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
In qiskit-community#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy
mtreinish
added
priority: high
Changelog: Deprecation
mtreinish
requested review from
manoelmarques,
stefan-woerner and
woodsp-ibm
as code owners
Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back.
This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow.
…fix-breaking-change
|
I've tested this with all the optimization tutorials locally and it works for me (given the critical nature of this it's probably good for someone else to double check too) |
manoelmarques
approved these changes
Aug 7, 2020
manoelmarques
added a commit
to manoelmarques/qiskit-aqua
that referenced
this pull request
Aug 7, 2020
…community#1178) * Properly deprecate quadratic program ising converters In qiskit-community#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy * Fix typo * Remove broken loop * Add missing print methods Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back. * add unit test * Add print_details to SummedOp This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow. * fix lint * fix docstring Co-authored-by: Manoel Marques <manoel.marques@ibm.com>
pbark
pushed a commit
to pbark/qiskit-aqua
that referenced
this pull request
Sep 16, 2020
…community#1178) * Properly deprecate quadratic program ising converters In qiskit-community#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy * Fix typo * Remove broken loop * Add missing print methods Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back. * add unit test * Add print_details to SummedOp This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow. * fix lint * fix docstring Co-authored-by: Manoel Marques <manoel.marques@ibm.com>
mtreinish
added a commit
to mtreinish/qiskit-core
that referenced
this pull request
Nov 20, 2020
…community/qiskit-aqua#1178) * Properly deprecate quadratic program ising converters In qiskit-community/qiskit-aqua#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy * Fix typo * Remove broken loop * Add missing print methods Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back. * add unit test * Add print_details to SummedOp This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow. * fix lint * fix docstring Co-authored-by: Manoel Marques <manoel.marques@ibm.com>
manoelmarques
added a commit
to manoelmarques/qiskit-terra
that referenced
this pull request
Dec 2, 2020
…community/qiskit-aqua#1178) * Properly deprecate quadratic program ising converters In qiskit-community/qiskit-aqua#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy * Fix typo * Remove broken loop * Add missing print methods Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back. * add unit test * Add print_details to SummedOp This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow. * fix lint * fix docstring Co-authored-by: Manoel Marques <manoel.marques@ibm.com>
manoelmarques
added a commit
to qiskit-community/qiskit-optimization
that referenced
this pull request
Jan 14, 2021
…community/qiskit-aqua#1178) * Properly deprecate quadratic program ising converters In qiskit-community/qiskit-aqua#1061 the ising converter classes were removed without a deprecation period and then backported to the stable branch. This is a violation of both the Qiskit deprecation policy [1] and the Qiskit stable branch policy [2] and should not have been merged like that. This is preventing the Qiskit metapackage 0.20.0 from being released because the tutorials as written today do not work with aqua 0.7.4 because of this breaking change. It should have been deprecated first for an appropriate period to give users a chance to adjust their code and then removed. During this period the tutorial could also be updated. This also should never have been backported to stable since users expect a stable point release to just contain bugfixes removals and deprecations should not be part of stable releases. This commit adds back the removed classes and deprecates them, this will need to be backported and released as 0.7.5. While normally this deprecation would not be allowed under the backport policy it is necessary here because we already released a breaking change. [1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy [2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy * Fix typo * Remove broken loop * Add missing print methods Running through the tutorials there are more methods that have been removed that needed to go through a proper deprecation, this commit starts adding them back. There is still print_details() that needs to be added back. * add unit test * Add print_details to SummedOp This is needed for backwards compat with the optimziation code which used to return a legacy WeightedPauliOp object. 'print_details()' is used in the tutorials on the output from conversion so a deprecated method is added to add this funcionality to gracefully move users over to the new workflow. * fix lint * fix docstring Co-authored-by: Manoel Marques <manoel.marques@ibm.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
In #1061 the ising converter classes were removed without a deprecation
period and then backported to the stable branch. This is a violation of
both the Qiskit deprecation policy [1] and the Qiskit stable branch
policy [2] and should not have been merged like that. This is preventing
the Qiskit metapackage 0.20.0 from being released because the tutorials
as written today do not work with aqua 0.7.4 because of this breaking
change. It should have been deprecated first for an appropriate period
to give users a chance to adjust their code and then removed. During
this period the tutorial could also be updated. This also should never
have been backported to stable since users expect a stable point release
to just contain bugfixes removals and deprecations should not be part of
stable releases. This commit adds back the removed classes and deprecates
them, this will need to be backported and released as 0.7.5. While
normally this deprecation would not be allowed under the backport policy
it is necessary here because we already released a breaking change.
Details and comments
[1] https://qiskit.org/documentation/contributing_to_qiskit.html#deprecation-policy
[2] https://qiskit.org/documentation/contributing_to_qiskit.html#stable-branch-policy