Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support the new quantum engine processor_selector in engine_client #6254

Merged
merged 18 commits into from
Aug 28, 2023
Merged

Support the new quantum engine processor_selector in engine_client #6254

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
bb7a92c
Add DeviceConfigKey to Quantum Engine API types
Aug 22, 2023
b905657
Add new processor_selector arguments in engine_client
Aug 23, 2023
bfcd5d5
fix lint
Aug 23, 2023
996c5c7
change processor_id type
Aug 23, 2023
6e56f2e
Add test coverage
Aug 23, 2023
faf84ae
Merge branch 'master' into quantum_engine
jurruti Aug 24, 2023
84fc2df
Address cxing comments
Aug 25, 2023
27e4a4a
Merge branch 'master' into quantum_engine
Aug 25, 2023
ad2cf67
fix formatting
Aug 25, 2023
a2556a9
fix raises docstrings
Aug 25, 2023
fb0d41e
make new parameters to be mandatory keyword arguments
Aug 25, 2023
633e4c5
fix typo
Aug 25, 2023
282cb8b
Merge branch 'master' into quantum_engine
jurruti Aug 25, 2023
bfcef75
Fix create_job deprecated arguments
Aug 27, 2023
738be5b
fix format
Aug 28, 2023
1320c37
small refactor
Aug 28, 2023
998cfc3
Address wcourtney comments
Aug 28, 2023
4baf027
Merge branch 'master' into quantum_engine
jurruti Aug 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address cxing comments
  • Loading branch information
Jose Urruticoechea committed Aug 25, 2023
commit 84fc2df6a88007d8b7a9bd3711e4be09b896f49d
49 changes: 30 additions & 19 deletions cirq-google/cirq_google/engine/engine_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,38 +408,25 @@ async def create_job_async(
processor_id: Processor id for running the program. If not set,
`processor_ids` will be used.
run_name: A unique identifier representing an automation run for the
jurruti marked this conversation as resolved.
Show resolved Hide resolved
specified processor (given by `processor_id`). An Automation Run contains a
collection of device configurations for a processor.
specified processor. An Automation Run contains a collection of
device configurations for a processor. If specified, `processor_id`
is required to be set.
device_config_name: Configuration identifier used to identify a processor configuration
within the automation run.

within the automation run. If specified, `processor_id` is required to be set.
jurruti marked this conversation as resolved.
Show resolved Hide resolved
Returns:
Tuple of created job id and job.

Raises:
ValueError: If the priority is not between 0 and 1000.
ValueError: If `processor_ids` and `processor_id` are both set.
ValueError: If neither `processor_ids` or `processor_id` are set.
ValueError: If exactly one of `processor_ids` and `processor_id` is not set.
ValueError: If either `run_name` and `device_config_name` are set but
`processor_id` is empty.
ValueError: If `run_name` is set but `device_config_name` is empty.
"""
# Check program to run and program parameters.
if priority and not 0 <= priority < 1000:
raise ValueError('priority must be between 0 and 1000')
if processor_id and processor_ids:
raise ValueError(
'`processor_ids` and `processor_id` cannot both be set.'
'Please just use `processor_id` instead.'
)
if not processor_id and not processor_ids:
raise ValueError('`processor_id` must be set.')
if not processor_id and (run_name or device_config_name):
raise ValueError(
'Cannot specify `run_name` or `device_config_name` if `processor_id` is empty.'
)
if bool(run_name) ^ bool(device_config_name):
raise ValueError('Cannot specify only one of `run_name` and `device_config_name`')
_validate_create_job_processor_and_config_selection(processor_ids, processor_id, run_name, device_config_name)

# Create job.
processor_selector = (
Expand Down Expand Up @@ -1136,3 +1123,27 @@ def _date_or_time_to_filter_expr(param_name: str, param: Union[datetime.datetime
f"type {type(param)}. Supported types: datetime.datetime and"
f"datetime.date"
)

def _validate_create_job_processor_and_config_selection(
processor_ids: Optional[Sequence[str]],
processor_id: str,
run_name: str,
device_config_name: str,
):
""" Validates create job arguments that select the processor and device configuration
Raises:
ValueError: If exactly one of `processor_ids` and `processor_id` is not set.
ValueError: If either `run_name` and `device_config_name` are set but
`processor_id` is empty.
ValueError: If `run_name` is set but `device_config_name` is empty.
"""
if not (bool(processor_id) ^ bool(processor_ids)):
raise ValueError(
'Exactly one of `processor_ids` and `processor_id` must be set'
)
if not processor_id and (run_name or device_config_name):
raise ValueError(
'Cannot specify `run_name` or `device_config_name` if `processor_id` is empty.'
)
if bool(run_name) ^ bool(device_config_name):
raise ValueError('Cannot specify only one of `run_name` and `device_config_name`')
81 changes: 14 additions & 67 deletions cirq-google/cirq_google/engine/engine_client_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,90 +468,37 @@ def test_create_job_with_legacy_processor_ids(client_constructor):
priority=5000,
)


@mock.patch.dict(os.environ, clear='CIRQ_TESTING')
@mock.patch.object(quantum, 'QuantumEngineServiceAsyncClient', autospec=True)
def test_create_job_with_run_name_and_device_config_name_and_no_processor_id_throws(
client_constructor,
@pytest.mark.parametrize(
'processor_ids, processor_id, run_name, device_config_name, error_message',
[
(['processor0'], '', 'RUN_NAME', 'CONFIG_ALIAS', 'Cannot specify `run_name` or `device_config_name` if `processor_id` is empty'),
(['processor0'], 'processor0', '', '', 'Exactly one of `processor_ids` and `processor_id` must be set'),
(None, '', '', '', 'Exactly one of `processor_ids` and `processor_id` must be set'),
(None, 'processor0', 'RUN_NAME', '', 'Cannot specify only one of `run_name` and `device_config_name`'),
(None, 'processor0', '', 'CONFIG_ALIAS', 'Cannot specify only one of `run_name` and `device_config_name`')
])
def test_create_job_with_invalid_processor_and_device_config_arguments_throw(
client_constructor, processor_ids, processor_id, run_name, device_config_name, error_message
):
grpc_client = setup_mock_(client_constructor)
result = quantum.QuantumJob(name='projects/proj/programs/prog/jobs/job0')
grpc_client.create_quantum_job.return_value = result
run_context = any_pb2.Any()
client = EngineClient()

with pytest.raises(
ValueError,
match="Cannot specify `run_name` or `device_config_name` if `processor_id` is empty",
):
client.create_job(
project_id='proj',
program_id='prog',
job_id=None,
processor_ids=['processor0'],
run_name="RUN_NAME",
device_config_name="device_config_name",
run_context=run_context,
)


@mock.patch.dict(os.environ, clear='CIRQ_TESTING')
@mock.patch.object(quantum, 'QuantumEngineServiceAsyncClient', autospec=True)
def test_create_job_with_processor_id_and_processor_ids_throws(client_constructor):
grpc_client = setup_mock_(client_constructor)
result = quantum.QuantumJob(name='projects/proj/programs/prog/jobs/job0')
grpc_client.create_quantum_job.return_value = result
run_context = any_pb2.Any()
client = EngineClient()

with pytest.raises(ValueError, match="`processor_ids` and `processor_id` cannot both be set"):
client.create_job(
project_id='proj',
program_id='prog',
job_id=None,
processor_id='processor0',
processor_ids=['processor0'],
run_context=run_context,
)


@mock.patch.dict(os.environ, clear='CIRQ_TESTING')
@mock.patch.object(quantum, 'QuantumEngineServiceAsyncClient', autospec=True)
def test_create_job_with_no_processor_id_throws(client_constructor):
grpc_client = setup_mock_(client_constructor)
result = quantum.QuantumJob(name='projects/proj/programs/prog/jobs/job0')
grpc_client.create_quantum_job.return_value = result
run_context = any_pb2.Any()
client = EngineClient()

with pytest.raises(ValueError, match="`processor_id` must be set."):
client.create_job(
project_id='proj', program_id='prog', job_id=None, run_context=run_context
)


@mock.patch.object(quantum, 'QuantumEngineServiceAsyncClient', autospec=True)
@pytest.mark.parametrize('run_name, device_config_name', [('RUN_NAME', ''), ('', 'CONFIG_NAME')])
def test_create_job_with_incomplete_device_config_throws(
client_constructor, run_name, device_config_name
):
grpc_client = setup_mock_(client_constructor)
result = quantum.QuantumJob(name='projects/proj/programs/prog/jobs/job0')
grpc_client.create_quantum_job.return_value = result
run_context = any_pb2.Any()
client = EngineClient()

with pytest.raises(
ValueError, match="Cannot specify only one of `run_name` and `device_config_name`"
match=error_message,
):
client.create_job(
project_id='proj',
program_id='prog',
job_id=None,
processor_id='processor0',
processor_ids=processor_ids,
processor_id=processor_id,
run_name=run_name,
device_config_name=device_config_name,
run_context=run_context,
)


Expand Down