Allow external users to use snapshot_id #6739

senecameeks · 2024-09-20T21:11:12Z

A follow up to PR, CL

Allows external users to set a snapshot_id

codecov · 2024-10-03T23:06:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.83%. Comparing base (95f6a3f) to head (6ad91b2).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6739   +/-   ##
=======================================
  Coverage   97.83%   97.83%           
=======================================
  Files        1077     1077           
  Lines       92577    92633   +56     
=======================================
+ Hits        90574    90630   +56     
  Misses       2003     2003

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

mhucka

SGTM. However, I don't think I'm at the point yet in my understanding of Cirq and the internal systems that I'm qualified to review this, so I think this needs someone else's approval.

BichengYing · 2024-10-04T16:25:02Z

cirq-google/cirq_google/cloud/quantum_v1alpha1/types/quantum.py

@@ -156,15 +156,48 @@ class QuantumJob(proto.Message):

 class DeviceConfigSelector(proto.Message):
 r"""-
+ This message has `oneof`_ fields (mutually exclusive fields).


this is auto generated code?

Yup, the changes in this file are from gapic client generation

cirq-google/cirq_google/engine/engine_client.py

BichengYing · 2024-10-04T16:27:59Z

cirq-google/cirq_google/engine/engine_client.py

+ run_name: str | None = "",
+ snapshot_id: str | None = None,


why the default value of run_name is "" instead of None? Can we make run_name and snapshot_id identical -- both use None?

Reverted, so now both run_name and snapshot_id default to "" for consistency (See Will's comment)

cirq-google/cirq_google/engine/engine_processor.py

BichengYing · 2024-10-04T16:28:59Z

cirq-google/cirq_google/engine/engine_processor.py

@@ -105,19 +111,23 @@ def get_sampler(
 processor = self._inner_processor()
 # If a run_name or config_alias is not provided, initialize them
 # to the Processor's default values.
- if not run_name and not device_config_name:
+ if not run_name and not device_config_name and not snapshot_id:


curious why before we use if (bool(run_name) or bool(snapshot_id)) ^ bool(device_config_name):?

Before we use XOR expression to determine (and enforce) the validity of some parameter permutations. Here we check if no values were passed then initialize to the Processors default values.

BichengYing · 2024-10-04T16:29:57Z

cirq-google/cirq_google/engine/engine_processor.py

 # If a run_name or config_alias is not provided, initialize them
 # to the Processor's default values.


update the comment here. "If a run_name or config_alias" isn't neither of them provided?

wcourtney · 2024-10-04T15:44:37Z

cirq-google/cirq_google/engine/abstract_processor.py

@@ -79,6 +80,9 @@ async def run_async(
 device_config_name: An identifier used to select the processor configuration
 utilized to run the job. A configuration identifies the set of
 available qubits, couplers, and supported gates in the processor.
+ snapshot_id: A unique identifier for an immutable snapshot reference.


It should be documented (and enforced) that it's invalid to specify both run name and snapshot id - both here and elsewhere.

Added some documentation here, and enforcement in the subclasses.

cirq-google/cirq_google/engine/engine.py

cirq-google/cirq_google/engine/engine_client_test.py

wcourtney · 2024-10-04T16:53:18Z

cirq-google/cirq_google/engine/engine_client_test.py

@@ -634,7 +686,9 @@ def test_create_job_with_run_name_and_device_config_name(
 priority=10,
 processor_selector=quantum.SchedulingConfig.ProcessorSelector(
 processor='projects/proj/processors/processor0',
- device_config_selector=quantum.DeviceConfigSelector(),
+ device_config_selector=quantum.DeviceConfigSelector(


Does this change remove an existing test case? Should it be preserved?

Reverted, and created new test to explicitly test new code

wcourtney · 2024-10-04T16:57:04Z

cirq-google/cirq_google/engine/engine_client_test.py

+ )
+ )
+
+
 @pytest.mark.parametrize(
 'run_job_kwargs, expected_submit_args',
 [


I recognize that this was an existing test, but this massive parameterization block makes it really difficult to figure out what's being tested. Consider adding a new test that explicitly refers to the condition you're demonstrating.

Done, and reverted changes from massive parametrization block

wcourtney · 2024-10-04T16:58:50Z

cirq-google/cirq_google/engine/engine_client_test.py

@@ -600,7 +650,7 @@ def test_create_job_with_run_name_and_device_config_name(
 priority=10,
 processor_selector=quantum.SchedulingConfig.ProcessorSelector(
 processor='projects/proj/processors/processor0',
- device_config_selector=quantum.DeviceConfigSelector(),
+ device_config_selector=quantum.DeviceConfigSelector(run_name=""),


Is this change needed? I wouldn't expect this PR's change to affect the existing tests of run_name.

This is a side-effect of moving run_name into a oneof

"Oneof Impact: When you assign an empty string to a string field within a oneof, protocol buffers interpret this as explicitly setting that field to a value (even if it's an empty value). This triggers the oneof to recognize that field as the active one."

senecameeks added 8 commits September 20, 2024 13:27

add snapshot_id

828685f

test

8bed612

update

ead822d

Merge branch 'master' into u/smeeks/add_snapshot_id

ce37839

fixes

1b1c201

add changes to generated client

a3c4c71

Merge branch 'master' into u/smeeks/add_snapshot_id

fabeb1e

coverage

51400a2

senecameeks marked this pull request as ready for review October 3, 2024 22:59

senecameeks requested review from wcourtney, vtomole, verult and a team as code owners October 3, 2024 22:59

senecameeks requested a review from BichengYing October 3, 2024 22:59

mhucka reviewed Oct 4, 2024

View reviewed changes

BichengYing reviewed Oct 4, 2024

View reviewed changes

wcourtney reviewed Oct 4, 2024

View reviewed changes

senecameeks added 2 commits October 4, 2024 11:28

review comments

1aa8182

clean u tests

6ad91b2

senecameeks requested review from wcourtney, BichengYing and mhucka October 4, 2024 19:25

format

c1a84d0

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow external users to use snapshot_id #6739

Allow external users to use snapshot_id #6739

senecameeks commented Sep 20, 2024 •

edited

Loading

codecov bot commented Oct 3, 2024 •

edited

Loading

mhucka left a comment

BichengYing Oct 4, 2024

senecameeks Oct 4, 2024 •

edited

Loading

BichengYing Oct 4, 2024

senecameeks Oct 4, 2024

BichengYing Oct 4, 2024

senecameeks Oct 4, 2024

BichengYing Oct 4, 2024

senecameeks Oct 4, 2024

wcourtney Oct 4, 2024

senecameeks Oct 4, 2024

wcourtney Oct 4, 2024

senecameeks Oct 4, 2024

wcourtney Oct 4, 2024

senecameeks Oct 4, 2024

wcourtney Oct 4, 2024

senecameeks Oct 4, 2024

		# If a run_name or config_alias is not provided, initialize them
		# to the Processor's default values.

Allow external users to use snapshot_id #6739

Are you sure you want to change the base?

Allow external users to use snapshot_id #6739

Conversation

senecameeks commented Sep 20, 2024 • edited Loading

codecov bot commented Oct 3, 2024 • edited Loading

Codecov Report

mhucka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

senecameeks Oct 4, 2024 • 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

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

senecameeks commented Sep 20, 2024 •

edited

Loading

codecov bot commented Oct 3, 2024 •

edited

Loading

senecameeks Oct 4, 2024 •

edited

Loading