Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers #4722

tanujkhattar · 2021-12-03T11:10:25Z

Background

Currently, all optimizers in cirq are present in a single directory -- cirq-core/cirq/optimizers/*. It contains not only transformers (which transform/optimize circuits) but also utility methods like analytical decompositions of matrices into target operations.
Also, after #4708 and #4692; almost all existing optimizers would need to be re-implemented to

Use the newly added moment preserving primitives
Not mutate the input circuits (as proposed in the new transformer API https://tinyurl.com/cirq-circuit-transformers-api)

Proposal

The proposal is to

Create a new cirq/transformers/
Move decomposition utilities from cirq/optimizers to sub directories under cirq/transformers/
Deprecate the existing transformers in cirq/optimizers in favor of new implementations using the moment preserving primitives and following the new non-mutating API, which would be added at top-level in cirq/transformers/.

cirq-core/cirq/transformers/heuristic_decompositions/*

gate_tabulation.py and corresponding math_utils.py (see Bring GateTabulation out of cirq-google to cirq-core #4461)
numerical optimization based approximate compilation proposed in Compiling: heuristic for compiling 2 qubits gates to the native gateset #4362

Note: Heuristic compilation is an active area of research and is an important primitive for compensating for actual gate angles calibrated via techniques like Floquet / XEB calibration. We can expect more primitives to get added here in future.

cirq-core/cirq/transformers/analytical_decompositions/*

clifford_decomposition.py
controlled_gate_decomposition.py
cphase_to_fsim.py
decompositions.py --> single_qubit_decompositions.py
three_qubit_decomposition.py
two_qubit_decompositions.py --> two_qubit_to_cz.py
two_qubit_state_preparation.py
two_qubit_to_fsim.py
two_qubit_to_sqrt_iswap.py

Newer versions of the following existing transformers in `cirq-core/cirq/optimizers/` will get added in `cirq-core/cirq/transformers/`

Deprecation Plan

For analytical decomposers, the existing files will simply get moved from cirq/optimizers/* to cirq/transformers/analytical_decompositions. Existing methods will go through a deprecation cycle and the change should not impact usages of the form cirq.<method>.
For existing transformers -- it would be a large breaking change to deprecate all existing transformers in the favour of newer moment-preserving non mutating versions but this is unavoidable and need to happen as part of the larger effort on redesigning transformers. The existing transformers can be left around for a few versions for the user code to get updated since the new versions would be implemented independently of existing versions.

cc @MichaelBroughton @dstrain115 @dabacon Thoughts?
Part of roadmap #3238

The text was updated successfully, but these errors were encountered:

MichaelBroughton · 2021-12-07T18:38:16Z

I like the looks of this plan.

Create a new cirq/transformers/
Move decomposition utilities from cirq/optimizers to sub directories under cirq/transformers/
Deprecate the existing transformers in cirq/optimizers in favor of new implementations using the moment preserving primitives and following the new non-mutating API, which would be added at top-level in cirq/transformers/.

Where possible, I would be in favor of doing this one module at a time and not all at once so multiple people can work on this at once and also take the opportunity for the rewrite/cleanup of their module one module at a time.

dstrain115 · 2021-12-09T14:42:20Z

This is fine with me, but we should announce this broadly. We already mentioned at a cirq cync, but it might be worth an email to cirq-announce. We could maybe combine this with a forward-looking "What's changing in cirq 1.0" email to all of cirq-announce that explains all the changes we are planning to do.

…lytical_decompositions/two_qubit_state_preparation.py` (#4762) Part of #4722 This is safe to do without going through a deprecation cycle because `optimizers/two_qubit_state_preparation.py ` was recently introduced (#4707) in the current dev version and hasn't been released yet.

…rq/transformers/analytical_decompositions/` (#4785) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - clifford_decomposition.py - controlled_gate_decomposition.py - cphase_to_fsim.py Part of #4722

…positions/single_qubit_decompositions.py` (#4799) Moves the following file from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - decompositions.py --> single_qubit_decompositions.py Part of #4722

…rs/analytical_decompositions` (#4809) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - two_qubit_decompositions.py --> two_qubit_to_cz.py - two_qubit_to_fsim.py - two_qubit_to_sqrt_iswap.py - three_qubit_decomposition.py Part of #4722

…ers/*` (#4813) After the recent migration of decompositions from `optimizers/*` to `transformers/analytical_decompositions/*`, the following user code breaks despite deprecating the moved submodules. ```python from cirq import optimizers from cirq.optimizers import two_qubit_decompositions _ = two_qubit_decompositions.two_qubit_matrix_to_operations(mat) # This is deprecated correctly and will emit a deprecation warning but work as expected. _ = optimizers.two_qubit_matrix_to_operations(mat) # This would currently break since the optimizers module is neither deprecated nor has these top-level objects available ``` This PR adds a fix to temporarily unbreak the above user code by importing top-level objects from `transformers/analytical_decompositions/*` to `optimizers/*`. Once all files from `optimizers/*` have been moved to `transformers/`, we will deprecate the `optimizers/` module, and then this hack can be reverted and the correct deprecation warnings will be emitted when using `optimizers.two_qubit_matrix_to_operations` (and other top-level objects). Part of #4722

pavoljuhas · 2022-01-12T18:47:32Z

Picking up expand_composite.py. Please let me know if someone already works on it.

…lytical_decompositions/two_qubit_state_preparation.py` (quantumlib#4762) Part of quantumlib#4722 This is safe to do without going through a deprecation cycle because `optimizers/two_qubit_state_preparation.py ` was recently introduced (quantumlib#4707) in the current dev version and hasn't been released yet.

…rq/transformers/analytical_decompositions/` (quantumlib#4785) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - clifford_decomposition.py - controlled_gate_decomposition.py - cphase_to_fsim.py Part of quantumlib#4722

…positions/single_qubit_decompositions.py` (quantumlib#4799) Moves the following file from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - decompositions.py --> single_qubit_decompositions.py Part of quantumlib#4722

…rs/analytical_decompositions` (quantumlib#4809) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - two_qubit_decompositions.py --> two_qubit_to_cz.py - two_qubit_to_fsim.py - two_qubit_to_sqrt_iswap.py - three_qubit_decomposition.py Part of quantumlib#4722

anonymousr007 · 2022-03-12T20:52:45Z

Hi all, I would like to help with this issue, Can anyone please tell me further details?

vtomole · 2022-03-12T21:30:36Z

From the check list, it seems like the only thing left to close this is #4362, but @Ashalynd is already working on it.

tanujkhattar · 2022-03-12T22:02:19Z

The task which is still open is about adding a new transformer and not migrating any existing transformer, so I'm going to remove the task from the list and the issue will be tracked independently.

This particular issue is about migration of all existing optimizers, which has been completed and I'll therefore go ahead and close the issue.

…lytical_decompositions/two_qubit_state_preparation.py` (quantumlib#4762) Part of quantumlib#4722 This is safe to do without going through a deprecation cycle because `optimizers/two_qubit_state_preparation.py ` was recently introduced (quantumlib#4707) in the current dev version and hasn't been released yet.

…rq/transformers/analytical_decompositions/` (quantumlib#4785) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - clifford_decomposition.py - controlled_gate_decomposition.py - cphase_to_fsim.py Part of quantumlib#4722

…positions/single_qubit_decompositions.py` (quantumlib#4799) Moves the following file from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - decompositions.py --> single_qubit_decompositions.py Part of quantumlib#4722

…rs/analytical_decompositions` (quantumlib#4809) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - two_qubit_decompositions.py --> two_qubit_to_cz.py - two_qubit_to_fsim.py - two_qubit_to_sqrt_iswap.py - three_qubit_decomposition.py Part of quantumlib#4722

…ers/*` (quantumlib#4813) After the recent migration of decompositions from `optimizers/*` to `transformers/analytical_decompositions/*`, the following user code breaks despite deprecating the moved submodules. ```python from cirq import optimizers from cirq.optimizers import two_qubit_decompositions _ = two_qubit_decompositions.two_qubit_matrix_to_operations(mat) # This is deprecated correctly and will emit a deprecation warning but work as expected. _ = optimizers.two_qubit_matrix_to_operations(mat) # This would currently break since the optimizers module is neither deprecated nor has these top-level objects available ``` This PR adds a fix to temporarily unbreak the above user code by importing top-level objects from `transformers/analytical_decompositions/*` to `optimizers/*`. Once all files from `optimizers/*` have been moved to `transformers/`, we will deprecate the `optimizers/` module, and then this hack can be reverted and the correct deprecation warnings will be emitted when using `optimizers.two_qubit_matrix_to_operations` (and other top-level objects). Part of quantumlib#4722

…ronizeTerminalMeasurements` (quantumlib#4911) - Part of quantumlib#4722 - Follows the new Transformer API quantumlib#4483 - Supports no compile tags NoCompile Tag for optimizers quantumlib#4253 - Fixes quantumlib#4907

…lytical_decompositions/two_qubit_state_preparation.py` (quantumlib#4762) Part of quantumlib#4722 This is safe to do without going through a deprecation cycle because `optimizers/two_qubit_state_preparation.py ` was recently introduced (quantumlib#4707) in the current dev version and hasn't been released yet.

…rq/transformers/analytical_decompositions/` (quantumlib#4785) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - clifford_decomposition.py - controlled_gate_decomposition.py - cphase_to_fsim.py Part of quantumlib#4722

…positions/single_qubit_decompositions.py` (quantumlib#4799) Moves the following file from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - decompositions.py --> single_qubit_decompositions.py Part of quantumlib#4722

…rs/analytical_decompositions` (quantumlib#4809) Moves the following files from `cirq/optimizers/` to `cirq/transformers/analytical_decompositions/` using `deprecated_submodule`: - two_qubit_decompositions.py --> two_qubit_to_cz.py - two_qubit_to_fsim.py - two_qubit_to_sqrt_iswap.py - three_qubit_decomposition.py Part of quantumlib#4722

…ers/*` (quantumlib#4813) After the recent migration of decompositions from `optimizers/*` to `transformers/analytical_decompositions/*`, the following user code breaks despite deprecating the moved submodules. ```python from cirq import optimizers from cirq.optimizers import two_qubit_decompositions _ = two_qubit_decompositions.two_qubit_matrix_to_operations(mat) # This is deprecated correctly and will emit a deprecation warning but work as expected. _ = optimizers.two_qubit_matrix_to_operations(mat) # This would currently break since the optimizers module is neither deprecated nor has these top-level objects available ``` This PR adds a fix to temporarily unbreak the above user code by importing top-level objects from `transformers/analytical_decompositions/*` to `optimizers/*`. Once all files from `optimizers/*` have been moved to `transformers/`, we will deprecate the `optimizers/` module, and then this hack can be reverted and the correct deprecation warnings will be emitted when using `optimizers.two_qubit_matrix_to_operations` (and other top-level objects). Part of quantumlib#4722

…ronizeTerminalMeasurements` (quantumlib#4911) - Part of quantumlib#4722 - Follows the new Transformer API quantumlib#4483 - Supports no compile tags NoCompile Tag for optimizers quantumlib#4253 - Fixes quantumlib#4907

tanujkhattar added kind/design-issue A conversation around design area/transformers triage/discuss Needs decision / discussion, bring these up during Cirq Cynque labels Dec 3, 2021

MichaelBroughton added triage/accepted A consensus emerged that this bug report, feature request, or other action should be worked on help wanted and removed triage/discuss Needs decision / discussion, bring these up during Cirq Cynque labels Dec 8, 2021

MichaelBroughton mentioned this issue Dec 9, 2021

Importing cirq affects the behavior of importlib_metadata #4729

Closed

tanujkhattar mentioned this issue Dec 9, 2021

Bring GateTabulation out of cirq-google to cirq-core #4461

Closed

tanujkhattar changed the title ~~Organization of cirq-core/optimizers~~ Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers Dec 13, 2021

tanujkhattar mentioned this issue Dec 29, 2021

Part-2: Move analytical decompositions from cirq/optimizers/ to cirq/transformers/analytical_decompositions/ #4785

Merged

tanujkhattar mentioned this issue Jan 4, 2022

Move optimizers/decompositions.py to transformers/analytical_decompositions/single_qubit_decompositions.py #4799

Merged

tanujkhattar mentioned this issue Jan 6, 2022

Move two/three qubit decompositions from optimizers/ to transformers/analytical_decompositions #4809

Merged

tanujkhattar mentioned this issue Jan 7, 2022

Import transformers/analytical_decompositions/* methods in optimizers/* #4813

Merged

tanujkhattar self-assigned this Jan 14, 2022

MichaelBroughton mentioned this issue Jan 19, 2022

[cirq-google] Proposal: Remove XmonDevice, Bristlecone, Foxtail and rename optimize_for_xmon. #4856

Closed

tanujkhattar closed this as completed Mar 12, 2022

This was referenced Mar 14, 2022

Refactor CircuitDag and use it to improve Merge* optimizers. #4494

Closed

[WIP] NoCompile Tag for optimizers #4298

Closed

This was referenced Mar 22, 2022

[AQT] Vendor Transformer adoption #5128

Closed

[IONQ] Vendor Transformer adoption #5129

Closed

[Pasqal] Vendor Transformer Adoption #5130

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers #4722

Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers #4722

tanujkhattar commented Dec 3, 2021 •

edited

Loading

MichaelBroughton commented Dec 7, 2021

dstrain115 commented Dec 9, 2021

pavoljuhas commented Jan 12, 2022

anonymousr007 commented Mar 12, 2022

vtomole commented Mar 12, 2022

tanujkhattar commented Mar 12, 2022

Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers #4722

Organization (and deprecation) of cirq-core/optimizers in cirq-core/transformers #4722

Comments

tanujkhattar commented Dec 3, 2021 • edited Loading

Background

Proposal

cirq-core/cirq/transformers/heuristic_decompositions/*

cirq-core/cirq/transformers/analytical_decompositions/*

Newer versions of the following existing transformers in cirq-core/cirq/optimizers/* will get added in cirq-core/cirq/transformers/*

Deprecation Plan

MichaelBroughton commented Dec 7, 2021

dstrain115 commented Dec 9, 2021

pavoljuhas commented Jan 12, 2022

anonymousr007 commented Mar 12, 2022

vtomole commented Mar 12, 2022

tanujkhattar commented Mar 12, 2022

tanujkhattar commented Dec 3, 2021 •

edited

Loading

Newer versions of the following existing transformers in `cirq-core/cirq/optimizers/` will get added in `cirq-core/cirq/transformers/`