-
Notifications
You must be signed in to change notification settings - Fork 1k
/
arg_func_langs.py
364 lines (312 loc) · 12.3 KB
/
arg_func_langs.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# Copyright 2019 The Cirq Developers
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import math
from typing import (
List,
Union,
Optional,
Iterator,
Iterable,
Dict,
FrozenSet,
)
import numpy as np
import sympy
from cirq_google.api import v2
SUPPORTED_FUNCTIONS_FOR_LANGUAGE: Dict[Optional[str], FrozenSet[str]] = {
'': frozenset(),
'linear': frozenset({'add', 'mul'}),
'exp': frozenset({'add', 'mul', 'pow'}),
# None means any. Is used when inferring the language during serialization.
None: frozenset({'add', 'mul', 'pow'}),
}
MOST_PERMISSIVE_LANGUAGE = 'exp'
SUPPORTED_SYMPY_OPS = (sympy.Symbol, sympy.Add, sympy.Mul, sympy.Pow)
# Argument types for gates.
ARG_LIKE = Union[int, float, List[bool], str, sympy.Symbol, sympy.Add, sympy.Mul]
FLOAT_ARG_LIKE = Union[float, sympy.Symbol, sympy.Add, sympy.Mul]
# Types for comparing floats
# Includes sympy types. Needed for arg parsing.
FLOAT_TYPES = (float, int, sympy.Integer, sympy.Float, sympy.Rational, sympy.NumberSymbol)
# Supported function languages in order from least to most flexible.
# Clients should use the least flexible language they can, to make it easier
# to gradually roll out new capabilities to clients and servers.
LANGUAGE_ORDER = [
'',
'linear',
'exp',
]
def _max_lang(langs: Iterable[str]) -> str:
i = max((LANGUAGE_ORDER.index(e) for e in langs), default=0)
return LANGUAGE_ORDER[i]
def _infer_function_language_from_circuit(value: v2.program_pb2.Circuit) -> str:
return _max_lang(
{
e
for moment in value.moments
for op in moment.operations
for e in _function_languages_from_operation(op)
}
)
def _function_languages_from_operation(value: v2.program_pb2.Operation) -> Iterator[str]:
for arg in value.args.values():
yield from _function_languages_from_arg(arg)
def _function_languages_from_arg(arg_proto: v2.program_pb2.Arg) -> Iterator[str]:
which = arg_proto.WhichOneof('arg')
if which == 'func':
if arg_proto.func.type in ['add', 'mul']:
yield 'linear'
for a in arg_proto.func.args:
yield from _function_languages_from_arg(a)
if arg_proto.func.type in ['pow']:
yield 'exp'
for a in arg_proto.func.args:
yield from _function_languages_from_arg(a)
def float_arg_to_proto(
value: ARG_LIKE,
*,
arg_function_language: Optional[str] = None,
out: Optional[v2.program_pb2.FloatArg] = None,
) -> v2.program_pb2.FloatArg:
"""Writes an argument value into an FloatArg proto.
Note that the FloatArg proto is a slimmed down form of the
Arg proto, so this proto should only be used when the argument
is known to be a float or expression that resolves to a float.
Args:
value: The value to encode. This must be a float or compatible
sympy expression. Strings and repeated booleans are not allowed.
arg_function_language: The language to use when encoding functions. If
this is set to None, it will be set to the minimal language
necessary to support the features that were actually used.
out: The proto to write the result into. Defaults to a new instance.
Returns:
The proto that was written into.
"""
msg = v2.program_pb2.FloatArg() if out is None else out
if isinstance(value, FLOAT_TYPES):
msg.float_value = float(value)
else:
_arg_func_to_proto(value, arg_function_language, msg)
return msg
def arg_to_proto(
value: ARG_LIKE,
*,
arg_function_language: Optional[str] = None,
out: Optional[v2.program_pb2.Arg] = None,
) -> v2.program_pb2.Arg:
"""Writes an argument value into an Arg proto.
Args:
value: The value to encode.
arg_function_language: The language to use when encoding functions. If
this is set to None, it will be set to the minimal language
necessary to support the features that were actually used.
out: The proto to write the result into. Defaults to a new instance.
Returns:
The proto that was written into as well as the `arg_function_language`
that was used.
"""
msg = v2.program_pb2.Arg() if out is None else out
if isinstance(value, FLOAT_TYPES):
msg.arg_value.float_value = float(value)
elif isinstance(value, str):
msg.arg_value.string_value = value
elif isinstance(value, (list, tuple, np.ndarray)) and all(
isinstance(x, (bool, np.bool_)) for x in value
):
# Some protobuf / numpy combinations do not support np.bool_, so cast.
msg.arg_value.bool_values.values.extend([bool(x) for x in value])
else:
_arg_func_to_proto(value, arg_function_language, msg)
return msg
def _arg_func_to_proto(
value: ARG_LIKE,
arg_function_language: Optional[str],
msg: Union[v2.program_pb2.Arg, v2.program_pb2.FloatArg],
) -> None:
def check_support(func_type: str) -> str:
if func_type not in supported:
lang = repr(arg_function_language) if arg_function_language is not None else '[any]'
raise ValueError(
f'Function type {func_type!r} not supported by arg_function_language {lang}'
)
return func_type
if arg_function_language not in SUPPORTED_FUNCTIONS_FOR_LANGUAGE:
raise ValueError(f'Unrecognized arg_function_language: {arg_function_language!r}')
supported = SUPPORTED_FUNCTIONS_FOR_LANGUAGE[arg_function_language]
if isinstance(value, sympy.Symbol):
msg.symbol = str(value.free_symbols.pop())
elif isinstance(value, sympy.Add):
msg.func.type = check_support('add')
for arg in value.args:
arg_to_proto(arg, arg_function_language=arg_function_language, out=msg.func.args.add())
elif isinstance(value, sympy.Mul):
msg.func.type = check_support('mul')
for arg in value.args:
arg_to_proto(arg, arg_function_language=arg_function_language, out=msg.func.args.add())
elif isinstance(value, sympy.Pow):
msg.func.type = check_support('pow')
for arg in value.args:
arg_to_proto(arg, arg_function_language=arg_function_language, out=msg.func.args.add())
else:
raise ValueError(f'Unrecognized arg type: {type(value)}')
# TODO(#3388) Add documentation for Raises.
# pylint: disable=missing-raises-doc
def float_arg_from_proto(
arg_proto: v2.program_pb2.FloatArg,
*,
arg_function_language: str,
required_arg_name: Optional[str] = None,
) -> Optional[FLOAT_ARG_LIKE]:
"""Extracts a python value from an argument value proto.
This function handles `FloatArg` protos, that are required
to be floats or symbolic expressions.
Args:
arg_proto: The proto containing a serialized value.
arg_function_language: The `arg_function_language` field from
`Program.Language`.
required_arg_name: If set to `None`, the method will return `None` when
given an unset proto value. If set to a string, the method will
instead raise an error complaining that the value is missing in that
situation.
Returns:
The deserialized value, or else None if there was no set value and
`required_arg_name` was set to `None`.
"""
which = arg_proto.WhichOneof('arg')
if which == 'float_value':
result = float(arg_proto.float_value)
if round(result) == result:
result = int(result)
return result
elif which == 'symbol':
return sympy.Symbol(arg_proto.symbol)
elif which == 'func':
func = _arg_func_from_proto(
arg_proto.func,
arg_function_language=arg_function_language,
required_arg_name=required_arg_name,
)
if func is None and required_arg_name is not None:
raise ValueError(
f'Arg {arg_proto.func} could not be processed for {required_arg_name}.'
)
return func
elif which is None:
if required_arg_name is not None:
raise ValueError(f'Arg {required_arg_name} is missing.')
return None
else:
raise ValueError(f'unrecognized argument type ({which}).')
# TODO(#3388) Add documentation for Raises.
def arg_from_proto(
arg_proto: v2.program_pb2.Arg,
*,
arg_function_language: str,
required_arg_name: Optional[str] = None,
) -> Optional[ARG_LIKE]:
"""Extracts a python value from an argument value proto.
Args:
arg_proto: The proto containing a serialized value.
arg_function_language: The `arg_function_language` field from
`Program.Language`.
required_arg_name: If set to `None`, the method will return `None` when
given an unset proto value. If set to a string, the method will
instead raise an error complaining that the value is missing in that
situation.
Returns:
The deserialized value, or else None if there was no set value and
`required_arg_name` was set to `None`.
"""
which = arg_proto.WhichOneof('arg')
if which == 'arg_value':
arg_value = arg_proto.arg_value
which_val = arg_value.WhichOneof('arg_value')
if which_val == 'float_value' or which_val == 'double_value':
if which_val == 'double_value':
result = float(arg_value.double_value)
else:
result = float(arg_value.float_value)
if math.ceil(result) == math.floor(result):
result = int(result)
return result
if which_val == 'bool_values':
return list(arg_value.bool_values.values)
if which_val == 'string_value':
return str(arg_value.string_value)
raise ValueError(f'Unrecognized value type: {which_val!r}')
if which == 'symbol':
return sympy.Symbol(arg_proto.symbol)
if which == 'func':
func = _arg_func_from_proto(
arg_proto.func,
arg_function_language=arg_function_language,
required_arg_name=required_arg_name,
)
if func is not None:
return func
if required_arg_name is not None:
raise ValueError(
f'{required_arg_name} is missing or has an unrecognized '
f'argument type (WhichOneof("arg")={which!r}).'
)
return None
# pylint: enable=missing-raises-doc
def _arg_func_from_proto(
func: v2.program_pb2.ArgFunction,
*,
arg_function_language: str,
required_arg_name: Optional[str] = None,
) -> Optional[ARG_LIKE]:
supported = SUPPORTED_FUNCTIONS_FOR_LANGUAGE.get(arg_function_language)
if supported is None:
raise ValueError(f'Unrecognized arg_function_language: {arg_function_language!r}')
if func.type not in supported:
raise ValueError(
f'Unrecognized function type {func.type!r} '
f'for arg_function_language={arg_function_language!r}'
)
if func.type == 'add':
return sympy.Add(
*[
arg_from_proto(
a,
arg_function_language=arg_function_language,
required_arg_name='An addition argument',
)
for a in func.args
]
)
if func.type == 'mul':
return sympy.Mul(
*[
arg_from_proto(
a,
arg_function_language=arg_function_language,
required_arg_name='A multiplication argument',
)
for a in func.args
]
)
if func.type == 'pow':
return sympy.Pow(
*[
arg_from_proto(
a,
arg_function_language=arg_function_language,
required_arg_name='A power argument',
)
for a in func.args
]
)
return None