Initialize processor sampler with the default device config key (#6521)

* add default device config key to grid device metadata

* Revert "add default device config key to grid device metadata"

This reverts commit bcd3533.

* initialize sampler with default device config key and add tests

* add properties to sampler

* dedupe DeviceConfigK, onewas renamed to DeviceConfigSelector

* spelling

* coverage

* address comments

* add fake engine context and client for testing

* lint

* use new FakeEngineContext

* typecheck

* lint , local env not catching CI errors

* signature of fakes  match real impls

* add logic to initialize default values instead of throwing value error

* lint

* rm logging and prefer to throw value error

Author: senecameeks

cirq-google/cirq_google/cloud/quantum/__init__.py

@@ -61,7 +61,7 @@
 from cirq_google.cloud.quantum_v1alpha1.types.engine import UpdateQuantumJobRequest
 from cirq_google.cloud.quantum_v1alpha1.types.engine import UpdateQuantumProgramRequest
 from cirq_google.cloud.quantum_v1alpha1.types.engine import UpdateQuantumReservationRequest
-from cirq_google.cloud.quantum_v1alpha1.types.quantum import DeviceConfigKey
+from cirq_google.cloud.quantum_v1alpha1.types.quantum import DeviceConfigSelector
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import ExecutionStatus
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import GcsLocation
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import InlineData
@@ -77,6 +77,7 @@
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import QuantumResult
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import QuantumTimeSlot
 from cirq_google.cloud.quantum_v1alpha1.types.quantum import SchedulingConfig
+from cirq_google.cloud.quantum_v1alpha1.types.quantum import DeviceConfigKey
 
 __all__ = (
     'QuantumEngineServiceClient',
@@ -121,7 +122,7 @@
     'UpdateQuantumJobRequest',
     'UpdateQuantumProgramRequest',
     'UpdateQuantumReservationRequest',
-    'DeviceConfigKey',
+    'DeviceConfigSelector',
     'ExecutionStatus',
     'GcsLocation',
     'InlineData',
@@ -137,4 +138,5 @@
     'QuantumResult',
     'QuantumTimeSlot',
     'SchedulingConfig',
+    'DeviceConfigKey',
 )

cirq-google/cirq_google/cloud/quantum_v1alpha1/__init__.py

@@ -57,7 +57,7 @@
 from .types.engine import UpdateQuantumJobRequest
 from .types.engine import UpdateQuantumProgramRequest
 from .types.engine import UpdateQuantumReservationRequest
-from .types.quantum import DeviceConfigKey
+from .types.quantum import DeviceConfigSelector
 from .types.quantum import ExecutionStatus
 from .types.quantum import GcsLocation
 from .types.quantum import InlineData
@@ -73,6 +73,7 @@
 from .types.quantum import QuantumResult
 from .types.quantum import QuantumTimeSlot
 from .types.quantum import SchedulingConfig
+from .types.quantum import DeviceConfigKey
 
 __all__ = (
     'QuantumEngineServiceAsyncClient',
@@ -85,7 +86,7 @@
     'DeleteQuantumJobRequest',
     'DeleteQuantumProgramRequest',
     'DeleteQuantumReservationRequest',
-    'DeviceConfigKey',
+    'DeviceConfigSelector',
     'ExecutionStatus',
     'GcsLocation',
     'GetQuantumCalibrationRequest',
@@ -133,4 +134,5 @@
     'UpdateQuantumJobRequest',
     'UpdateQuantumProgramRequest',
     'UpdateQuantumReservationRequest',
+    'DeviceConfigKey',
 )

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

@@ -57,6 +57,7 @@
 )
 from .quantum import (
     DeviceConfigKey,
+    DeviceConfigSelector,
     ExecutionStatus,
     GcsLocation,
     InlineData,
@@ -115,7 +116,7 @@
     'UpdateQuantumJobRequest',
     'UpdateQuantumProgramRequest',
     'UpdateQuantumReservationRequest',
-    'DeviceConfigKey',
+    'DeviceConfigSelector',
     'ExecutionStatus',
     'GcsLocation',
     'InlineData',
@@ -131,4 +132,5 @@
     'QuantumResult',
     'QuantumTimeSlot',
     'SchedulingConfig',
+    'DeviceConfigKey',
 )

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

@@ -39,6 +39,8 @@
         'QuantumReservationBudget',
         'QuantumTimeSlot',
         'QuantumReservation',
+        'DeviceConfigSelector',
+        'DeviceConfigKey',
     },
 )
 
@@ -152,7 +154,7 @@ class QuantumJob(proto.Message):
     run_context = proto.Field(proto.MESSAGE, number=11, message=any_pb2.Any)
 
 
-class DeviceConfigKey(proto.Message):
+class DeviceConfigSelector(proto.Message):
     r"""-
     Attributes:
         run_name (str):
@@ -185,13 +187,13 @@ class ProcessorSelector(proto.Message):
                 -
             processor (str):
                 -
-            device_config_key ((google.cloud.quantum_v1alpha1.types.DeviceConfigKey):
+            device_config_selector ((google.cloud.quantum_v1alpha1.types.DeviceConfigSelector):
                 -
         """
 
         processor_names = proto.RepeatedField(proto.STRING, number=1)
         processor = proto.Field(proto.STRING, number=2)
-        device_config_key = proto.Field(proto.MESSAGE, number=3, message=DeviceConfigKey)
+        device_config_selector = proto.Field(proto.MESSAGE, number=3, message=DeviceConfigSelector)
 
     target_route = proto.Field(proto.STRING, number=1)
     processor_selector = proto.Field(proto.MESSAGE, number=3, message=ProcessorSelector)
@@ -378,6 +380,9 @@ class QuantumProcessor(proto.Message):
             Output only. -
         activity_stats (google.cloud.quantum_v1alpha1.types.QuantumProcessor.ActivityStats):
             -
+        default_device_config_key (google.cloud.quantum_v1alpha1.types.DeviceConfigKey):
+            -
+
     """
 
     class Health(proto.Enum):
@@ -413,6 +418,7 @@ class ActivityStats(proto.Message):
     current_calibration = proto.Field(proto.STRING, number=10)
     active_time_slot = proto.Field(proto.MESSAGE, number=11, message='QuantumTimeSlot')
     activity_stats = proto.Field(proto.MESSAGE, number=12, message=ActivityStats)
+    default_device_config_key = proto.Field(proto.MESSAGE, number=13, message='DeviceConfigKey')
 
 
 class QuantumCalibration(proto.Message):
@@ -605,4 +611,18 @@ class QuantumReservation(proto.Message):
     whitelisted_users = proto.RepeatedField(proto.STRING, number=5)
 
 
+class DeviceConfigKey(proto.Message):
+    r"""-
+
+    Attributes:
+        run (str):
+            -
+        config_alias (str):
+            -
+    """
+
+    run = proto.Field(proto.STRING, number=1)
+    config_alias = proto.Field(proto.STRING, number=2)
+
+
 __all__ = tuple(sorted(__protobuf__.manifest))

cirq-google/cirq_google/engine/engine_client.py

@@ -455,7 +455,7 @@ async def create_job_async(
             scheduling_config=quantum.SchedulingConfig(
                 processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                     processor=_processor_name_from_ids(project_id, processor_id),
-                    device_config_key=quantum.DeviceConfigKey(
+                    device_config_selector=quantum.DeviceConfigSelector(
                         run_name=run_name, config_alias=device_config_name
                     ),
                 )
@@ -816,7 +816,7 @@ def run_job_over_stream(
             scheduling_config=quantum.SchedulingConfig(
                 processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                     processor=_processor_name_from_ids(project_id, processor_id),
-                    device_config_key=quantum.DeviceConfigKey(
+                    device_config_selector=quantum.DeviceConfigSelector(
                         run_name=run_name, config_alias=device_config_name
                     ),
                 )

cirq-google/cirq_google/engine/engine_client_test.py

@@ -373,7 +373,9 @@ def test_create_job(client_constructor):
                     priority=10,
                     processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                         processor='projects/proj/processors/processor0',
-                        device_config_key=quantum.DeviceConfigKey(run_name="", config_alias=""),
+                        device_config_selector=quantum.DeviceConfigSelector(
+                            run_name="", config_alias=""
+                        ),
                     ),
                 ),
                 description='A job',
@@ -396,7 +398,9 @@ def test_create_job(client_constructor):
                     priority=10,
                     processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                         processor='projects/proj/processors/processor0',
-                        device_config_key=quantum.DeviceConfigKey(run_name="", config_alias=""),
+                        device_config_selector=quantum.DeviceConfigSelector(
+                            run_name="", config_alias=""
+                        ),
                     ),
                 ),
                 description='A job',
@@ -417,7 +421,9 @@ def test_create_job(client_constructor):
                     priority=10,
                     processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                         processor='projects/proj/processors/processor0',
-                        device_config_key=quantum.DeviceConfigKey(run_name="", config_alias=""),
+                        device_config_selector=quantum.DeviceConfigSelector(
+                            run_name="", config_alias=""
+                        ),
                     ),
                 ),
                 labels=labels,
@@ -439,7 +445,9 @@ def test_create_job(client_constructor):
                     priority=10,
                     processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                         processor='projects/proj/processors/processor0',
-                        device_config_key=quantum.DeviceConfigKey(run_name="", config_alias=""),
+                        device_config_selector=quantum.DeviceConfigSelector(
+                            run_name="", config_alias=""
+                        ),
                     ),
                 ),
             ),
@@ -463,7 +471,9 @@ def test_create_job(client_constructor):
                     priority=10,
                     processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                         processor='projects/proj/processors/processor0',
-                        device_config_key=quantum.DeviceConfigKey(run_name="", config_alias=""),
+                        device_config_selector=quantum.DeviceConfigSelector(
+                            run_name="", config_alias=""
+                        ),
                     ),
                 ),
             ),
@@ -573,7 +583,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_key=quantum.DeviceConfigKey(
+                        device_config_selector=quantum.DeviceConfigSelector(
                             run_name=run_name, config_alias=device_config_name
                         ),
                     ),
@@ -615,7 +625,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_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         ),
                     ),
                     description='A job',
@@ -649,7 +659,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_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         ),
                     ),
                     description='A job',
@@ -680,7 +690,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_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         ),
                     ),
                     description='A job',
@@ -717,7 +727,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_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         ),
                     ),
                     description='A job',
@@ -752,7 +762,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_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         ),
                     ),
                 ),
@@ -784,7 +794,7 @@ def test_create_job_with_run_name_and_device_config_name(
                     scheduling_config=quantum.SchedulingConfig(
                         processor_selector=quantum.SchedulingConfig.ProcessorSelector(
                             processor='projects/proj/processors/processor0',
-                            device_config_key=quantum.DeviceConfigKey(),
+                            device_config_selector=quantum.DeviceConfigSelector(),
                         )
                     ),
                 ),

cirq-google/cirq_google/engine/engine_processor.py

@@ -19,8 +19,8 @@
 from google.protobuf import any_pb2
 
 import cirq
-from cirq_google.cloud import quantum
 from cirq_google.api import v2
+from cirq_google.cloud import quantum
 from cirq_google.devices import grid_device
 from cirq_google.engine import abstract_processor, calibration, processor_sampler, util
 
@@ -110,8 +110,14 @@ def get_sampler(
         Returns:
             A `cirq.Sampler` instance (specifically a `engine_sampler.ProcessorSampler`
             that will send circuits to the Quantum Computing Service
-            when sampled.1
+            when sampled.
         """
+        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:
+            run_name = processor.default_device_config_key.run
+            device_config_name = processor.default_device_config_key.config_alias
         return processor_sampler.ProcessorSampler(
             processor=self, run_name=run_name, device_config_name=device_config_name
         )