Repository navigation
Give stimcirq annotations a gate so they can be included in gatesets - #1120
Merged
Strilanc merged 1 commit intoOct 12, 2026
Merged
Conversation
`stimcirq.DetAnnotation`, `stimcirq.CumulativeObservableAnnotation` and `stimcirq.ShiftCoordsAnnotation` are `cirq.Operation`s whose `gate` was `None`. As a result they can't be matched by a `cirq.GateFamily`, so they are rejected by gateset-based validation such as `cirq_google.GridDevice`, and circuits converted from stim can't be validated against hardware devices. This adds a gate form for each annotation (`stimcirq.DetAnnotationGate`, `stimcirq.CumulativeObservableAnnotationGate`, `stimcirq.ShiftCoordsAnnotationGate`) which is returned by the annotation's `gate` property, similar to how `cirq.GlobalPhaseGate` relates to global phase operations. Applying the gate to qubits returns the annotation. Devices can now explicitly allow annotations, e.g. `cirq.Gateset(..., stimcirq.DetAnnotationGate)`. The annotations themselves remain plain `cirq.Operation`s (rather than also subclassing `cirq.Gate`) because cirq's simulators treat anything that is a `cirq.Gate` as needing explicit qubits in `cirq.act_on`, which raises for operations.
Strilanc
approved these changes
Oct 12, 2026
Strilanc
left a comment
Strilanc
left a comment
Collaborator
There was a problem hiding this comment.
Can't say I like the boilerplate but if this is actually causing trouble with interop then it's important to fix.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
stimcirq.DetAnnotation,stimcirq.CumulativeObservableAnnotationandstimcirq.ShiftCoordsAnnotationarecirq.Operations whosegatewasNone. As a result they can't be matched by acirq.GateFamily, so they are rejected by gateset-based validation such ascirq_google.GridDevice, and circuits converted from stim can't be validated against hardware devices.This adds a gate form for each annotation (
stimcirq.DetAnnotationGate,stimcirq.CumulativeObservableAnnotationGate,stimcirq.ShiftCoordsAnnotationGate) which is returned by the annotation'sgateproperty, similar to howcirq.GlobalPhaseGaterelates to global phase operations. Applying the gate to qubits returns the annotation. Devices can now explicitly allow annotations, e.g.cirq.Gateset(..., stimcirq.DetAnnotationGate).The annotations themselves remain plain
cirq.Operations (rather than also subclassingcirq.Gate) because cirq's simulators treat anything that is acirq.Gateas needing explicit qubits incirq.act_on, which raises for operations.