def test_cancel(build):
service = mock.Mock()
build.return_value = service
programs = service.projects().programs()
jobs = programs.jobs()
programs.create().execute.return_value = {
'name': 'projects/project-id/programs/test'
}
jobs.create().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'READY'
}
}
jobs.get().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'CANCELLED'
}
}
job = Engine(api_key="key").run_sweep(
cirq.Circuit(), JobConfig('project-id',
gcs_prefix='gs://bucket/folder'))
job.cancel()
assert job.job_resource_name == ('projects/project-id/programs/test/'
'jobs/test')
assert job.status() == 'CANCELLED'
assert jobs.cancel.call_args[1][
'name'] == 'projects/project-id/programs/test/jobs/test'
def test_schedule_and_device_both_not_supported(build):
scheduled_op = cirq.ScheduledOperation(time=None,
duration=None,
operation=cirq.H.on(
cirq.NamedQubit("dorothy")))
schedule = cirq.Schedule(device=Foxtail,
scheduled_operations=[scheduled_op])
eng = Engine(api_key="key")
with pytest.raises(ValueError, match='Device'):
eng.run(schedule, JobConfig('project-id'), device=Foxtail)
def test_run_sweep_params(build):
service = mock.Mock()
build.return_value = service
programs = service.projects().programs()
jobs = programs.jobs()
programs.create().execute.return_value = {
'name': 'projects/project-id/programs/test'
}
jobs.create().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'READY'
}
}
jobs.get().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'SUCCESS'
}
}
jobs.getResult().execute.return_value = {'result': MessageToDict(_RESULTS)}
job = Engine(api_key="key").run_sweep(
cirq.moment_by_moment_schedule(cirq.UnconstrainedDevice,
cirq.Circuit()),
JobConfig('project-id', gcs_prefix='gs://bucket/folder'),
params=[cirq.ParamResolver({'a': 1}),
cirq.ParamResolver({'a': 2})])
results = job.results()
assert len(results) == 2
for i, v in enumerate([1, 2]):
assert results[i].repetitions == 1
assert results[i].params.param_dict == {'a': v}
assert results[i].measurements == {'q': np.array([[0]], dtype='uint8')}
build.assert_called_with(
'quantum',
'v1alpha1',
discoveryServiceUrl=('https://{api}.googleapis.com'
'/$discovery/rest?version='
'{apiVersion}&key=key'))
assert programs.create.call_args[1]['parent'] == 'projects/project-id'
sweeps = programs.create.call_args[1]['body']['code']['parameterSweeps']
assert len(sweeps) == 2
for i, v in enumerate([1, 2]):
assert sweeps[i]['repetitions'] == 1
assert sweeps[i]['sweep']['factors'][0]['sweeps'][0]['points'][
'points'] == [v]
assert jobs.create.call_args[1][
'parent'] == 'projects/project-id/programs/test'
assert jobs.get().execute.call_count == 1
assert jobs.getResult().execute.call_count == 1
def test_run_circuit_failed(build):
service = mock.Mock()
build.return_value = service
programs = service.projects().programs()
jobs = programs.jobs()
programs.create().execute.return_value = {
'name': 'projects/project-id/programs/test'
}
jobs.create().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'READY'
}
}
jobs.get().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'FAILURE'
}
}
with pytest.raises(RuntimeError, match='It is in state FAILURE'):
Engine(api_key="key").run(
cirq.Circuit(),
JobConfig('project-id', gcs_prefix='gs://bucket/folder'))
def test_circuit_device_validation_passes_non_xmon_gate(build):
service = mock.Mock()
build.return_value = service
programs = service.projects().programs()
jobs = programs.jobs()
programs.create().execute.return_value = {
'name': 'projects/project-id/programs/test'
}
jobs.create().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'READY'
}
}
jobs.get().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'SUCCESS'
}
}
jobs.getResult().execute.return_value = {
'result': MessageToDict(_A_RESULT)
}
circuit = cirq.Circuit.from_ops(cirq.H.on(XmonQubit(0, 1)))
result = Engine(api_key="key").run(circuit, JobConfig('project-id'),
Foxtail)
assert result.repetitions == 1
def test_schedule_device_validation_fails(build):
scheduled_op = cirq.ScheduledOperation(time=None,
duration=None,
operation=cirq.H.on(
cirq.NamedQubit("dorothy")))
schedule = cirq.Schedule(device=Foxtail,
scheduled_operations=[scheduled_op])
with pytest.raises(ValueError):
Engine(api_key="key").run(schedule, JobConfig('project-id'))
def test_implied_job_config_project_id(build):
eng = Engine(api_key="key")
with pytest.raises(ValueError, match='project id'):
_ = eng.implied_job_config(None)
with pytest.raises(ValueError, match='project id'):
_ = eng.implied_job_config(JobConfig())
assert eng.implied_job_config(
JobConfig(project_id='specific')).project_id == 'specific'
eng_with = Engine(api_key="key", default_project_id='default')
# Fallback to default.
assert eng_with.implied_job_config(None).project_id == 'default'
# Override default.
assert eng_with.implied_job_config(
JobConfig(project_id='specific')).project_id == 'specific'
def from_engine(cls,
engine: cg.Engine,
processor_id: str,
gate_set: Optional[cg.SerializableGateSet] = None):
"""
Constructs a RepRateTester using a cirq.google.Engine object.
Uses the device from the device specification from the API
and the sampler provided by the Engine.
Args:
engine: cirq.google.Engine to use for device and sampler.
gate_set: gate set to use. Defaults to square root of iswap
processor_id: Processor to test on.
"""
gate_set = gate_set or cg.SQRT_ISWAP_GATESET
device = engine.get_processor(processor_id).get_device(
gate_sets=[gate_set])
sampler = engine.sampler(processor_id=processor_id, gate_set=gate_set)
gate = cirq.ISWAP**0.5
if gate_set == cg.SYC_GATESET:
gate = cirq.google.SYC
return cls(device, sampler, gate)
def test_implied_job_config(build):
eng = Engine(api_key="key")
# Infer all from project id.
implied = eng.implied_job_config(JobConfig(project_id='project_id'))
assert implied.project_id == 'project_id'
assert re.fullmatch(r'prog-[0-9A-Z]+', implied.program_id)
assert implied.job_id == 'job-0'
assert implied.gcs_prefix == 'gs://gqe-project_id/'
assert re.fullmatch(
r'gs://gqe-project_id/programs/prog-[0-9A-Z]+/prog-[0-9A-Z]+',
implied.gcs_program)
assert re.fullmatch(
r'gs://gqe-project_id/programs/prog-[0-9A-Z]+/jobs/job-0',
implied.gcs_results)
# Force program id.
implied = eng.implied_job_config(JobConfig(project_id='j', program_id='g'))
assert implied.project_id == 'j'
assert implied.program_id == 'g'
assert implied.job_id == 'job-0'
assert implied.gcs_prefix == 'gs://gqe-j/'
assert implied.gcs_program == 'gs://gqe-j/programs/g/g'
assert implied.gcs_results == 'gs://gqe-j/programs/g/jobs/job-0'
# Force all.
implied = eng.implied_job_config(
JobConfig(project_id='a',
program_id='b',
job_id='c',
gcs_prefix='gs://d',
gcs_program='e',
gcs_results='f'))
assert implied.project_id == 'a'
assert implied.program_id == 'b'
assert implied.job_id == 'c'
assert implied.gcs_prefix == 'gs://d/'
assert implied.gcs_program == 'e'
assert implied.gcs_results == 'f'
def test_run_circuit(build):
service = mock.Mock()
build.return_value = service
programs = service.projects().programs()
jobs = programs.jobs()
programs.create().execute.return_value = {
'name': 'projects/project-id/programs/test'
}
jobs.create().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'READY'
}
}
jobs.get().execute.return_value = {
'name': 'projects/project-id/programs/test/jobs/test',
'executionStatus': {
'state': 'SUCCESS'
}
}
jobs.getResult().execute.return_value = {
'result': MessageToDict(_A_RESULT)
}
result = Engine(api_key="key").run(
cirq.Circuit(), JobConfig('project-id',
gcs_prefix='gs://bucket/folder'))
assert result.repetitions == 1
assert result.params.param_dict == {'a': 1}
assert result.measurements == {'q': np.array([[0]], dtype='uint8')}
build.assert_called_with(
'quantum',
'v1alpha1',
discoveryServiceUrl=('https://{api}.googleapis.com'
'/$discovery/rest?version='
'{apiVersion}&key=key'))
assert programs.create.call_args[1]['parent'] == 'projects/project-id'
assert jobs.create.call_args[1][
'parent'] == 'projects/project-id/programs/test'
assert jobs.get().execute.call_count == 1
assert jobs.getResult().execute.call_count == 1
def test_job_labels(build):
job_name = 'projects/my-proj/programs/my-prog/jobs/my-job'
service = mock.Mock()
build.return_value = service
jobs = service.projects().programs().jobs()
engine = Engine(api_key="key")
def body():
return jobs.patch.call_args[1]['body']
jobs.get().execute.return_value = {'labels': {'a': '1', 'b': '1'}}
engine.add_job_labels(job_name, {'a': '2', 'c': '1'})
assert body()['labels'] == {'a': '2', 'b': '1', 'c': '1'}
assert body()['labelFingerprint'] == ''
jobs.get().execute.return_value = {
'labels': {
'a': '1',
'b': '1'
},
'labelFingerprint': 'abcdef'
}
engine.set_job_labels(job_name, {'s': '1', 'p': '1'})
assert body()['labels'] == {'s': '1', 'p': '1'}
assert body()['labelFingerprint'] == 'abcdef'
jobs.get().execute.return_value = {
'labels': {
'a': '1',
'b': '1'
},
'labelFingerprint': 'abcdef'
}
engine.remove_job_labels(job_name, ['a', 'c'])
assert body()['labels'] == {'b': '1'}
assert body()['labelFingerprint'] == 'abcdef'
def test_bad_job_config_inference_order(build):
eng = Engine(api_key="key")
config = JobConfig()
with pytest.raises(ValueError):
eng._infer_gcs_prefix(config)
config.project_id = 'project'
with pytest.raises(ValueError):
eng._infer_gcs_results(config)
with pytest.raises(ValueError):
eng._infer_gcs_program(config)
eng._infer_gcs_prefix(config)
eng._infer_gcs_results(config)
eng._infer_gcs_program(config)
def test_implied_job_config_gcs_prefix(build):
eng = Engine(api_key="key")
config = JobConfig(project_id='project_id')
# Implied by project id.
assert eng.implied_job_config(config).gcs_prefix == 'gs://gqe-project_id/'
# Bad default.
eng_with_bad = Engine(api_key="key", default_gcs_prefix='bad_prefix')
with pytest.raises(ValueError, match='gcs_prefix must be of the form'):
_ = eng_with_bad.implied_job_config(config)
# Good default without slash.
eng_with = Engine(api_key="key", default_gcs_prefix='gs://good')
assert eng_with.implied_job_config(config).gcs_prefix == 'gs://good/'
# Good default with slash.
eng_with = Engine(api_key="key", default_gcs_prefix='gs://good/')
assert eng_with.implied_job_config(config).gcs_prefix == 'gs://good/'
# Bad override.
config.gcs_prefix = 'bad_prefix'
with pytest.raises(ValueError, match='gcs_prefix must be of the form'):
_ = eng.implied_job_config(config)
with pytest.raises(ValueError, match='gcs_prefix must be of the form'):
_ = eng_with_bad.implied_job_config(config)
# Good override without slash.
config.gcs_prefix = 'gs://better'
assert eng.implied_job_config(config).gcs_prefix == 'gs://better/'
assert eng_with.implied_job_config(config).gcs_prefix == 'gs://better/'
# Good override with slash.
config.gcs_prefix = 'gs://better/'
assert eng.implied_job_config(config).gcs_prefix == 'gs://better/'
assert eng_with.implied_job_config(config).gcs_prefix == 'gs://better/'
def test_bad_priority(build):
eng = Engine(api_key="key")
with pytest.raises(ValueError, match='priority must be'):
eng.run(cirq.Circuit(),
JobConfig('project-id', gcs_prefix='gs://bucket/folder'),
priority=1001)
def test_unsupported_program_type(build):
eng = Engine(api_key="key")
with pytest.raises(TypeError, match='program'):
eng.run(program="this isn't even the right type of thing!",
job_config=JobConfig('project-id'),
device=Foxtail)
def test_circuit_device_validation_fails(build):
circuit = cirq.Circuit.from_ops(cirq.H.on(cirq.NamedQubit("dorothy")))
with pytest.raises(ValueError, match='Unsupported qubit type'):
Engine(api_key="key").run(circuit, JobConfig('project-id'), Foxtail)
