Use GoogleCZTargetGateset; add device gateset as additional gates in target gatesets #5765

verult · 2022-07-14T01:41:16Z

GridDevice target gateset generation logic now matches all required gates for a particular gateset, rather than just the 2q gate.
In target gatesets that support additional_gates, it's set to all gates in a device's gateset other than required gates in the target gateset, so that device gates are not decomposed during circuit transformation.

First commit is from #5744

dstrain115

LGTM with a minor nit once the first 'GoogleCZTargetGateset' PR is in.

dstrain115 · 2022-07-15T21:51:19Z

cirq-google/cirq_google/devices/grid_device.py

-COUPLER_PULSE_GATE_FAMILY = cirq.GateFamily(experimental_ops.CouplerPulse)
-MEASUREMENT_GATE_FAMILY = cirq.GateFamily(cirq.MeasurementGate)
-WAIT_GATE_FAMILY = cirq.GateFamily(cirq.WaitGate)
+_SYC_GATE_FAMILY = cirq.GateFamily(ops.SYC)


Is it worth a line comment to explain that these are needed to specify compilation targets when constructing a GridDevice from device specification?

I'm leaning towards no because they can be reused for different purposes in the future. Different gate families here are actually used for different things (serializing to DeviceSpecification, specifying target gates of a CompilationTargetGateset, or deserializing to a gateset).

I'll move FSIM gate families into a separate section though so they can be distinguished more easily.

Synced offline. Added comments and moved Z gate families to constants.

verult · 2022-07-16T22:31:39Z

@tanujkhattar PTAL whenever you have spare cycles - would be good to have your approval as well. Or we could also merge as is if you feel comfortable

tanujkhattar · 2022-07-17T07:39:54Z

cirq-google/cirq_google/devices/grid_device.py

-MEASUREMENT_GATE_FAMILY = cirq.GateFamily(cirq.MeasurementGate)
-WAIT_GATE_FAMILY = cirq.GateFamily(cirq.WaitGate)
+# Gate family constants used in various parts of GridDevice logic.
+_SYC_GATE_FAMILY = cirq.GateFamily(ops.SYC)


It's not clear to me why we have both _SYC_GATE_FAMILY and _SYC_FSIM_GATE_FAMILY. Can you explain briefly? Also happy to sync offline in a 1:1

tanujkhattar · 2022-07-17T07:48:55Z

cirq-google/cirq_google/devices/grid_device.py

@@ -400,25 +426,25 @@ def _value_equality_values_(self):
 def _set_gate_in_gate_spec(
    gate_spec: v2.device_pb2.GateSpecification, gate_family: cirq.GateFamily
 ) -> None:
-    if gate_family == SYC_GATE_FAMILY:
+    if gate_family == _SYC_GATE_FAMILY:


Your _build_gateset_and_gate_durations method inserts a _SYC_FSIM_GATE_FAMILY into your gateset if the gate specification proto contains an entry for syc; but when converting from a gateset to a gate specification proto; you check whether the gate family in your gateset is _SYC_GATE_FAMILY (instead of _SYC_FSIM_GATE_FAMILY) to set the syc field in the proto.

Is this expected? or am I missing something?

Also, do we have proto -> gateset -> proto roundtrip tests which test this behavior?

GridDevice cannot be serialized back into DeviceSpecification currently. I plan to address this after 1.0 by adding a to_device_specification() method which either returns a cached DeviceSpecification or converts GridDeviceMetadata, TBD.

create_device_specification_proto() doesn't serialize a GridDevice. It accepts just enough device information to populate the DeviceSpecification proto, which doesn't contains some of the generated information in GridDevice like target gatesets. The goal was to simplify the population of DeviceSpecification by not having to manually construct the full GridDevice on server side. Because this function doesn't serialize GridDevice, this doesn't need to be symmetric with logic in from_proto, and instead should be simpler. This is why the gate families for syc are different. For create_device_specification_proto(), I used the simplest GateFamily (_SYC_GATE_FAMILY) to represent the syc gate field in DeviceSpecification proto. For from_proto(), _SYC_FSIM_GATE_FAMILY has to be used to accept all gates equivalent to syc.

Will add a comment in create_device_specification_proto() to clarify that it doesn't serialize GridDevice.

Can you given me an example of a user who would call create_device_specification_proto and get back the DeviceSpecification ? Who is this user? Where will they obtain the gateset that this method expects? Can / should they use the device.metadata.gateset that's already present on a grid device?

One reason you want to generate a DeviceSpecification proto from a GridDevice is server-side, when you are using the GridDevice (which was probably generated with server-side configuration) for client-sent circuits, and you need to generate device specification.

That being said, I am not quite sure I understand the different between create_device_specification_proto() and to_device_specification(). Is this something we can post-pone discussion until after 1.0?

I propose doing the minimum we need to get to 1.0, so we can get this PR out (even if it means removing methods we will have to add back later).

cc @maffoo who also had concerns in this area

Should we mark it somehow to note that it is an experimental API and may change in the future? (e.g. can we make it an underscore-prefix semi-private function?)

To be clear, my remaining comment is regarding "The current serialization/deserialization API is confusing to enough people that it definitely needs a revisit after 1.0" and I would like to prevent deprecation (or backwards incompatibility) shortly after we declare that we are not going to do that. I know we left room for cirq_google, but I would like to avoid as much churn as possible. If the best we can do is add an "EXPERIMENTAL: May change" disclaimer to the docstring, that will do, but I would prefer preemptive action if we can.

This was changed to _create_device_specification_proto so my concerns are addressed. I've already approved.

tanujkhattar

LGTM from my side. We can merge once @dstrain115's comments are resolved.

maffoo · 2022-07-18T17:01:57Z

cirq-google/cirq_google/devices/grid_device.py

+    if all(gate_family in gateset.gates for gate_family in _CZ_TARGET_GATES):
+        target_gatesets.append(
+            transformers.GoogleCZTargetGateset(
+                additional_gates=(list(gateset.gates - set(_CZ_TARGET_GATES)))


nit: remove extra parens

Suggested change

additional_gates=(list(gateset.gates - set(_CZ_TARGET_GATES)))

additional_gates=list(gateset.gates - set(_CZ_TARGET_GATES))

maffoo · 2022-07-18T17:02:35Z

cirq-google/cirq_google/devices/grid_device.py

        target_gatesets.append(
-            cirq.SqrtIswapTargetGateset(use_sqrt_iswap_inv=cirq.SQRT_ISWAP_INV in gateset)
+            cirq.SqrtIswapTargetGateset(
+                additional_gates=(list(gateset.gates - set(_SQRT_ISWAP_TARGET_GATES)))


nit: remove extra parens

Suggested change

additional_gates=(list(gateset.gates - set(_SQRT_ISWAP_TARGET_GATES)))

additional_gates=list(gateset.gates - set(_SQRT_ISWAP_TARGET_GATES))

…l' docstring; removed extra parens

verult · 2022-07-18T17:10:32Z

Added an underscore and added docstring to say the function is experimental. I think from_proto can left as is since its function signature is unlikely to change.

…factor/use-google-cz-target-gateset

…teset

@tanujkhattar

…target gatesets (quantumlib#5765) * GridDevice target gateset generation logic now matches all required gates for a particular gateset, rather than just the 2q gate. * In target gatesets that support additional_gates, it's set to all gates in a device's gateset other than required gates in the target gateset, so that device gates are not decomposed during circuit transformation. First commit is from quantumlib#5744 @tanujkhattar cc @dstrain115

verult requested a review from tanujkhattar July 14, 2022 01:41

verult requested review from wcourtney, a team, vtomole and cduck as code owners July 14, 2022 01:41

CirqBot added the size: L 250< lines changed <1000 label Jul 14, 2022

dstrain115 approved these changes Jul 16, 2022

View reviewed changes

tanujkhattar self-assigned this Jul 17, 2022

tanujkhattar requested changes Jul 17, 2022

View reviewed changes

tanujkhattar added time/before-1.0 priority/p0 Needs urgent attention and a hotfix release, breaks the majority of users labels Jul 17, 2022

verult added 7 commits July 18, 2022 00:55

GridDevice: use GoogleCZTargetGateset

de404a2

Match target gateset by all target gates; set additional_gates

2d15d1d

Targe gatesets docstring fix

38e26df

Regrouped gate family constants

13fc00a

Moved z gate families to constants; added comments for constants

8517935

Clarified purpose of create_device_specification_proto in docstring

36f1235

create_device_specification_proto accepts FSimGateFamilies

9c15358

verult force-pushed the cg-device-refactor/use-google-cz-target-gateset branch from 0a5e461 to 9c15358 Compare July 18, 2022 00:56

Fix doctest failure

5683fc7

tanujkhattar approved these changes Jul 18, 2022

View reviewed changes

maffoo approved these changes Jul 18, 2022

View reviewed changes

Made create_device_specification_proto private and added 'experimenta…

fe3e6bd

…l' docstring; removed extra parens

Merge branch 'master' of github.com:quantumlib/Cirq into cg-device-re…

edff664

…factor/use-google-cz-target-gateset

verult added the automerge Tells CirqBot to sync and merge this PR. (If it's running.) label Jul 18, 2022

CirqBot added the front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. label Jul 18, 2022

Merge branch 'master' into cg-device-refactor/use-google-cz-target-ga…

d2d3c2c

…teset

CirqBot merged commit e0ae7ca into quantumlib:master Jul 18, 2022

CirqBot removed automerge Tells CirqBot to sync and merge this PR. (If it's running.) front_of_queue_automerge CirqBot uses this label to indicate (and remember) what's being merged next. labels Jul 18, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use GoogleCZTargetGateset; add device gateset as additional gates in target gatesets #5765

Use GoogleCZTargetGateset; add device gateset as additional gates in target gatesets #5765

verult commented Jul 14, 2022

dstrain115 left a comment

dstrain115 Jul 15, 2022

verult Jul 16, 2022

verult Jul 16, 2022

verult commented Jul 16, 2022 •

edited

Loading

tanujkhattar Jul 17, 2022

tanujkhattar Jul 17, 2022 •

edited

Loading

tanujkhattar Jul 17, 2022

verult Jul 17, 2022

tanujkhattar Jul 17, 2022

dstrain115 Jul 17, 2022

verult Jul 18, 2022

verult Jul 18, 2022

dstrain115 Jul 18, 2022

dstrain115 Jul 18, 2022

dstrain115 Jul 18, 2022

tanujkhattar left a comment

maffoo Jul 18, 2022

maffoo Jul 18, 2022

verult commented Jul 18, 2022

	additional_gates=(list(gateset.gates - set(_CZ_TARGET_GATES)))
	additional_gates=list(gateset.gates - set(_CZ_TARGET_GATES))

Use GoogleCZTargetGateset; add device gateset as additional gates in target gatesets #5765

Use GoogleCZTargetGateset; add device gateset as additional gates in target gatesets #5765

Conversation

verult commented Jul 14, 2022

dstrain115 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verult commented Jul 16, 2022 • edited Loading

Choose a reason for hiding this comment

tanujkhattar Jul 17, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tanujkhattar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

verult commented Jul 18, 2022

verult commented Jul 16, 2022 •

edited

Loading

tanujkhattar Jul 17, 2022 •

edited

Loading