-
-
Notifications
You must be signed in to change notification settings - Fork 75
/
budget_accounting_test.py
530 lines (480 loc) · 23.8 KB
/
budget_accounting_test.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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
# Copyright 2022 OpenMined.
#
# 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
#
# http://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.
"""Budget Accounting Test"""
import unittest
from dataclasses import dataclass
# TODO: import only modules https://google.github.io/styleguide/pyguide.html#22-imports
from pipeline_dp.budget_accounting import MechanismSpec
from pipeline_dp.aggregate_params import MechanismType
from pipeline_dp.budget_accounting import NaiveBudgetAccountant
from pipeline_dp.budget_accounting import PLDBudgetAccountant
from absl.testing import parameterized
# pylint: disable=protected-access
class NaiveBudgetAccountantTest(parameterized.TestCase):
def test_validation(self):
NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-10) # No exception.
NaiveBudgetAccountant(total_epsilon=1, total_delta=0) # No exception.
with self.assertRaises(ValueError):
NaiveBudgetAccountant(
total_epsilon=0, total_delta=1e-10) # Epsilon must be positive.
with self.assertRaises(ValueError):
NaiveBudgetAccountant(
total_epsilon=0.5,
total_delta=-1e-10) # Delta must be non-negative.
def test_request_budget(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=0)
budget = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
self.assertTrue(budget) # An object must be returned.
with self.assertRaises(AssertionError):
print(budget.eps) # The privacy budget is not calculated yet.
with self.assertRaises(AssertionError):
print(budget.delta) # The privacy budget is not calculated yet.
def test_compute_budgets(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget1 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
budget2 = budget_accountant.request_budget(
mechanism_type=MechanismType.GAUSSIAN, weight=3)
budget_accountant.compute_budgets()
self.assertEqual(budget1.eps, 0.25)
self.assertEqual(budget1.delta,
0) # Delta should be 0 if mechanism is Laplace.
self.assertEqual(budget2.eps, 0.75)
self.assertEqual(budget2.delta, 1e-6)
def test_budget_scopes(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
with budget_accountant.scope(weight=0.4):
budget1 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
budget2 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE, weight=3)
with budget_accountant.scope(weight=0.6):
budget3 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
budget4 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE, weight=4)
budget_accountant.compute_budgets()
self.assertEqual(budget1.eps, 0.4 * (1 / 4))
self.assertEqual(budget2.eps, 0.4 * (3 / 4))
self.assertEqual(budget3.eps, 0.6 * (1 / 5))
self.assertEqual(budget4.eps, 0.6 * (4 / 5))
def test_budget_scopes_no_parentscope(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
# Allocated in the top-level scope with no weight specified
budget1 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
with budget_accountant.scope(weight=0.5):
budget2 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
budget_accountant.compute_budgets()
self.assertEqual(budget1.eps, 1.0 / (1.0 + 0.5))
self.assertEqual(budget2.eps, 0.5 / (1.0 + 0.5))
def test_count(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget1 = budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE, weight=4)
budget2 = budget_accountant.request_budget(
mechanism_type=MechanismType.GAUSSIAN, weight=3, count=2)
budget_accountant.compute_budgets()
self.assertEqual(budget1.eps, 0.4)
self.assertEqual(budget1.delta,
0) # Delta should be 0 if mechanism is Laplace.
self.assertEqual(budget2.eps, 0.3)
self.assertEqual(budget2.delta, 5e-7)
def test_two_calls_compute_budgets_raise_exception(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget_accountant.request_budget(mechanism_type=MechanismType.LAPLACE)
budget_accountant.compute_budgets()
with self.assertRaises(Exception):
# Budget can be computed only once.
budget_accountant.compute_budgets()
def test_request_after_compute_raise_exception(self):
budget_accountant = NaiveBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget_accountant.request_budget(mechanism_type=MechanismType.LAPLACE)
budget_accountant.compute_budgets()
with self.assertRaises(Exception):
# Budget can not be requested after it has been already computed.
budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
@parameterized.parameters(1, 2, 10)
def test_num_aggregations(self, num_aggregations):
total_epsilon, total_delta = 1, 1e-6
budget_accountant = NaiveBudgetAccountant(
total_epsilon=total_epsilon,
total_delta=total_delta,
num_aggregations=num_aggregations)
for _ in range(num_aggregations):
budget = budget_accountant._compute_budget_for_aggregation(1)
expected_epsilon = total_epsilon / num_aggregations
expected_delta = total_delta / num_aggregations
self.assertAlmostEqual(expected_epsilon, budget.epsilon)
self.assertAlmostEqual(expected_delta, budget.delta)
budget_accountant.compute_budgets()
def test_aggregation_weights(self):
total_epsilon, total_delta = 1, 1e-6
weights = [1, 2, 5]
budget_accountant = NaiveBudgetAccountant(total_epsilon=total_epsilon,
total_delta=total_delta,
aggregation_weights=weights)
for weight in weights:
budget = budget_accountant._compute_budget_for_aggregation(weight)
expected_epsilon = total_epsilon * weight / sum(weights)
expected_delta = total_delta * weight / sum(weights)
self.assertAlmostEqual(expected_epsilon, budget.epsilon)
self.assertAlmostEqual(expected_delta, budget.delta)
budget_accountant.compute_budgets()
@parameterized.parameters(True, False)
def test_not_enough_aggregations(self, use_num_aggregations):
weights = num_aggregations = None
if use_num_aggregations:
num_aggregations = 2
else:
weights = [1, 1] # 2 aggregations
budget_accountant = NaiveBudgetAccountant(
total_epsilon=1,
total_delta=1e-6,
num_aggregations=num_aggregations,
aggregation_weights=weights)
budget_accountant._compute_budget_for_aggregation(1)
with self.assertRaises(ValueError):
# num_aggregations = 2, but only 1 aggregation_scope was created
budget_accountant.compute_budgets()
class PLDBudgetAccountantTest(unittest.TestCase):
def test_noise_not_calculated(self):
with self.assertRaises(AssertionError):
mechanism = MechanismSpec(MechanismType.LAPLACE)
print(mechanism.noise_standard_deviation())
def test_invalid_epsilon(self):
with self.assertRaises(ValueError):
PLDBudgetAccountant(total_epsilon=0, total_delta=1e-5)
def test_invalid_delta(self):
with self.assertRaises(ValueError):
PLDBudgetAccountant(total_epsilon=1, total_delta=-1e-5)
def test_invalid_gaussian_delta(self):
accountant = PLDBudgetAccountant(total_epsilon=1, total_delta=0)
with self.assertRaises(AssertionError):
accountant.request_budget(MechanismType.GAUSSIAN)
def test_compute_budgets_none_noise(self):
accountant = PLDBudgetAccountant(total_epsilon=3, total_delta=1e-5)
accountant.compute_budgets()
self.assertEqual(None, accountant.minimum_noise_std)
def test_two_calls_compute_budgets_raise_exception(self):
budget_accountant = PLDBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget_accountant.request_budget(mechanism_type=MechanismType.LAPLACE)
budget_accountant.compute_budgets()
with self.assertRaises(Exception):
# Budget can be computed only once.
budget_accountant.compute_budgets()
def test_request_after_compute_raise_exception(self):
budget_accountant = PLDBudgetAccountant(total_epsilon=1,
total_delta=1e-6)
budget_accountant.request_budget(mechanism_type=MechanismType.LAPLACE)
budget_accountant.compute_budgets()
with self.assertRaises(Exception):
# Budget can not be requested after it has been already computed.
budget_accountant.request_budget(
mechanism_type=MechanismType.LAPLACE)
def test_compute_budgets(self):
@dataclass
class ComputeBudgetMechanisms:
count: int
expected_noise_std: float
mechanism_type: MechanismType
weight: float
sensitivity: float
expected_mechanism_epsilon: float = None
expected_mechanism_delta: float = None
@dataclass
class ComputeBudgetTestCase:
name: str
epsilon: float
delta: float
expected_pipeline_noise_std: float
mechanisms: []
testcases = [
ComputeBudgetTestCase(
name="generic",
epsilon=0.22999925338484556,
delta=1e-5,
mechanisms=[
ComputeBudgetMechanisms(
count=1,
expected_noise_std=6.41455078125,
mechanism_type=MechanismType.GENERIC,
weight=1,
sensitivity=1,
expected_mechanism_epsilon=0.2204717161227536,
expected_mechanism_delta=9.585757904781109e-06)
],
expected_pipeline_noise_std=6.41455078125),
ComputeBudgetTestCase(
name="generic_multiple",
epsilon=0.6599974547358093,
delta=1e-5,
mechanisms=[
ComputeBudgetMechanisms(
count=3,
expected_noise_std=6.71649169921875,
mechanism_type=MechanismType.GENERIC,
weight=1,
sensitivity=1,
expected_mechanism_epsilon=0.21055837268995567,
expected_mechanism_delta=3.190290677321479e-06)
],
expected_pipeline_noise_std=6.71649169921875),
ComputeBudgetTestCase(
name="standard_laplace",
epsilon=4,
delta=0,
mechanisms=[
ComputeBudgetMechanisms(
count=2,
expected_noise_std=0.7071067811865476,
mechanism_type=MechanismType.LAPLACE,
weight=1,
sensitivity=1)
],
expected_pipeline_noise_std=0.7071067811865476),
ComputeBudgetTestCase(
name="standard_laplace_weights",
epsilon=4,
delta=0,
mechanisms=[
ComputeBudgetMechanisms(
count=2,
expected_noise_std=0.7071067811865476,
mechanism_type=MechanismType.LAPLACE,
weight=2,
sensitivity=1)
],
expected_pipeline_noise_std=1.4142135623730951),
ComputeBudgetTestCase(
name="standard_laplace_sensitivities",
epsilon=3,
delta=0,
mechanisms=[
ComputeBudgetMechanisms(
count=2,
expected_noise_std=2.82842712474619,
mechanism_type=MechanismType.LAPLACE,
weight=1,
sensitivity=3)
],
expected_pipeline_noise_std=0.9428090415820634),
ComputeBudgetTestCase(name="laplace_mechanisms",
epsilon=0.19348133991361996,
delta=1e-3,
mechanisms=[
ComputeBudgetMechanisms(
count=10,
expected_noise_std=50,
mechanism_type=MechanismType.LAPLACE,
weight=1,
sensitivity=1)
],
expected_pipeline_noise_std=50),
ComputeBudgetTestCase(name="gaussian_mechanisms",
epsilon=0.16421041618759222,
delta=1e-3,
mechanisms=[
ComputeBudgetMechanisms(
count=10,
expected_noise_std=50,
mechanism_type=MechanismType.GAUSSIAN,
weight=1,
sensitivity=1)
],
expected_pipeline_noise_std=50),
ComputeBudgetTestCase(
name="multiple_noise_kinds",
epsilon=0.2719439419475211,
delta=1e-3,
mechanisms=[
ComputeBudgetMechanisms(
count=5,
expected_noise_std=49.81597900390625,
mechanism_type=MechanismType.LAPLACE,
weight=1,
sensitivity=1),
ComputeBudgetMechanisms(
count=5,
expected_noise_std=49.81597900390625,
mechanism_type=MechanismType.GAUSSIAN,
weight=1,
sensitivity=1),
ComputeBudgetMechanisms(
count=5,
expected_noise_std=49.81597900390625,
mechanism_type=MechanismType.GENERIC,
weight=1,
sensitivity=1,
expected_mechanism_epsilon=0.02838875378244,
expected_mechanism_delta=0.00010439193305478515)
],
expected_pipeline_noise_std=49.81597900390625),
ComputeBudgetTestCase(name="multiple_weights",
epsilon=1.924852037917208,
delta=1e-5,
mechanisms=[
ComputeBudgetMechanisms(
count=4,
expected_noise_std=10,
mechanism_type=MechanismType.LAPLACE,
weight=2,
sensitivity=1),
ComputeBudgetMechanisms(
count=4,
expected_noise_std=5,
mechanism_type=MechanismType.GAUSSIAN,
weight=4,
sensitivity=1)
],
expected_pipeline_noise_std=20),
ComputeBudgetTestCase(name="multiple_sensitivities",
epsilon=0.2764312848667339,
delta=1e-5,
mechanisms=[
ComputeBudgetMechanisms(
count=6,
expected_noise_std=40,
mechanism_type=MechanismType.LAPLACE,
weight=1,
sensitivity=2),
ComputeBudgetMechanisms(
count=2,
expected_noise_std=80,
mechanism_type=MechanismType.GAUSSIAN,
weight=1,
sensitivity=4)
],
expected_pipeline_noise_std=20),
ComputeBudgetTestCase(name="multiple_weights_and_sensitivities",
epsilon=0.780797891312483,
delta=1e-5,
mechanisms=[
ComputeBudgetMechanisms(
count=4,
expected_noise_std=10,
mechanism_type=MechanismType.LAPLACE,
weight=4,
sensitivity=2),
ComputeBudgetMechanisms(
count=6,
expected_noise_std=40,
mechanism_type=MechanismType.GAUSSIAN,
weight=2,
sensitivity=4)
],
expected_pipeline_noise_std=20),
ComputeBudgetTestCase(
name="multiple_weights_and_sensitivities_variants",
epsilon=0.9165937807680077,
delta=1e-6,
mechanisms=[
ComputeBudgetMechanisms(
count=4,
expected_noise_std=20,
mechanism_type=MechanismType.LAPLACE,
weight=4,
sensitivity=2),
ComputeBudgetMechanisms(
count=6,
expected_noise_std=80,
mechanism_type=MechanismType.GAUSSIAN,
weight=2,
sensitivity=4),
ComputeBudgetMechanisms(
count=1,
expected_noise_std=80,
mechanism_type=MechanismType.GAUSSIAN,
weight=3,
sensitivity=6),
ComputeBudgetMechanisms(
count=5,
expected_noise_std=15,
mechanism_type=MechanismType.LAPLACE,
weight=8,
sensitivity=3),
],
expected_pipeline_noise_std=40)
]
for case in testcases:
accountant = PLDBudgetAccountant(case.epsilon, case.delta, 1e-2)
actual_mechanisms = []
for mechanism in case.mechanisms:
for _ in range(0, mechanism.count):
actual_mechanisms.append(
(mechanism.expected_noise_std,
mechanism.expected_mechanism_epsilon,
mechanism.expected_mechanism_delta,
accountant.request_budget(
mechanism.mechanism_type,
weight=mechanism.weight,
sensitivity=mechanism.sensitivity)))
self.assertEqual(
len(actual_mechanisms), len(accountant._mechanisms),
f"failed test {case.name} expected len {len(actual_mechanisms)} "
f"got len {len(accountant._mechanisms)}")
if case.delta > 0:
compare_pld = accountant._compose_distributions(
case.expected_pipeline_noise_std)
actual_epsilon = compare_pld.get_epsilon_for_delta(case.delta)
self.assertAlmostEqual(
case.epsilon, actual_epsilon, 3,
f"failed test {case.name} expected epsilon {case.epsilon} got {actual_epsilon}"
)
accountant.compute_budgets()
self.assertAlmostEqual(
first=case.expected_pipeline_noise_std,
second=accountant.minimum_noise_std,
places=3,
msg=
f"failed test {case.name} expected pipeline noise {case.expected_pipeline_noise_std} "
f"got {accountant.minimum_noise_std}")
for mechanism_expectations in actual_mechanisms:
expected_mechanism_noise_std, expected_mechanism_epsilon, expected_mechanism_delta, actual_mechanism = mechanism_expectations
self.assertAlmostEqual(
first=expected_mechanism_noise_std,
second=actual_mechanism.noise_standard_deviation,
places=3,
msg=
f"failed test {case.name} expected mechanism noise {expected_mechanism_noise_std} "
f"got {actual_mechanism.noise_standard_deviation}")
if actual_mechanism.mechanism_type == MechanismType.GENERIC:
self.assertAlmostEqual(
first=expected_mechanism_epsilon,
second=actual_mechanism._eps,
places=3,
msg=
f"failed test {case.name} expected mechanism epsilon {expected_mechanism_epsilon} "
f"got {actual_mechanism._eps}")
self.assertAlmostEqual(
first=expected_mechanism_delta,
second=actual_mechanism._delta,
places=3,
msg=
f"failed test {case.name} expected mechanism delta {expected_mechanism_delta} "
f"got {actual_mechanism._delta}")
if __name__ == '__main__':
unittest.main()