GateFamily: tag validation #5101
Merged
Conversation
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
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
4 times, most recently
from
1b45095 to
49683b1
Compare
dstrain115
approved these changes
Mar 22, 2022
Collaborator
dstrain115
left a comment
dstrain115
left a comment
There was a problem hiding this comment.
Looks good to me aside from the JSON test failures.
tanujkhattar
requested changes
Mar 22, 2022
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
from
49683b1 to
7ef0296
Compare
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
2 times, most recently
from
d068423 to
67e884b
Compare
tanujkhattar
requested changes
Mar 24, 2022
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
from
3c91da5 to
346ea2e
Compare
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
from
346ea2e to
4564e37
Compare
Collaborator
Author
|
This PR is ready for review again! |
tanujkhattar
approved these changes
Apr 9, 2022
cirq-core/cirq/ops/gateset.py
Outdated
| description: Human readable description of the gate family. | ||
| ignore_global_phase: If True, value equality is checked via | ||
| `cirq.equal_up_to_global_phase`. | ||
| tags_to_accept: If non-empty, only `Operations` containing at least one tag in this |
Collaborator
There was a problem hiding this comment.
Suggested change
| tags_to_accept: If non-empty, only `Operations` containing at least one tag in this | |
| tags_to_accept: If non-empty, only `cirq.Operation` containing at least one tag in this |
cirq-core/cirq/ops/gateset.py
Outdated
| >>> assert cirq.Rx(rads=np.pi) in gate_family | ||
| >>> assert cirq.X ** sympy.Symbol("theta") in gate_family | ||
| Tags can be used to add further constraints on containment checks using `tags_to_accept` and |
Collaborator
There was a problem hiding this comment.
In the docstring, let's try to be consistent with how we use backticks. In general, the reference docs will automatically create a hyperlink to the reference page of an object if it's a public object. Eg: cirq.Operation will hyperlink but Operation and Operations will not.
It would also be nice if we can make the docstring slightly more concise. For example:
As seen in the examples above, `GateFamily` supports containment checks for instances of both `cirq.Operation` and `cirq.Gate`. By default, a `cirq.Operation` instance `op` is accepted if the underlying `op.gate` is accepted.
Further constraints can be added on containment checks for `cirq.Operation` objects by setting `tags_to_accept` and / or `tags_to_ignore` in the `GateFamily` constructor. For a tagged operation, the underlying gate `op.gate` will be checked for containment only if:
*`op.tags` has no intersection with `tags_to_ignore` and
* if `tags_to_accept` is non-empty, then `op.tags` should have a non-zero intersection with `tags_to_accept`.
For example:
.... (copy examples from below) ....
Collaborator
Author
There was a problem hiding this comment.
Sounds good. I will remove the code block explaining the semantics and replace it with your bullet list suggestion, but I will keep "If an Operation contains tags..." and "For the purpose of tag comparisons..." since they explain additional behaviors not covered by the above.
Collaborator
Author
There was a problem hiding this comment.
I'm omitting ticks around "GateFamily" to be consistent with the docstring before this section, but let me know if you prefer including them. Will hyperlinking work properly in this case since it's referring to the class for which the docstring is defined?
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
4 times, most recently
from
39e0279 to
9dee385
Compare
verult
force-pushed
the
cg-device-refactor/gatefamily-tags
branch
from
9dee385 to
bde310e
Compare
verult
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
rht
pushed a commit
to rht/Cirq
that referenced
this pull request
May 1, 2023
Adding general validation of gate tags to GateFamily, as described in quantumlib#5063 (comment) Replaces quantumlib#5063 @tanujkhattar
harry-phasecraft
pushed a commit
to PhaseCraft/Cirq
that referenced
this pull request
Oct 31, 2024
Adding general validation of gate tags to GateFamily, as described in quantumlib#5063 (comment) Replaces quantumlib#5063 @tanujkhattar
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Adding general validation of gate tags to GateFamily, as described in #5063 (comment)
Replaces #5063
@tanujkhattar