Support for stimcirq gates and operations in cirq_google protos by dstrain115 · Pull Request #7101 · quantumlib/Cirq

dstrain115 · 2025-02-26T21:15:00Z

Adds special casing for stimcirq gates and operations.
Note that this only supports gates and operations where the arguments can be serialized.
Serializing the stimcirq gates uses the json dictionary in order to gather arguments from the operations.
Tests will only be run if stimcirq is installed
This also adds stimcirq as a dev dependency so that we can test the interaction.
(end users will not be affected, just developers)

- Adds special casing for stimcirq gates and operations. - Note that this only supports gates and operations where the arguments can be serialized. - Serializing the stimcirq gates uses the json dictionary in order to gather arguments from the operations. - Tests will only be run if stimcirq is installed (manual use only)

gemini-code-assist · 2025-02-26T21:15:03Z

Important

The terms of service for this installation has not been accepted. Please ask the Organization owners to visit the Gemini Code Assist Admin Console to sign it.

codecov · 2025-02-27T14:15:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.16%. Comparing base (34b9c81) to head (b96e5dd).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7101   +/-   ##
=======================================
  Coverage   98.16%   98.16%           
=======================================
  Files        1093     1093           
  Lines       95420    95456   +36     
=======================================
+ Hits        93665    93701   +36     
  Misses       1755     1755

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

senecameeks · 2025-03-03T22:07:17Z

            arg_func_langs.float_arg_to_proto(
                gate.q1_detune_mhz, out=msg.couplerpulsegate.q1_detune_mhz
            )
+        elif op.__module__.startswith('stimcirq') or (


prefer getattr(op, "__module__", "")

Good idea, done.

senecameeks · 2025-03-03T22:10:53Z

                gate.q1_detune_mhz, out=msg.couplerpulsegate.q1_detune_mhz
            )
+        elif op.__module__.startswith('stimcirq') or (
+            gate is not None and gate.__module__.startswith('stimcirq')


Can replace this entire line with "getattr(gate, "module", "")" since it handles None values gracefully

Good idea, done.

senecameeks · 2025-03-03T22:15:56Z

+                    msg.internalgate.num_qubits = len(stimcirq_obj.qubits)
+
+                # Store json_dict objects in gate_args
+                for k, v in stimcirq_obj._json_dict_().items():


Instead of relying on the stimcirq object to always have _json_dict_ defined, prefer to use getattr instead. Also from your comment on line 266, it's not clear if stimcirq operations will also always have _json_dict_ defined.

I am not sure I understand what you are proposing. How do we know which attributes to get from the stimcirq object otherwise? Also, how do we know how to instantiate the appropriate object on deserialization.

I think saying that a stimcirq gate/operation must have a json_dict to be imported/exported by cirq_google protos is probably a reasonable requirement (plus, we control both repos, so we can add it if it's missing).

I did add a value error if this condition is not met though.

senecameeks · 2025-03-03T22:16:45Z

-            op = arg_func_langs.internal_gate_from_proto(operation_proto.internalgate)(*qubits)
+            parsed_as_stimcirq = False
+            msg = operation_proto.internalgate
+            if msg.module == 'stimcirq':


nit: Can stimcirq be defined as a constant and used here and above?

pavoljuhas

LGTM with a couple of small tweaks.

pavoljuhas · 2025-03-07T03:22:31Z

            op = cirq.ResetChannel(dimension=dimensions)(*qubits)
        elif which_gate_type == 'internalgate':
-            op = arg_func_langs.internal_gate_from_proto(operation_proto.internalgate)(*qubits)
+            parsed_as_stimcirq = False


Can we move this code to a local _deserialize_with_stimcirq_if_installed function which would return Optional[cirq.Operation] - and if None it will fallback to internal_gate_from_proto below?

After factoring out the import, this code block is pretty short. No one gates have a local function.
Let me know if you still think this is a good idea.

pavoljuhas · 2025-03-07T03:27:40Z

+                try:
+                    import stimcirq


If stimcirq is not installed this would search sys.path for every deserialized gate.

Consider moving this to a @functools.cache decorated function which returns stimcirq.JSON_RESOLVERS_DICT if installed or an empty dictionary otherwise.

I think it's only for operations with a module name of stimcirq, but, still, this is a good idea, and done.

Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>

…in115/Cirq-1 into deserialize_stimcirq_gates

…tumlib#7101) * Support for stimcirq gates and operations in cirq_google protos - Adds special casing for stimcirq gates and operations. - Note that this only supports gates and operations where the arguments can be serialized. - Serializing the stimcirq gates uses the json dictionary in order to gather arguments from the operations. - Tests will only be run if stimcirq is installed (manual use only) * Fix some tests. * Add requirements for stimcirq * fix coverage * format * Address comments. * Fix coverage. * format * Update cirq-google/cirq_google/serialization/circuit_serializer_test.py Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com> * Move import to cached function --------- Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>

CirqBot added the size: M 50< lines changed <250 label Feb 26, 2025

dstrain115 added 4 commits February 27, 2025 04:57

Fix some tests.

7dc35df

Add requirements for stimcirq

f46b6ed

fix coverage

2957141

format

728057d

dstrain115 marked this pull request as ready for review February 27, 2025 14:57

dstrain115 requested review from a team, verult, vtomole and wcourtney as code owners February 27, 2025 14:57

dstrain115 requested a review from senecameeks March 3, 2025 20:00

senecameeks reviewed Mar 3, 2025

View reviewed changes

dstrain115 added 3 commits March 5, 2025 14:43

Address comments.

edddb0c

Fix coverage.

b91c07c

Merge branch 'main' into deserialize_stimcirq_gates

96b832c

dstrain115 requested a review from senecameeks March 6, 2025 14:04

dstrain115 added 2 commits March 6, 2025 12:30

Merge branch 'main' into deserialize_stimcirq_gates

31e59d2

format

867816b

pavoljuhas requested changes Mar 7, 2025

View reviewed changes

dstrain115 and others added 4 commits March 7, 2025 08:56

Merge branch 'main' into deserialize_stimcirq_gates

36dd7ab

Update cirq-google/cirq_google/serialization/circuit_serializer_test.py

73c16e1

Co-authored-by: Pavol Juhas <pavol.juhas@gmail.com>

Move import to cached function

9f76b20

Merge branch 'deserialize_stimcirq_gates' of https://github.com/dstra…

b96e5dd

…in115/Cirq-1 into deserialize_stimcirq_gates

dstrain115 requested a review from pavoljuhas March 7, 2025 18:40

pavoljuhas approved these changes Mar 7, 2025

View reviewed changes

dstrain115 added this pull request to the merge queue Mar 7, 2025

Merged via the queue into quantumlib:main with commit 2167552 Mar 7, 2025
38 checks passed

dstrain115 deleted the deserialize_stimcirq_gates branch March 7, 2025 22:55

pavoljuhas mentioned this pull request Feb 12, 2026

stimcirq requirement introduces circular dependency #7891

Open

Conversation

dstrain115 commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist bot commented Feb 26, 2025

Uh oh!

codecov bot commented Feb 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pavoljuhas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

dstrain115 commented Feb 26, 2025 •

edited

Loading

codecov bot commented Feb 27, 2025 •

edited

Loading