Quantum Shannon Decomposition #6020

uzzzzzzz · 2023-02-25T07:43:14Z

Added Quantum Shannon Decomposition in file in Cirq / cirq-core / cirq / transformers / analytical_decompostions

google-cla · 2023-02-25T07:43:18Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

tanujkhattar

Thank you for opening the PR Uzair. Some high level comments:

Please rename the file quantum_shannon_decomposition to quantum_shannon_decomposition.py
Please add tests using pytest in a new file quantum_shannon_decomposition_test.py in the same directory. Make sure the test coverage checks pass.
Please sign the CLA.

uzzzzzzz · 2023-03-26T23:09:29Z

Thank you for opening the PR Uzair. Some high level comments:

Please rename the file quantum_shannon_decomposition to quantum_shannon_decomposition.py

Please add tests using pytest in a new file quantum_shannon_decomposition_test.py in the same directory. Make sure the test coverage checks pass.

Please sign the CLA.

Made these changes accordingly

uzzzzzzz

Formatted file to address previous test failures

uzzzzzzz

Added testing file and formatted this file

uzzzzzzz · 2023-03-30T21:42:19Z

Made edits for test coverage, formatting, lint

uzzzzzzz · 2023-04-03T22:26:13Z

Made changes with formatting new test functions and fixed error in test function for multiplexed cossin

uzzzzzzz

Changes for QSD

tanujkhattar

This is looking great. Left a round of comments mostly around styling and more robust testing.

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition.py

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition_test.py

tanujkhattar

Left another round of comments. This is looking good overall. We should be able to merge once the comments are resolved.

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition.py

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition_test.py

tanujkhattar

Don't directly import the symbol names. Instead, import the sub-module which the symbol is a part of and then use <submodule_name>.<object_name>.

For example:

from cirq import ops, protocols, linalg

if TYPE_CHECKING:
    import cirq

Note that we have our import cirq under a if TYPE_CHECKING guard so that the entire module is available only for mypy checks. Now, for type checking you can use 'cirq.Qid' instead of Qid. For eg: def quantum_shannon_decomposition(qubits: List['cirq.Qid'], u: np.ndarray)

See other files in analytical decomposition for a reference.

tanujkhattar

LGTM % nits

tanujkhattar · 2023-06-05T21:32:44Z

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition.py

+    import cirq
+
+
+def quantum_shannon_decomposition(qubits: 'List[cirq.Qid]', u: np.ndarray) -> 'cirq.OP_TREE':


The arguments to a method should use the most general type (eg: Sequence instead of List) and the return type should be as specific as possible.

Suggested change

def quantum_shannon_decomposition(qubits: 'List[cirq.Qid]', u: np.ndarray) -> 'cirq.OP_TREE':

def quantum_shannon_decomposition(qubits: Sequence['cirq.Qid'], u: np.ndarray) -> 'cirq.OP_TREE':

tanujkhattar · 2023-06-05T21:46:39Z

cirq-core/cirq/transformers/analytical_decompositions/quantum_shannon_decomposition.py

+    yield from _msb_demuxer(qubits, u1, u2)
+
+
+def _single_qubit_decomposition(qubit: 'cirq.Qid', u: np.ndarray) -> 'cirq.OP_TREE':


As discussed offline, consider updating the return type if internal helpers to cirq.ops.OpTree instead, which should be enough to fix errors in yield from () statements.

Quantum Shannon Decomposition for cirq written by Uzair Faruqui, February 2023 Decomposes an arbitrary (2^n x 2^n) unitary matrix into a set of 1-qubit operations and 2-qubit CNOT gates. Implementation loosely based on this paper: https://arxiv.org/pdf/quant-ph/0406176.pdf

Update descriptions and tidy code

Remove extra whitespace

Changed name of file

Initial creation of test file. Will clean up and edit

Reformat test file

Reformatted file

Correction to argument name of 'test_random_qsd_n_qubit'

Missed a trailing whitespace

Correct argument for test_nth_gray

Changes associated with Yield vs op list

Added type annotations

Added qsd to init

added qsd to init

Checks gates in gate set

…shannon_decomposition_test.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

…shannon_decomposition.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

Remove circuit_1 and circuit_2 from test_qsd_n_qubit

uzzzzzzz requested review from a team, vtomole and cduck as code owners February 25, 2023 07:43

uzzzzzzz requested a review from mpharrigan February 25, 2023 07:43

tanujkhattar requested changes Feb 27, 2023

View reviewed changes

tanujkhattar self-assigned this Feb 27, 2023

CirqBot added the size: M 50< lines changed <250 label Mar 2, 2023

uzzzzzzz requested review from tanujkhattar and removed request for mpharrigan March 27, 2023 15:09

uzzzzzzz commented Mar 28, 2023

View reviewed changes

uzzzzzzz commented Apr 11, 2023

View reviewed changes

tanujkhattar requested changes Apr 19, 2023

View reviewed changes

tanujkhattar reviewed May 8, 2023

View reviewed changes

tanujkhattar approved these changes Jun 5, 2023

View reviewed changes

uzzzzzzz added 10 commits June 5, 2023 15:15

Update quantum_shannon_decomposition

1a9c26f

Update descriptions and tidy code

Update quantum_shannon_decomposition

cf81c13

Remove extra whitespace

Rename quantum_shannon_decomposition to quantum_shannon_decomposition.py

a0b3805

Changed name of file

Create quantum_shannon_decomposition_test.py

28ceb71

Initial creation of test file. Will clean up and edit

Update quantum_shannon_decomposition_test.py

02bf10d

Reformat test file

Update quantum_shannon_decomposition.py

cf41fb2

Reformatted file

Update quantum_shannon_decomposition_test.py

4903871

Correction to argument name of 'test_random_qsd_n_qubit'

Update quantum_shannon_decomposition.py

eed8efa

Missed a trailing whitespace

Update quantum_shannon_decomposition_test.py

363e137

Correct argument for test_nth_gray

uzzzzzzz and others added 28 commits June 5, 2023 15:15

Update quantum_shannon_decomposition_test.py

6da8446

Changes associated with Yield vs op list

Update quantum_shannon_decomposition.py

3d3eb3c

Added type annotations

Update __init__.py

b53bd21

Added qsd to init

Update __init__.py

14cdac5

added qsd to init

Update __init__.py

429dc0c

Update __init__.py

a6ff5df

Update __init__.py

08f8935

Update __init__.py

549b88b

Update quantum_shannon_decomposition_test.py

ee01c94

Checks gates in gate set

Update quantum_shannon_decomposition.py

cbf7253

Update __init__.py

51dd44f

Update cirq-core/cirq/transformers/analytical_decompositions/quantum_…

df0e52c

…shannon_decomposition_test.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

Update cirq-core/cirq/transformers/analytical_decompositions/quantum_…

93060a7

…shannon_decomposition_test.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

Update cirq-core/cirq/transformers/analytical_decompositions/quantum_…

09a4a29

…shannon_decomposition.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

Update cirq-core/cirq/transformers/analytical_decompositions/quantum_…

a6d6aa0

…shannon_decomposition.py Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

Update quantum_shannon_decomposition_test.py

d2e1f95

Update quantum_shannon_decomposition.py

f412256

Update quantum_shannon_decomposition.py

1425e2f

Update quantum_shannon_decomposition.py

93954cb

Update quantum_shannon_decomposition.py

e194580

Update quantum_shannon_decomposition.py

dbeae2a

Update quantum_shannon_decomposition.py

940d906

Update quantum_shannon_decomposition.py

8d6a69e

Update __init__.py

a776753

Update quantum_shannon_decomposition_test.py

00baea8

Update quantum_shannon_decomposition_test.py

43d0c05

Remove circuit_1 and circuit_2 from test_qsd_n_qubit

Update quantum_shannon_decomposition.py

4b91be4

Update quantum_shannon_decomposition.py

dcc0efe

uzzzzzzz force-pushed the master branch from f5c6b01 to dcc0efe Compare June 5, 2023 22:15

tanujkhattar merged commit 1ed879d into quantumlib:master Jun 5, 2023
36 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quantum Shannon Decomposition #6020

Quantum Shannon Decomposition #6020

uzzzzzzz commented Feb 25, 2023

google-cla bot commented Feb 25, 2023

tanujkhattar left a comment

uzzzzzzz commented Mar 26, 2023

uzzzzzzz left a comment

uzzzzzzz left a comment

uzzzzzzz commented Mar 30, 2023

uzzzzzzz commented Apr 3, 2023

uzzzzzzz left a comment

tanujkhattar left a comment

tanujkhattar left a comment

tanujkhattar left a comment

tanujkhattar left a comment

tanujkhattar Jun 5, 2023

tanujkhattar Jun 5, 2023

		import cirq


		def quantum_shannon_decomposition(qubits: 'List[cirq.Qid]', u: np.ndarray) -> 'cirq.OP_TREE':

		yield from _msb_demuxer(qubits, u1, u2)


		def _single_qubit_decomposition(qubit: 'cirq.Qid', u: np.ndarray) -> 'cirq.OP_TREE':

Quantum Shannon Decomposition #6020

Quantum Shannon Decomposition #6020

Conversation

uzzzzzzz commented Feb 25, 2023

google-cla bot commented Feb 25, 2023

tanujkhattar left a comment

Choose a reason for hiding this comment

uzzzzzzz commented Mar 26, 2023

uzzzzzzz left a comment

Choose a reason for hiding this comment

uzzzzzzz left a comment

Choose a reason for hiding this comment

uzzzzzzz commented Mar 30, 2023

uzzzzzzz commented Apr 3, 2023

uzzzzzzz left a comment

Choose a reason for hiding this comment

tanujkhattar left a comment

Choose a reason for hiding this comment

tanujkhattar left a comment

Choose a reason for hiding this comment

tanujkhattar left a comment

Choose a reason for hiding this comment

tanujkhattar left a comment

Choose a reason for hiding this comment

tanujkhattar Jun 5, 2023

Choose a reason for hiding this comment

tanujkhattar Jun 5, 2023

Choose a reason for hiding this comment