-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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.
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
Deprecate qiskit/transpiler/synthesis and move to qiskit/synthesis #11426
Deprecate qiskit/transpiler/synthesis and move to qiskit/synthesis #11426
Conversation
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7614139856Warning: This coverage report may be inaccurate.We've detected an issue with your CI configuration that might affect the accuracy of this pull request's coverage report.
💛 - Coveralls |
Like the deprecation of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I only have small comments on the docs, otherwise everything LGTM!
qiskit/synthesis/__init__.py
Outdated
Unitary Synthesis | ||
================= | ||
|
||
The Approximate Quantum Compiler is available here: :mod:qiskit.synthesis.unitary.aqc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Approximate Quantum Compiler is available here: :mod:qiskit.synthesis.unitary.aqc | |
The Approximate Quantum Compiler is available here: :mod:`qiskit.synthesis.unitary.aqc` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently the AQC docs live under the builtin transpiler plugins as only object. Would it make sense to put them with the Solovay Kitaev docs? I also don't quite understand the "builtin transpiler plugin" page, aren't there a lot more builtin plugins than AQC?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Cryoris - thanks for the detailed review!
I think that the AQCSynthesisPlugin
also appears now with the other synthesis plugins here:
https://docs.quantum.ibm.com/api/qiskit/transpiler_passes#synthesis
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, let's update the docs structure separately 👍🏻
…11426) * deprecate transpiler/synthesis/graysynth.py * style * style * move aqc_plugin to qiskit/transpiler/passes/synthesis * remove code from qiskit/transpiler/synthesis/aqc/aqc_plugin.py * copy qiskit/transpiler/synthesis/aqc to qiskit/synthesis/unitary * move tests from test/python/transpiler/aqc to test/python/synthesis/aqc * update imports in aqc_plugin * add deprecation warning to AQC module * handle cyclic imports * handle cyclic imports * update link in docs * update init in qiskit/transpiler/synthesis/aqc * style * temporary remove deprecation warning test * remove files from qiskit/transpiler/synthesis/aqc * update link in test * add release notes * update docs * update docs/apidocs/synthesis_aqc.rst * add deprecations to qiskit/transpiler/synthesis/__init__.py * fix link * improve docs following review * update docs * add aqc to synthesis docs after review * update qiskit/transpiler/synthesis/aqc/__init__.py after review * update pending deprecation to deprecation in release notes * handle cyclic imports * update qiskit/synthesis docs following docs error * another attempt to add AQC to synthesis docs * another attempt to add AQC to the docs * Revert "another attempt to add AQC to the docs" This reverts commit 25f93ca. * Revert "another attempt to add AQC to synthesis docs" This reverts commit 9e87164. * add a deprecation test for AQC * minor (cherry picked from commit 937ca5b) # Conflicts: # pyproject.toml # qiskit/synthesis/__init__.py # qiskit/transpiler/passes/synthesis/aqc_plugin.py
…iskit#11426) * deprecate transpiler/synthesis/graysynth.py * style * style * move aqc_plugin to qiskit/transpiler/passes/synthesis * remove code from qiskit/transpiler/synthesis/aqc/aqc_plugin.py * copy qiskit/transpiler/synthesis/aqc to qiskit/synthesis/unitary * move tests from test/python/transpiler/aqc to test/python/synthesis/aqc * update imports in aqc_plugin * add deprecation warning to AQC module * handle cyclic imports * handle cyclic imports * update link in docs * update init in qiskit/transpiler/synthesis/aqc * style * temporary remove deprecation warning test * remove files from qiskit/transpiler/synthesis/aqc * update link in test * add release notes * update docs * update docs/apidocs/synthesis_aqc.rst * add deprecations to qiskit/transpiler/synthesis/__init__.py * fix link * improve docs following review * update docs * add aqc to synthesis docs after review * update qiskit/transpiler/synthesis/aqc/__init__.py after review * update pending deprecation to deprecation in release notes * handle cyclic imports * update qiskit/synthesis docs following docs error * another attempt to add AQC to synthesis docs * another attempt to add AQC to the docs * Revert "another attempt to add AQC to the docs" This reverts commit 25f93ca. * Revert "another attempt to add AQC to synthesis docs" This reverts commit 9e87164. * add a deprecation test for AQC * minor
…iskit#11426) * deprecate transpiler/synthesis/graysynth.py * style * style * move aqc_plugin to qiskit/transpiler/passes/synthesis * remove code from qiskit/transpiler/synthesis/aqc/aqc_plugin.py * copy qiskit/transpiler/synthesis/aqc to qiskit/synthesis/unitary * move tests from test/python/transpiler/aqc to test/python/synthesis/aqc * update imports in aqc_plugin * add deprecation warning to AQC module * handle cyclic imports * handle cyclic imports * update link in docs * update init in qiskit/transpiler/synthesis/aqc * style * temporary remove deprecation warning test * remove files from qiskit/transpiler/synthesis/aqc * update link in test * add release notes * update docs * update docs/apidocs/synthesis_aqc.rst * add deprecations to qiskit/transpiler/synthesis/__init__.py * fix link * improve docs following review * update docs * add aqc to synthesis docs after review * update qiskit/transpiler/synthesis/aqc/__init__.py after review * update pending deprecation to deprecation in release notes * handle cyclic imports * update qiskit/synthesis docs following docs error * another attempt to add AQC to synthesis docs * another attempt to add AQC to the docs * Revert "another attempt to add AQC to the docs" This reverts commit 25f93ca. * Revert "another attempt to add AQC to synthesis docs" This reverts commit 9e87164. * add a deprecation test for AQC * minor Co-authored-by: Shelly Garion <[email protected]>
@Mergifyio backport stable/0.46 |
✅ Backports have been created
|
…11426) * deprecate transpiler/synthesis/graysynth.py * style * style * move aqc_plugin to qiskit/transpiler/passes/synthesis * remove code from qiskit/transpiler/synthesis/aqc/aqc_plugin.py * copy qiskit/transpiler/synthesis/aqc to qiskit/synthesis/unitary * move tests from test/python/transpiler/aqc to test/python/synthesis/aqc * update imports in aqc_plugin * add deprecation warning to AQC module * handle cyclic imports * handle cyclic imports * update link in docs * update init in qiskit/transpiler/synthesis/aqc * style * temporary remove deprecation warning test * remove files from qiskit/transpiler/synthesis/aqc * update link in test * add release notes * update docs * update docs/apidocs/synthesis_aqc.rst * add deprecations to qiskit/transpiler/synthesis/__init__.py * fix link * improve docs following review * update docs * add aqc to synthesis docs after review * update qiskit/transpiler/synthesis/aqc/__init__.py after review * update pending deprecation to deprecation in release notes * handle cyclic imports * update qiskit/synthesis docs following docs error * another attempt to add AQC to synthesis docs * another attempt to add AQC to the docs * Revert "another attempt to add AQC to the docs" This reverts commit 25f93ca. * Revert "another attempt to add AQC to synthesis docs" This reverts commit 9e87164. * add a deprecation test for AQC * minor (cherry picked from commit 937ca5b) # Conflicts: # pyproject.toml # qiskit/synthesis/__init__.py # qiskit/transpiler/passes/synthesis/aqc_plugin.py
…ackport #11426) (#11624) * Deprecate qiskit/transpiler/synthesis and move to qiskit/synthesis (#11426) * deprecate transpiler/synthesis/graysynth.py * style * style * move aqc_plugin to qiskit/transpiler/passes/synthesis * remove code from qiskit/transpiler/synthesis/aqc/aqc_plugin.py * copy qiskit/transpiler/synthesis/aqc to qiskit/synthesis/unitary * move tests from test/python/transpiler/aqc to test/python/synthesis/aqc * update imports in aqc_plugin * add deprecation warning to AQC module * handle cyclic imports * handle cyclic imports * update link in docs * update init in qiskit/transpiler/synthesis/aqc * style * temporary remove deprecation warning test * remove files from qiskit/transpiler/synthesis/aqc * update link in test * add release notes * update docs * update docs/apidocs/synthesis_aqc.rst * add deprecations to qiskit/transpiler/synthesis/__init__.py * fix link * improve docs following review * update docs * add aqc to synthesis docs after review * update qiskit/transpiler/synthesis/aqc/__init__.py after review * update pending deprecation to deprecation in release notes * handle cyclic imports * update qiskit/synthesis docs following docs error * another attempt to add AQC to synthesis docs * another attempt to add AQC to the docs * Revert "another attempt to add AQC to the docs" This reverts commit 25f93ca. * Revert "another attempt to add AQC to synthesis docs" This reverts commit 9e87164. * add a deprecation test for AQC * minor (cherry picked from commit 937ca5b) # Conflicts: # pyproject.toml # qiskit/synthesis/__init__.py # qiskit/transpiler/passes/synthesis/aqc_plugin.py * Fix merge conflicts * add pylint disable cyclic import * remove Optimizer from aqc * Revert "remove Optimizer from aqc" This reverts commit 63d1ca2. * handle cyclic imoports in AQC * fix plugin entry point --------- Co-authored-by: Shelly Garion <[email protected]> Co-authored-by: Julien Gacon <[email protected]> Co-authored-by: Shelly Garion <[email protected]>
Summary
co-authored by @prakharb10
This PR replaces PR #11079 of @prakharb10 which was not completed.
Deprecate
qiskit/transpiler/synthesis
and move files toqiskit/synthesis
qiskit/transpiler/synthesis/aqc
moved toqiskit/synthesis/unitary/aqc
(except ofaqc_plugin
)qiskit/transpiler/synthesis/aqc/aqc_plugin
moved toqiskit/transpiler/passes/synthesis
qiskit/transpiler/synthesis/graysynth
moved toqiskit/synthesis/linear_phase/synth_cnot_phase_aam
qiskit/transpiler/synthesis/cnot_synth
moved toqiskit/synthesis/linear/synth_cnot_count_full_pmh
Details and comments
Close #10819
Also partly handles the following issues:
#4311
#4699
#9667
#7986