/
test_germselection.py
369 lines (313 loc) · 15.2 KB
/
test_germselection.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
365
366
367
368
369
import numpy as np
import pygsti.circuits as pc
from pygsti.algorithms import germselection as germsel
from pygsti.modelmembers.operations import StaticArbitraryOp
from . import fixtures
from pygsti.modelpacks.legacy import std1Q_XYI as std
from ..util import BaseCase
_SEED = 2019
class GermSelectionData(object):
@classmethod
def setUpClass(cls):
super(GermSelectionData, cls).setUpClass()
# XXX are these acceptible test fixtures?
cls.good_germs = fixtures.germs
cls.germ_set = cls.good_germs + \
pc.list_random_circuits_onelen(fixtures.opLabels, 4, 1, seed=_SEED) + \
pc.list_random_circuits_onelen(fixtures.opLabels, 5, 1, seed=_SEED) + \
pc.list_random_circuits_onelen(fixtures.opLabels, 6, 1, seed=_SEED)
def setUp(self):
super(GermSelectionData, self).setUp()
self.mdl_target_noisy = fixtures.mdl_target_noisy.copy()
class GermSelectionWithNeighbors(GermSelectionData):
@classmethod
def setUpClass(cls):
super(GermSelectionWithNeighbors, cls).setUpClass()
cls.neighbors = germsel.randomize_model_list(
[fixtures.model], randomization_strength=1e-3, num_copies=5, seed=_SEED
)
class GermSelectionTester(GermSelectionData, BaseCase):
def test_test_germ_list_finitel(self):
bSuccess, eigvals_finiteL = germsel.test_germ_set_finitel(
self.mdl_target_noisy, self.germ_set, length=16, return_spectrum=True, tol=1e-3
)
self.assertTrue(bSuccess)
# TODO assert correctness
def test_test_germ_list_infl(self):
bSuccess, eigvals_infiniteL = germsel.test_germ_set_infl(
self.mdl_target_noisy, self.germ_set, return_spectrum=True, check=True
)
self.assertTrue(bSuccess)
# TODO assert correctness
def test_num_non_spam_gauge_params(self):
# XXX hey why is this under germselection? EGN: probabaly b/c it was/is used exclusively here - could move it to a tools module?
N = germsel._num_non_spam_gauge_params(self.mdl_target_noisy)
# TODO assert correctness
def test_calculate_germset_score(self):
# TODO remove randomness
maxscore = germsel.compute_germ_set_score(
self.germ_set, self.mdl_target_noisy
)
# TODO assert correctness
def test_compute_composite_germ_score(self):
score = germsel.compute_composite_germ_set_score(
np.sum, model=self.mdl_target_noisy, partial_germs_list=self.germ_set,
eps=1e-5, germ_lengths=np.array([len(g) for g in self.germ_set])
)
# TODO assert correctness
pDDD = np.zeros((len(self.germ_set), self.mdl_target_noisy.num_params,
self.mdl_target_noisy.num_params), 'd')
score_pDDD = germsel.compute_composite_germ_set_score(
np.sum, model=self.mdl_target_noisy, partial_germs_list=self.germ_set,
partial_deriv_dagger_deriv=pDDD, op_penalty=1.0
)
# TODO assert correctness
def test_randomize_model_list(self):
# XXX does this need coverage? EGN: does it take a long time?
neighborhood = germsel.randomize_model_list(
[fixtures.model], num_copies=3, randomization_strength=1e-3,
seed=_SEED
)
# TODO assert consistency
# XXX num_copies and randomization_strength really should be optional kwargs
neighborhood_2 = germsel.randomize_model_list(
[fixtures.model, fixtures.model], num_copies=None,
randomization_strength=1e-3, seed=_SEED
)
# TODO assert consistency
def test_get_model_params_raises_on_model_param_mismatch(self):
gs1 = fixtures.model.copy()
gs2 = fixtures.model.copy()
gs3 = fixtures.model.copy()
gs4 = fixtures.model.copy()
gs1.set_all_parameterizations("full")
gs2.set_all_parameterizations("full TP")
gs3.set_all_parameterizations("full")
gs4.set_all_parameterizations("full")
gs3.operations['Gi2'] = np.identity(4, 'd') # adds non-gauge params but not gauge params
gs4.operations['Gi2'] = StaticArbitraryOp(np.identity(4, 'd')) # keeps param counts the same but adds gate
with self.assertRaises(ValueError):
germsel._get_model_params([gs1, gs2]) # different number of gauge params
with self.assertRaises(ValueError):
germsel._get_model_params([gs1, gs3]) # different number of non-gauge params
with self.assertRaises(ValueError):
germsel._get_model_params([gs1, gs4]) # different number of gates
def test_setup_model_list_warns_on_list_copy(self):
with self.assertWarns(Warning):
models = germsel._setup_model_list(
[self.mdl_target_noisy, self.mdl_target_noisy], num_copies=3,
randomize=False, randomization_strength=0, seed=_SEED
)
# TODO assert correctness
def test_compute_composite_germ_score_raises_on_missing_data(self):
with self.assertRaises(ValueError):
germsel.compute_composite_germ_set_score(np.sum)
pDDD = np.zeros((len(self.germ_set), self.mdl_target_noisy.num_params,
self.mdl_target_noisy.num_params), 'd')
with self.assertRaises(ValueError):
germsel.compute_composite_germ_set_score(np.sum, partial_deriv_dagger_deriv=pDDD)
with self.assertRaises(ValueError):
germsel.compute_composite_germ_set_score(
np.sum, model=self.mdl_target_noisy,
partial_deriv_dagger_deriv=pDDD, op_penalty=1.0
)
def test_randomize_model_list_raises_on_conflicting_arg_spec(self):
with self.assertRaises(ValueError):
germsel.randomize_model_list(
[fixtures.model, fixtures.model], num_copies=3,
randomization_strength=0, seed=_SEED
)
class GenerateGermsTester(GermSelectionData, BaseCase):
def test_generate_germs_with_candidate_germ_counts(self):
germs = germsel.find_germs(
self.mdl_target_noisy, randomize=False,
candidate_germ_counts={3: 'all upto', 4: 10, 5: 10, 6: 10}
)
# TODO assert correctness
def test_generate_germs_raises_on_bad_algorithm(self):
with self.assertRaises(ValueError):
germsel.find_germs(self.mdl_target_noisy, algorithm='foobar')
class SlackGermSetOptimizationTester(GermSelectionData, BaseCase):
def test_optimize_integer_germs_slack_with_fixed_slack(self):
finalGerms = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set, fixed_slack=0.1,
verbosity=4
)
# TODO assert correctness
finalGerms_all, weights, scores = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set, fixed_slack=0.1,
return_all=True, verbosity=4
)
self.assertEqual(finalGerms, finalGerms_all)
algorithm_kwargs = dict(
germs_list=self.germ_set,
fixed_slack=0.1
)
finalGerms_driver = germsel.find_germs(
self.mdl_target_noisy, randomize=False, algorithm='slack',
algorithm_kwargs=algorithm_kwargs, verbosity=4
)
self.assertEqual(finalGerms_driver, finalGerms)
def test_optimize_integer_germs_slack_with_slack_fraction(self):
finalGerms = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set, slack_frac=0.1,
verbosity=4
)
# TODO assert correctness
def test_optimize_integer_germs_slack_with_initial_weights(self):
finalGerms = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set,
initial_weights=np.ones(len(self.germ_set), 'd'),
fixed_slack=0.1, verbosity=4
)
# TODO assert correctness
def test_optimize_integer_germs_slack_force_strings(self):
forceStrs = pc.to_circuits([('Gx',), ('Gy')])
finalGerms = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set, fixed_slack=0.1,
force=forceStrs, verbosity=4,
)
def test_optimize_integer_germs_slack_max_iterations(self):
finalGerms = germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set, fixed_slack=0.1,
max_iter=1, verbosity=4,
)
self.assertEqual(finalGerms, self.germ_set)
def test_optimize_integer_germs_slack_raises_on_initial_weight_length_mismatch(self):
with self.assertRaises(ValueError):
germsel.find_germs_integer_slack(
self.mdl_target_noisy, self.germ_set,
initial_weights=np.ones(1, 'd'),
fixed_slack=0.1, verbosity=4
)
def test_optimize_integer_germs_slack_raises_on_missing_param(self):
# XXX is this a useful test? EGN: Probably not.
with self.assertRaises(ValueError):
germsel.find_germs_integer_slack(self.mdl_target_noisy, self.germ_set)
class GRASPGermSetOptimizationTester(GermSelectionWithNeighbors, BaseCase):
def setUp(self):
super(GRASPGermSetOptimizationTester, self).setUp()
self.options = dict(
randomize=False,
threshold=1e6,
l1_penalty=1.0,
iterations=1,
seed=_SEED,
verbosity=1
)
def test_grasp_germ_set_optimization(self):
soln = germsel.find_germs_grasp(
self.neighbors, self.germ_set, alpha=0.1, **self.options
)
# TODO assert correctness
best, initial, local = germsel.find_germs_grasp(
self.neighbors, self.germ_set, alpha=0.1, return_all=True,
**self.options
)
# TODO shouldn't this pass?
# self.assertEqual(soln, best)
algorithm_kwargs = dict(
germs_list=self.germ_set,
**self.options
)
soln_driver = germsel.find_germs(
self.mdl_target_noisy, randomize=False, algorithm='grasp',
algorithm_kwargs=algorithm_kwargs
)
# TODO assert correctness
def test_grasp_germ_set_optimization_force_strings(self):
forceStrs = pc.to_circuits([('Gx',), ('Gy')])
soln = germsel.find_germs_grasp(
self.neighbors, self.germ_set, alpha=0.1, force=forceStrs,
**self.options
)
for string in forceStrs:
self.assertIn(string, soln)
def test_grasp_germ_set_optimization_returns_none_on_incomplete_initial_set(self):
soln = germsel.find_germs_grasp(
self.neighbors, self.good_germs[:-1], alpha=0.1, **self.options
)
self.assertIsNone(soln)
class GreedyGermSelectionTester(GermSelectionWithNeighbors, BaseCase):
def setUp(self):
super(GreedyGermSelectionTester, self).setUp()
self.options = dict(
randomize=False,
threshold=1e6,
op_penalty=1.0,
seed=_SEED,
verbosity=1
)
def test_build_up(self):
germs = germsel.find_germs_depthfirst(self.neighbors, self.germ_set, **self.options)
# TODO assert correctness
def test_build_up_force_strings(self):
forceStrs = pc.to_circuits([('Gx',), ('Gy')])
germs = germsel.find_germs_depthfirst(
self.neighbors, self.germ_set, force=forceStrs, **self.options
)
# TODO assert correctness
def test_build_up_returns_none_on_incomplete_initial_set(self):
germs = germsel.find_germs_depthfirst(
self.neighbors, self.good_germs[:-1], **self.options
)
self.assertIsNone(germs)
def test_build_up_breadth(self):
germs = germsel.find_germs_breadthfirst(self.neighbors, self.germ_set, **self.options)
# TODO assert correctness
algorithm_kwargs = dict(
germs_list=self.germ_set,
**self.options
)
germs_driver = germsel.find_germs(
self.mdl_target_noisy, randomize=False, algorithm='greedy',
algorithm_kwargs=algorithm_kwargs
)
# TODO assert correctness
def test_build_up_breadth_force_strings(self):
forceStrs = pc.to_circuits([('Gx',), ('Gy')])
germs = germsel.find_germs_breadthfirst(
self.neighbors, self.germ_set, force=forceStrs, **self.options
)
# TODO assert correctness
def test_build_up_breadth_returns_none_on_incomplete_initial_set(self):
germs = germsel.find_germs_breadthfirst(
self.neighbors, self.good_germs[:-1], **self.options
)
self.assertIsNone(germs)
def test_build_up_breadth_raises_on_out_of_memory(self):
with self.assertRaises(MemoryError):
germsel.find_germs_breadthfirst(
self.neighbors, self.germ_set, mem_limit=1024,
**self.options
)
def test_greedy_low_rank_update(self):
# TODO assert correctness
germs = germsel.find_germs(std.target_model(), seed=2017,
candidate_germ_counts={3: 'all upto', 4: 10, 5:10, 6:10},
randomize=False, algorithm='greedy', mode='compactEVD',
assume_real=True, float_type=np.double, verbosity=1)
def test_forced_germs_none(self):
# TODO assert correctness
#make sure that the germ selection doesn't die with force is None
germs_compactEVD = germsel.find_germs(std.target_model(), seed=2017,
candidate_germ_counts={3: 'all upto', 4: 10, 5:10, 6:10},
randomize=False, algorithm='greedy', mode='compactEVD',
assume_real=True, float_type=np.double, verbosity=1, force=None)
germs_allJac = germsel.find_germs(std.target_model(), seed=2017,
candidate_germ_counts={3: 'all upto', 4: 10, 5:10, 6:10},
randomize=False, algorithm='greedy', mode='all-Jac',
assume_real=True, float_type=np.double, verbosity=1, force=None)
germs_singleJac = germsel.find_germs(std.target_model(), seed=2017,
candidate_germ_counts={3: 'all upto', 4: 10, 5:10, 6:10},
randomize=False, algorithm='greedy', mode='single-Jac',
assume_real=True, float_type=np.double, verbosity=1, force=None)
def test_force_germs_outside_candidate_set(self):
#TODO assert correctness
#make sure that the germ selection doesn't die when the list of forced germs includes circuits
#outside the initially specified candidate set.
germs = germsel.find_germs(std.target_model(), seed=2017,
candidate_germ_counts={3: 'all upto', 4: 10, 5:10, 6:10},
randomize=False, algorithm='greedy', mode='compactEVD',
assume_real=True, float_type=np.double, verbosity=1,
force=pc.list_random_circuits_onelen(fixtures.opLabels, length=7, count=2, seed=_SEED))