From ba6db61a2b8d35745eb44d0f8c3c4c4cd91510ba Mon Sep 17 00:00:00 2001 From: arettig Date: Fri, 20 Nov 2026 03:54:46 +0000 Subject: [PATCH] Change Engine.run and EngineProcessor.run to return a job The cirq_google Engine.run and EngineProcessor.run used to block and return a result. They now return a job immediately to better match EngineProgram and their own run_sweep methods. --- .../cirq_google/engine/abstract_processor.py | 10 +++-- cirq-google/cirq_google/engine/engine.py | 38 +++++++++---------- cirq-google/cirq_google/engine/engine_test.py | 21 +++++----- .../engine/simulated_local_processor_test.py | 3 +- .../engine/virtual_engine_factory_test.py | 19 ++++++---- .../workflow/processor_record_test.py | 2 +- 6 files changed, 52 insertions(+), 41 deletions(-) diff --git a/cirq-google/cirq_google/engine/abstract_processor.py b/cirq-google/cirq_google/engine/abstract_processor.py index f39578fa6c..428f365b68 100644 --- a/cirq-google/cirq_google/engine/abstract_processor.py +++ b/cirq-google/cirq_google/engine/abstract_processor.py @@ -65,9 +65,12 @@ async def run_async( program_labels: dict[str, str] | None = None, job_description: str | None = None, job_labels: dict[str, str] | None = None, - ) -> cirq.Result: + ) -> abstract_job.AbstractJob: """Runs the supplied Circuit on this processor. + This is a non-blocking method that runs the supplied circuit and + returns the quantum engine job immediately. + Args: program: The Circuit to execute. If a circuit is provided, a moment by moment schedule will be used. @@ -99,9 +102,9 @@ async def run_async( job_labels: Optional set of labels to set on the job. Returns: - A single Result for this run. + An AbstractJob. """ - job = await self.run_sweep_async( + return await self.run_sweep_async( program=program, program_id=program_id, job_id=job_id, @@ -115,7 +118,6 @@ async def run_async( snapshot_id=snapshot_id, device_config_name=device_config_name, ) - return job.results()[0] run = duet.sync(run_async) diff --git a/cirq-google/cirq_google/engine/engine.py b/cirq-google/cirq_google/engine/engine.py index 06cc6414d9..0c66018236 100644 --- a/cirq-google/cirq_google/engine/engine.py +++ b/cirq-google/cirq_google/engine/engine.py @@ -262,9 +262,12 @@ def run( run_name: str = "", snapshot_id: str = "", device_config_name: str = "", - ) -> cirq.Result: + ) -> engine_job.EngineJob: """Runs the supplied Circuit via Quantum Engine. + This is a non-blocking method that runs the supplied circuit and + returns the quantum engine job immediately. + Args: program: The Circuit to execute. If a circuit is provided, a moment by moment schedule will be used. @@ -297,7 +300,7 @@ def run( If specified, `processor_id` is required to be set. Returns: - A single Result for this run. + An EngineJob. Raises: ValueError: If no gate set is provided. @@ -305,24 +308,21 @@ def run( ValueError: If either `run_name` and `device_config_name` are set but `processor_id` is empty. """ - results = list( - self.run_sweep( - program=program, - program_id=program_id, - job_id=job_id, - params=[param_resolver], - repetitions=repetitions, - processor_id=processor_id, - program_description=program_description, - program_labels=program_labels, - job_description=job_description, - job_labels=job_labels, - run_name=run_name, - snapshot_id=snapshot_id, - device_config_name=device_config_name, - ) + return self.run_sweep( + program=program, + program_id=program_id, + job_id=job_id, + params=[param_resolver], + repetitions=repetitions, + processor_id=processor_id, + program_description=program_description, + program_labels=program_labels, + job_description=job_description, + job_labels=job_labels, + run_name=run_name, + snapshot_id=snapshot_id, + device_config_name=device_config_name, ) - return results[0] async def run_sweep_async( self, diff --git a/cirq-google/cirq_google/engine/engine_test.py b/cirq-google/cirq_google/engine/engine_test.py index ad1571aedf..eb8920237b 100644 --- a/cirq-google/cirq_google/engine/engine_test.py +++ b/cirq-google/cirq_google/engine/engine_test.py @@ -258,7 +258,8 @@ def test_run_circuit_with_unary_rpcs(client, compress_run_context): compress_run_context=compress_run_context, ), ) - result = engine.run(program=_CIRCUIT, program_id='prog', job_id='job-id', processor_id='mysim') + job = engine.run(program=_CIRCUIT, program_id='prog', job_id='job-id', processor_id='mysim') + result = job.results()[0] if compress_run_context: expected_sweep = util.pack_any( v2.run_context_to_proto(cirq.UnitSweep, 1, compress_proto=True) @@ -320,7 +321,8 @@ def test_run_circuit_with_stream_rpcs_passes(client): project_id='proj', context=EngineContext(service_args={'client_info': 1}, enable_streaming=True), ) - result = engine.run(program=_CIRCUIT, program_id='prog', job_id='job-id', processor_id='mysim') + job = engine.run(program=_CIRCUIT, program_id='prog', job_id='job-id', processor_id='mysim') + result = job.results()[0] assert result.repetitions == 1 assert result.params.param_dict == {'a': 1} @@ -355,7 +357,7 @@ def test_run_circuit_snapshot_id_with_stream_rpcs(client): project_id='proj', context=EngineContext(service_args={'client_info': 1}, enable_streaming=True), ) - result = engine.run( + job = engine.run( program=_CIRCUIT, program_id='prog', job_id='job-id', @@ -363,6 +365,7 @@ def test_run_circuit_snapshot_id_with_stream_rpcs(client): snapshot_id="123", device_config_name="config", ) + result = job.results()[0] assert result.repetitions == 1 assert result.params.param_dict == {'a': 1} @@ -427,7 +430,7 @@ def test_run_circuit_failed_with_unary_rpcs(client): match='Job projects/proj/programs/prog/jobs/job-id on processor' ' myqc failed. SYSTEM_ERROR: Not good', ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) @@ -450,7 +453,7 @@ def test_run_circuit_failed_with_stream_rpcs(client): match='Job projects/proj/programs/prog/jobs/job-id on processor' ' myqc failed. SYSTEM_ERROR: Not good', ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) @@ -479,7 +482,7 @@ def test_run_circuit_failed_missing_processor_name_with_unary_rpcs(client): match='Job projects/proj/programs/prog/jobs/job-id on processor' ' UNKNOWN failed. SYSTEM_ERROR: Not good', ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) @@ -501,7 +504,7 @@ def test_run_circuit_failed_missing_processor_name_with_stream_rpcs(client): match='Job projects/proj/programs/prog/jobs/job-id on processor' ' UNKNOWN failed. SYSTEM_ERROR: Not good', ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) @@ -524,7 +527,7 @@ def test_run_circuit_cancelled_with_unary_rpcs(client): with pytest.raises( RuntimeError, match='Job projects/proj/programs/prog/jobs/job-id failed in state CANCELLED.' ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) @@ -540,7 +543,7 @@ def test_run_circuit_cancelled_with_stream_rpcs(client): with pytest.raises( RuntimeError, match='Job projects/proj/programs/prog/jobs/job-id failed in state CANCELLED.' ): - engine.run(program=_CIRCUIT, processor_id='processor0') + engine.run(program=_CIRCUIT, processor_id='processor0').results() @mock.patch('cirq_google.engine.engine_client.EngineClient', autospec=True) diff --git a/cirq-google/cirq_google/engine/simulated_local_processor_test.py b/cirq-google/cirq_google/engine/simulated_local_processor_test.py index f0dac3dcf0..9102966081 100644 --- a/cirq-google/cirq_google/engine/simulated_local_processor_test.py +++ b/cirq-google/cirq_google/engine/simulated_local_processor_test.py @@ -131,7 +131,8 @@ def test_run(): proc = SimulatedLocalProcessor(processor_id='test_proc') q = cirq.GridQubit(5, 4) circuit = cirq.Circuit(cirq.X(q), cirq.measure(q, key='m')) - result = proc.run(circuit, repetitions=100, run_name="run", device_config_name="config_alias") + job = proc.run(circuit, repetitions=100, run_name="run", device_config_name="config_alias") + result = job.results()[0] assert np.all(result.measurements['m'] == 1) diff --git a/cirq-google/cirq_google/engine/virtual_engine_factory_test.py b/cirq-google/cirq_google/engine/virtual_engine_factory_test.py index dcf9bf01d6..bbe0a9b132 100644 --- a/cirq-google/cirq_google/engine/virtual_engine_factory_test.py +++ b/cirq-google/cirq_google/engine/virtual_engine_factory_test.py @@ -44,17 +44,20 @@ def _test_processor(processor: cg.engine.abstract_processor.AbstractProcessor) - Also tests the non-Sycamore qubits and gates fail.""" good_qubit = cirq.GridQubit(5, 4) circuit = cirq.Circuit(cirq.X(good_qubit), cirq.measure(good_qubit)) - results = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") + job = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") + results = job.results()[0] assert np.all(results.measurements[str(good_qubit)] == 1) + job = processor.run( + circuit, repetitions=100_000_000, run_name="run", device_config_name="config" + ) with pytest.raises(RuntimeError, match='requested total repetitions'): - _ = processor.run( - circuit, repetitions=100_000_000, run_name="run", device_config_name="config" - ) + _ = job.results() bad_qubit = cirq.GridQubit(1000, 1000) circuit = cirq.Circuit(cirq.X(bad_qubit), cirq.measure(bad_qubit)) + job = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") with pytest.raises(ValueError, match='Qubit not on device'): - _ = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") + _ = job.results() circuit = cirq.Circuit( cirq.testing.DoesNotSupportSerializationGate()(good_qubit), cirq.measure(good_qubit) ) @@ -268,14 +271,16 @@ def test_create_default_noisy_quantum_virtual_machine( processor = engine.get_processor(processor_id) bad_qubit = cirq.GridQubit(1000, 1000) circuit = cirq.Circuit(cirq.X(bad_qubit), cirq.measure(bad_qubit)) + job = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") with pytest.raises(ValueError, match='Qubit not on device'): - _ = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") + _ = job.results() good_qubit = cirq.GridQubit(5, 4) circuit = cirq.Circuit( cirq.testing.DoesNotSupportSerializationGate()(good_qubit), cirq.measure(good_qubit) ) + job = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") with pytest.raises(ValueError, match='.* contains a gate which is not supported.'): - _ = processor.run(circuit, repetitions=100, run_name="run", device_config_name="config") + _ = job.results() device_specification = processor.get_device_specification() expected = factory.create_device_spec_from_processor_id(processor_id) assert device_specification is not None diff --git a/cirq-google/cirq_google/workflow/processor_record_test.py b/cirq-google/cirq_google/workflow/processor_record_test.py index 1c44dc9730..98be2d20ca 100644 --- a/cirq-google/cirq_google/workflow/processor_record_test.py +++ b/cirq-google/cirq_google/workflow/processor_record_test.py @@ -150,7 +150,7 @@ def test_engine_result(): circ = cirq.Circuit(cirq.measure(cirq.GridQubit(5, 4))) - res1 = proc.run(circ, run_name="run", device_config_name="config_alias") + res1 = proc.run(circ, run_name="run", device_config_name="config_alias").results()[0] assert isinstance(res1, cg.EngineResult) res2 = samp.run(circ) assert isinstance(res2, cg.EngineResult)