-
Notifications
You must be signed in to change notification settings - Fork 580
/
intrinsics.py
1191 lines (1026 loc) · 47.9 KB
/
intrinsics.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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2018, The TensorFlow Federated Authors.
#
# 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.
"""A factory of intrinsics for use in composing federated computations."""
from typing import NoReturn
import warnings
import numpy as np
from tensorflow_federated.python.common_libs import py_typecheck
from tensorflow_federated.python.common_libs import structure
from tensorflow_federated.python.core.impl.compiler import building_block_factory
from tensorflow_federated.python.core.impl.compiler import building_blocks
from tensorflow_federated.python.core.impl.compiler import intrinsic_defs
from tensorflow_federated.python.core.impl.context_stack import context_base
from tensorflow_federated.python.core.impl.context_stack import context_stack_impl
from tensorflow_federated.python.core.impl.context_stack import symbol_binding_context
from tensorflow_federated.python.core.impl.federated_context import value_impl
from tensorflow_federated.python.core.impl.federated_context import value_utils
from tensorflow_federated.python.core.impl.types import array_shape
from tensorflow_federated.python.core.impl.types import computation_types
from tensorflow_federated.python.core.impl.types import placements
from tensorflow_federated.python.core.impl.types import type_analysis
from tensorflow_federated.python.core.impl.types import type_factory
def _bind_comp_as_reference(comp):
fc_context = context_stack_impl.context_stack.current
if not isinstance(fc_context, symbol_binding_context.SymbolBindingContext):
raise context_base.ContextError(
f'Attempted to construct an intrinsic in context {fc_context} which '
' does not support binding references.'
)
return fc_context.bind_computation_to_reference(comp)
def federated_aggregate(
value, zero, accumulate, merge, report
) -> value_impl.Value:
"""Aggregates `value` from `tff.CLIENTS` to `tff.SERVER`.
This generalized aggregation function admits multi-layered architectures that
involve one or more intermediate stages to handle scalable aggregation across
a very large number of participants.
The multi-stage aggregation process is defined as follows:
* Clients are organized into groups. Within each group, a set of all the
member constituents of `value` contributed by clients in the group are first
reduced using reduction operator `accumulate` with `zero` as the zero in the
algebra. If members of `value` are of type `T`, and `zero` (the result of
reducing an empty set) is of type `U`, the reduction operator `accumulate`
used at this stage should be of type `(<U,T> -> U)`. The result of this
stage is a set of items of type `U`, one item for each group of clients.
* Next, the `U`-typed items generated by the preceding stage are merged using
the binary commutative associative operator `merge` of type `(<U,U> -> U)`.
The result of this stage is a single top-level `U` that emerges at the root
of the hierarchy at the `tff.SERVER`. Actual implementations may structure
this step as a cascade of multiple layers.
* Finally, the `U`-typed result of the reduction performed in the preceding
stage is projected into the result value using `report` as the mapping
function (for example, if the structures being merged consist of counters,
this final step might include computing their ratios).
Args:
value: A value of a TFF federated type placed at `tff.CLIENTS` to aggregate.
zero: The zero of type `U` in the algebra of reduction operators, as
described above.
accumulate: The reduction operator to use in the first stage of the process.
If `value` is of type `{T}@CLIENTS`, and `zero` is of type `U`, this
operator should be of type `(<U,T> -> U)`.
merge: The reduction operator to employ in the second stage of the process.
Must be of type `(<U,U> -> U)`, where `U` is as defined above.
report: The projection operator to use at the final stage of the process to
compute the final result of aggregation. If the intended result to be
returned by `tff.federated_aggregate` is of type `R@SERVER`, this operator
must be of type `(U -> R)`.
Returns:
A representation on the `tff.SERVER` of the result of aggregating `value`
using the multi-stage process described above.
Raises:
TypeError: If the arguments are not of the types specified above.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be aggregated'
)
zero = value_impl.to_value(zero, type_spec=None)
py_typecheck.check_type(zero, value_impl.Value)
accumulate = value_impl.to_value(
accumulate,
type_spec=None,
parameter_type_hint=computation_types.StructType([
zero.type_signature,
value.type_signature.member, # pytype: disable=attribute-error
]),
)
merge = value_impl.to_value(
merge,
type_spec=None,
parameter_type_hint=computation_types.StructType(
[accumulate.type_signature.result] # pytype: disable=attribute-error
* 2
),
)
report = value_impl.to_value(
report,
type_spec=None,
parameter_type_hint=merge.type_signature.result, # pytype: disable=attribute-error
)
for op in [accumulate, merge, report]:
py_typecheck.check_type(op, value_impl.Value)
py_typecheck.check_type(op.type_signature, computation_types.FunctionType)
if not accumulate.type_signature.parameter[0].is_assignable_from(
zero.type_signature
): # pytype: disable=attribute-error
raise TypeError(
'Expected `zero` to be assignable to type {}, '
'but was of incompatible type {}.'.format(
accumulate.type_signature.parameter[0], zero.type_signature # pytype: disable=attribute-error
)
)
accumulate_type_expected = type_factory.reduction_op(
accumulate.type_signature.result, # pytype: disable=attribute-error
value.type_signature.member, # pytype: disable=attribute-error
)
merge_type_expected = type_factory.reduction_op(
accumulate.type_signature.result, # pytype: disable=attribute-error
accumulate.type_signature.result, # pytype: disable=attribute-error
)
report_type_expected = computation_types.FunctionType(
merge.type_signature.result, # pytype: disable=attribute-error
report.type_signature.result, # pytype: disable=attribute-error
)
for op_name, op, type_expected in [
('accumulate', accumulate, accumulate_type_expected),
('merge', merge, merge_type_expected),
('report', report, report_type_expected),
]:
if not type_expected.is_assignable_from(op.type_signature):
raise TypeError(
'Expected parameter `{}` to be of type {}, but received {} instead.'
.format(op_name, type_expected, op.type_signature)
)
comp = building_block_factory.create_federated_aggregate(
value.comp, zero.comp, accumulate.comp, merge.comp, report.comp
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_broadcast(value):
"""Broadcasts a federated value from the `tff.SERVER` to the `tff.CLIENTS`.
Args:
value: A value of a TFF federated type placed at the `tff.SERVER`, all
members of which are equal (the `tff.FederatedType.all_equal` property of
`value` is `True`).
Returns:
A representation of the result of broadcasting: a value of a TFF federated
type placed at the `tff.CLIENTS`, all members of which are equal.
Raises:
TypeError: If the argument is not a federated TFF value placed at the
`tff.SERVER`.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.SERVER, 'value to be broadcasted'
)
if not value.type_signature.all_equal: # pytype: disable=attribute-error
raise TypeError('The broadcasted value should be equal at all locations.')
comp = building_block_factory.create_federated_broadcast(value.comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_eval(fn, placement):
"""Evaluates a federated computation at `placement`, returning the result.
Args:
fn: A no-arg TFF computation.
placement: The desired result placement (either `tff.SERVER` or
`tff.CLIENTS`).
Returns:
A federated value with the given placement `placement`.
Raises:
TypeError: If the arguments are not of the appropriate types.
"""
# TODO: b/113112108 - Verify that neither the value, nor any of its parts
# are of a federated type.
fn = value_impl.to_value(fn, type_spec=None)
py_typecheck.check_type(fn, value_impl.Value)
py_typecheck.check_type(fn.type_signature, computation_types.FunctionType)
if fn.type_signature.parameter is not None: # pytype: disable=attribute-error
raise TypeError(
'`federated_eval` expects a `fn` that accepts no arguments, but '
'the `fn` provided has a parameter of type {}.'.format(
fn.type_signature.parameter # pytype: disable=attribute-error
)
)
comp = building_block_factory.create_federated_eval(fn.comp, placement)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_map(fn, arg):
"""Maps a federated value pointwise using a mapping function.
The function `fn` is applied separately across the group of devices
represented by the placement type of `arg`. For example, if `value` has
placement type `tff.CLIENTS`, then `fn` is applied to each client
individually. In particular, this operation does not alter the placement of
the federated value.
Args:
fn: A mapping function to apply pointwise to member constituents of `arg`.
The parameter of this function must be of the same type as the member
constituents of `arg`.
arg: A value of a TFF federated type (or a value that can be implicitly
converted into a TFF federated type, e.g., by zipping) placed at
`tff.CLIENTS` or `tff.SERVER`.
Returns:
A federated value with the same placement as `arg` that represents the
result of `fn` on the member constituent of `arg`.
Raises:
TypeError: If the arguments are not of the appropriate types.
"""
# TODO: b/113112108 - Possibly lift the restriction that the mapped value
# must be placed at the server or clients. Would occur after adding support
# for placement labels in the federated types, and expanding the type
# specification of the intrinsic this is based on to work with federated
# values of arbitrary placement.
arg = value_impl.to_value(arg, type_spec=None)
arg = value_utils.ensure_federated_value(arg, label='value to be mapped')
fn = value_impl.to_value(
fn, type_spec=None, parameter_type_hint=arg.type_signature.member # pytype: disable=attribute-error
)
py_typecheck.check_type(fn, value_impl.Value)
py_typecheck.check_type(fn.type_signature, computation_types.FunctionType)
if not fn.type_signature.parameter.is_assignable_from( # pytype: disable=attribute-error
arg.type_signature.member # pytype: disable=attribute-error
):
raise TypeError(
'The mapping function expects a parameter of type {}, but member '
'constituents of the mapped value are of incompatible type {}.'.format(
fn.type_signature.parameter, # pytype: disable=attribute-error
arg.type_signature.member, # pytype: disable=attribute-error
)
)
# TODO: b/144384398 - Change structure to one that maps the placement type
# to the building_block function that fits it, in a way that allows the
# appropriate type checks.
if arg.type_signature.placement is placements.SERVER: # pytype: disable=attribute-error
if not arg.type_signature.all_equal: # pytype: disable=attribute-error
raise TypeError(
'Arguments placed at {} should be equal at all locations.'.format(
placements.SERVER
)
)
comp = building_block_factory.create_federated_apply(fn.comp, arg.comp)
elif arg.type_signature.placement is placements.CLIENTS: # pytype: disable=attribute-error
comp = building_block_factory.create_federated_map(fn.comp, arg.comp)
else:
raise TypeError(
'Expected `arg` to have a type with a supported placement, '
'found {}.'.format(arg.type_signature.placement) # pytype: disable=attribute-error
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_map_all_equal(fn, arg):
"""`federated_map` with the `all_equal` bit set in the `arg` and return."""
# TODO: b/113112108 - Possibly lift the restriction that the mapped value
# must be placed at the clients after adding support for placement labels
# in the federated types, and expanding the type specification of the
# intrinsic this is based on to work with federated values of arbitrary
# placement.
arg = value_impl.to_value(arg, type_spec=None)
arg = value_utils.ensure_federated_value(
arg, placements.CLIENTS, 'value to be mapped'
)
fn = value_impl.to_value(
fn, type_spec=None, parameter_type_hint=arg.type_signature.member # pytype: disable=attribute-error
)
py_typecheck.check_type(fn, value_impl.Value)
py_typecheck.check_type(fn.type_signature, computation_types.FunctionType)
if not fn.type_signature.parameter.is_assignable_from(
arg.type_signature.member # pytype: disable=attribute-error
): # pytype: disable=attribute-error
raise TypeError(
'The mapping function expects a parameter of type {}, but member '
'constituents of the mapped value are of incompatible type {}.'.format(
fn.type_signature.parameter, # pytype: disable=attribute-error
arg.type_signature.member, # pytype: disable=attribute-error
)
)
comp = building_block_factory.create_federated_map_all_equal(
fn.comp, arg.comp
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_mean(value, weight=None):
"""Computes a `tff.SERVER` mean of `value` placed on `tff.CLIENTS`.
For values `v_1, ..., v_k`, and weights `w_1, ..., w_k`, this means
`sum_{i=1}^k (w_i * v_i) / sum_{i=1}^k w_i`.
Args:
value: The value of which the mean is to be computed. Must be of a TFF
federated type placed at `tff.CLIENTS`. The value may be structured, e.g.,
its member constituents can be named tuples. The tensor types that the
value is composed of must be floating-point or complex.
weight: An optional weight, a TFF federated integer or floating-point tensor
value, also placed at `tff.CLIENTS`.
Returns:
A representation at the `tff.SERVER` of the mean of the member constituents
of `value`, optionally weighted with `weight` if specified (otherwise, the
member constituents contributed by all clients are equally weighted).
Raises:
TypeError: If `value` is not a federated TFF value placed at `tff.CLIENTS`,
or if `weight` is not a federated integer or a floating-point tensor with
the matching placement.
"""
# TODO: b/113112108 - Possibly relax the constraints on numeric types, and
# inject implicit casts where appropriate. For instance, we might want to
# allow `np.int32` values as the input, and automatically cast them to
# `np.float32`` before invoking the average, thus producing a floating-point
# result.
# TODO: b/120439632 - Possibly allow the weight to be either structured or
# non-scalar, e.g., for the case of averaging a convolutional layer, when
# we would want to use a different weight for every filter, and where it
# might be cumbersome for users to have to manually slice and assemble a
# variable.
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be averaged'
)
if not type_analysis.is_average_compatible(value.type_signature):
raise TypeError(
'The value type {} is not compatible with the average operator.'.format(
value.type_signature
)
)
if weight is not None:
weight = value_impl.to_value(weight, type_spec=None)
weight = value_utils.ensure_federated_value(
weight, placements.CLIENTS, 'weight to use in averaging'
)
if (
not isinstance(weight.type_signature, computation_types.FederatedType)
or not isinstance(
weight.type_signature.member, computation_types.TensorType
)
or not array_shape.is_shape_scalar(weight.type_signature.member.shape)
):
raise TypeError(
'The weight type {} is not a federated scalar.'.format(
weight.type_signature
)
)
if not np.issubdtype(
weight.type_signature.member.dtype, # pytype: disable=attribute-error
np.integer,
) and not np.issubdtype(
weight.type_signature.member.dtype, # pytype: disable=attribute-error
np.floating,
):
raise TypeError(
'The weight type {} is not a federated integer or floating-point '
'tensor.'.format(weight.type_signature)
)
weight_comp = None if weight is None else weight.comp
comp = building_block_factory.create_federated_mean(value.comp, weight_comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_min(value: object) -> value_impl.Value:
"""Computes a min at `tff.SERVER` of a `value` placed on the `tff.CLIENTS`.
Args:
value: A value of a TFF federated type placed at the `tff.CLIENTS`.
Returns:
A representation of the min of the member constituents of `value` placed on
the `tff.SERVER`.
Raises:
ValueError: If the argument is not a federated TFF value placed at
`tff.CLIENTS` compatible with min.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to take min of'
)
if not type_analysis.is_min_max_compatible(value.type_signature):
raise ValueError(
'The value type {} is not compatible with the min operator.'.format(
value.type_signature
)
)
comp = building_block_factory.create_federated_min(value.comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_max(value: object) -> value_impl.Value:
"""Computes a max at `tff.SERVER` of a `value` placed on the `tff.CLIENTS`.
Args:
value: A value of a TFF federated type placed at the `tff.CLIENTS`.
Returns:
A representation of the max of the member constituents of `value` placed on
the `tff.SERVER`.
Raises:
ValueError: If the argument is not a federated TFF value placed at
`tff.CLIENTS` compatible with max.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to take max of'
)
if not type_analysis.is_min_max_compatible(value.type_signature):
raise ValueError(
'The value type {} is not compatible with the max operator.'.format(
value.type_signature
)
)
comp = building_block_factory.create_federated_max(value.comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_sum(value):
"""Computes a sum at `tff.SERVER` of a `value` placed on the `tff.CLIENTS`.
To sum integer values with stronger privacy properties, consider using
`tff.federated_secure_sum_bitwidth`.
Args:
value: A value of a TFF federated type placed at the `tff.CLIENTS`.
Returns:
A representation of the sum of the member constituents of `value` placed
on the `tff.SERVER`.
Raises:
TypeError: If the argument is not a federated TFF value placed at
`tff.CLIENTS`.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be summed'
)
type_analysis.check_is_sum_compatible(value.type_signature)
comp = building_block_factory.create_federated_sum(value.comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_value(value, placement):
"""Returns a federated value at `placement`, with `value` as the constituent.
Deprecation warning: Using `tff.federated_value` with arguments other than
simple Python constants is deprecated. When placing the result of a
`tff.tensorflow.computation`, prefer `tff.federated_eval`.
Args:
value: A value of a non-federated TFF type to be placed.
placement: The desired result placement (either `tff.SERVER` or
`tff.CLIENTS`).
Returns:
A federated value with the given placement `placement`, and the member
constituent `value` equal at all locations.
Raises:
TypeError: If the arguments are not of the appropriate types.
"""
if isinstance(value, value_impl.Value):
warnings.warn(
(
'Deprecation warning: Using `tff.federated_value` with arguments'
' other than simple Python constants is deprecated. When placing'
' the result of a `tff.tensorflow.computation`, prefer'
' `tff.federated_eval`.'
),
DeprecationWarning,
)
value = value_impl.to_value(value, type_spec=None)
if type_analysis.contains(
value.type_signature,
lambda t: isinstance(t, computation_types.FederatedType),
):
raise TypeError(
'Cannot place value {} containing federated types at '
'another placement; requested to be placed at {}.'.format(
value, placement
)
)
comp = building_block_factory.create_federated_value(value.comp, placement)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_zip(value):
"""Converts an N-tuple of federated values into a federated N-tuple value.
Args:
value: A value of a TFF named tuple type, the elements of which are
federated values with the same placement.
Returns:
A federated value placed at the same location as the members of `value`, in
which every member component is a named tuple that consists of the
corresponding member components of the elements of `value`.
Raises:
TypeError: If the argument is not a named tuple of federated values with the
same placement.
"""
# TODO: b/113112108 - We use the iterate/unwrap approach below because
# our type system is not powerful enough to express the concept of
# "an operation that takes tuples of T of arbitrary length", and therefore
# the intrinsic federated_zip must only take a fixed number of arguments,
# here fixed at 2. There are other potential approaches to getting around
# this problem (e.g. having the operator act on sequences and thereby
# sidestepping the issue) which we may want to explore.
value = value_impl.to_value(value, type_spec=None)
py_typecheck.check_type(value, value_impl.Value)
py_typecheck.check_type(value.type_signature, computation_types.StructType)
comp = building_block_factory.create_federated_zip(value.comp)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def _select_parameter_mismatch(
param_type,
type_desc,
name,
secure,
expected_type=None,
) -> NoReturn:
"""Throws a `TypeError` indicating a mismatched `select` parameter type."""
secure_string = '_secure' if secure else ''
intrinsic_name = f'federated{secure_string}_select'
message = f'Expected `{intrinsic_name}` parameter `{name}` to be {type_desc}'
if expected_type is None:
raise TypeError(f'{message}, found value of type {param_type}')
else:
raise TypeError(
f'{message}:\n'
+ computation_types.type_mismatch_error_message(
param_type,
expected_type,
computation_types.TypeRelation.ASSIGNABLE,
second_is_expected=True,
)
)
def _check_select_keys_type(
keys_type: computation_types.Type, secure: bool
) -> None:
"""Checks the federated select keys types."""
if (
not isinstance(keys_type, computation_types.FederatedType)
or keys_type.placement is not placements.CLIENTS
):
_select_parameter_mismatch(
keys_type, 'a federated value placed at clients', 'client_keys', secure
)
if not (
isinstance(keys_type.member, computation_types.TensorType)
and keys_type.member.dtype == np.int32
and len(keys_type.member.shape) == 1
and keys_type.member.shape[0] is not None
):
_select_parameter_mismatch(
keys_type.member, # pytype: disable=attribute-error
'a rank-1 tensor with statically known shape and `np.int32` dtype',
'client_keys.type_signature.member',
secure,
)
def federated_select(client_keys, max_key, server_val, select_fn):
"""Sends selected values from a server database to clients.
Args:
client_keys: `tff.CLIENTS`-placed one-dimensional fixed-size non-negative
`int32` keys used to select values from `database` to load for each
client.
max_key: A `tff.SERVER`-placed `int32` indicating the maximum value of any
of `client_keys` (so that all client keys are in the range `[0, max_key]`,
inclusive). Lower values may permit more optimizations.
server_val: `tff.SERVER`-placed value used as an input to `select_fn`.
select_fn: A `tff.Computation` which accepts unplaced `server_val` and a
`int32` client key and returns a value to be sent to the client.
`select_fn` should be deterministic (nonrandom).
Returns:
`tff.CLIENTS`-placed sequences of values returned from `select_fn`. In each
sequence, the order of values will match the order of keys in the
corresponding `client_keys` tensor. For example, a client with keys
`[1, 2, ...]` will receive a sequence of values
`[select_fn(server_val, 1), select_fn(server_val, 2), ...]`.
Raises:
TypeError: If `client_keys` is not of type `{int32[N]}@CLIENTS`, if
`max_key` is not of type `int32@SERVER`, if `server_val` is not a
server-placed value (`S@SERVER`), or if `select_fn` is not a function
of type `<S, int32> -> RESULT`.
"""
return _federated_select(
client_keys, max_key, server_val, select_fn, secure=False
)
def federated_secure_select(client_keys, max_key, server_val, select_fn):
"""Sends privately-selected values from a server database to clients.
Args:
client_keys: `tff.CLIENTS`-placed one-dimensional fixed-size non-negative
`int32` keys used to select values from `database` to load for each
client.
max_key: A `tff.SERVER`-placed `int32` which is guaranteed to be greater
than any of `client_keys`. Lower values may permit more optimizations.
server_val: `tff.SERVER`-placed value used as an input to `select_fn`.
select_fn: A `tff.Computation` which accepts unplaced `server_val` and a
`int32` client key and returns a value to be sent to the client.
`select_fn` should be deterministic (nonrandom).
Returns:
`tff.CLIENTS`-placed sequences of values returned from `select_fn`. In each
sequence, the order of values will match the order of keys in the
corresponding `client_keys` tensor. For example, a client with keys
`[1, 2, ...]` will receive a sequence of values
`[select_fn(server_val, 1), select_fn(server_val, 2), ...]`.
Raises:
TypeError: If `client_keys` is not of type `{int32[N]}@CLIENTS`, if
`max_key` is not of type `int32@SERVER`, if `server_val` is not a
server-placed value (`S@SERVER`), or if `select_fn` is not a function
of type `<S, int32> -> RESULT`.
"""
return _federated_select(
client_keys, max_key, server_val, select_fn, secure=True
)
def _federated_select(client_keys, max_key, server_val, select_fn, secure):
"""Internal helper for `federated_select` and `federated_secure_select`."""
client_keys = value_impl.to_value(client_keys, type_spec=None)
_check_select_keys_type(client_keys.type_signature, secure)
max_key = value_impl.to_value(max_key, type_spec=None)
expected_max_key_type = computation_types.FederatedType(
np.int32, placements.SERVER
)
if not expected_max_key_type.is_assignable_from(max_key.type_signature):
_select_parameter_mismatch(
max_key.type_signature,
'a 32-bit unsigned integer placed at server',
'max_key',
secure,
expected_type=expected_max_key_type,
)
server_val = value_impl.to_value(server_val, type_spec=None)
server_val = value_utils.ensure_federated_value(
server_val, label='server_val'
)
expected_server_val_type = computation_types.FederatedType(
computation_types.AbstractType('T'), placements.SERVER
)
if (
not isinstance(server_val.type_signature, computation_types.FederatedType)
or server_val.type_signature.placement is not placements.SERVER
):
_select_parameter_mismatch(
server_val.type_signature,
'a value placed at server',
'server_val',
secure,
expected_type=expected_server_val_type,
)
select_fn_param_type = computation_types.to_type(
[server_val.type_signature.member, np.int32] # pytype: disable=attribute-error
)
select_fn = value_impl.to_value(
select_fn, type_spec=None, parameter_type_hint=select_fn_param_type
)
expected_select_fn_type = computation_types.FunctionType(
select_fn_param_type, computation_types.AbstractType('U')
)
if not isinstance(
select_fn.type_signature, computation_types.FunctionType
) or not select_fn.type_signature.parameter.is_assignable_from(
select_fn_param_type
):
_select_parameter_mismatch(
select_fn.type_signature,
'a function from state and key to result',
'select_fn',
secure,
expected_type=expected_select_fn_type,
)
comp = building_block_factory.create_federated_select(
client_keys.comp, max_key.comp, server_val.comp, select_fn.comp, secure
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_secure_modular_sum(value, modulus):
"""Computes a modular sum at `tff.SERVER` of a `value` from `tff.CLIENTS`.
This function computes a sum such that it should not be possible for the
server to learn any clients individual value. The specific algorithm and
mechanism used to compute the secure sum may vary depending on the target
runtime environment the computation is compiled for or executed on. See
https://research.google/pubs/pub47246/ for more information.
Not all executors support `tff.federated_secure_modular_sum()`; consult the
documentation for the specific executor or executor stack you plan on using
for the specific of how it's handled by that executor.
The `modulus` argument is the modulus under which the client values are added.
The result of this function will be equivalent to `SUM(value) % modulus`.
*Lower values may allow for improved communication efficiency.*
Example:
```python
value = tff.federated_value(5, tff.CLIENTS)
result = tff.federated_secure_modular_sum(value, 3)
# `result == (5 * num_clients % 3)@SERVER`
value = tff.federated_value((3, 9), tff.CLIENTS)
result = tff.federated_secure_modular_sum(value, (100, 200))
# `result == (3 * num_clients % 100, 9 * num_clients % 100)@SERVER`
```
Note: To sum non-integer values or to sum integers with fewer constraints and
weaker privacy properties, consider using `federated_sum`.
Args:
value: An integer or nested structure of integers placed at `tff.CLIENTS`.
Values outside of the range [0, modulus-1] will be considered equivalent
to mod(value, modulus), i.e. they will be projected into the range [0,
modulus-1] as part of the modular summation.
modulus: A Python integer or nested structure of integers matching the
structure of `value`. If integer `modulus` is used with a nested `value`,
the same integer is used for each tensor in `value`.
Returns:
A representation of the modular sum of the member constituents of `value`
placed on the `tff.SERVER`. The resulting modular sum will be on the range
[0, modulus-1].
Raises:
TypeError: If the argument is not a federated TFF value placed at
`tff.CLIENTS`.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be summed'
)
type_analysis.check_is_structure_of_integers(value.type_signature)
modulus_value = value_impl.to_value(modulus, type_spec=None)
value_member_type = value.type_signature.member # pytype: disable=attribute-error
modulus_type = modulus_value.type_signature
if not type_analysis.is_single_integer_or_matches_structure(
modulus_type, value_member_type
):
raise TypeError(
'Expected `federated_secure_sum` parameter `modulus` to match '
'the structure of `value`, with one integer max per tensor in '
'`value`. Found `value` of `{}` and `modulus` of `{}`.'.format(
value_member_type, modulus_type
)
)
if isinstance(modulus_type, computation_types.TensorType) and isinstance(
value_member_type, computation_types.StructType
):
modulus_value = value_impl.to_value(
structure.map_structure(lambda _: modulus, value_member_type),
type_spec=None,
)
comp = building_block_factory.create_federated_secure_modular_sum(
value.comp, modulus_value.comp
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_secure_sum(value, max_input):
"""Computes a sum at `tff.SERVER` of a `value` placed on the `tff.CLIENTS`.
This function computes a sum such that it should not be possible for the
server to learn any clients individual value. The specific algorithm and
mechanism used to compute the secure sum may vary depending on the target
runtime environment the computation is compiled for or executed on. See
https://research.google/pubs/pub47246/ for more information.
Not all executors support `tff.federated_secure_sum()`; consult the
documentation for the specific executor or executor stack you plan on using
for the specific of how it's handled by that executor.
The `max_input` argument is the maximum value (inclusive) that may appear in
`value`. *Lower values may allow for improved communication efficiency.*
Attempting to return a `value` higher than `max_input` is invalid, and will
result in a failure at the given client.
Example:
```python
value = tff.federated_value(1, tff.CLIENTS)
result = tff.federated_secure_sum(value, 1)
value = tff.federated_value((1, 2), tff.CLIENTS)
result = tff.federated_secure_sum(value, (1, 2))
```
Note: To sum non-integer values or to sum integers with fewer constraints and
weaker privacy properties, consider using `federated_sum`.
Args:
value: An integer or nested structure of integers placed at `tff.CLIENTS`,
in the range `[0, max_input]`.
max_input: A Python integer or nested structure of integers matching the
structure of `value`. If integer `max_value` is used with a nested
`value`, the same integer is used for each tensor in `value`.
Returns:
A representation of the sum of the member constituents of `value` placed
on the `tff.SERVER`.
Raises:
TypeError: If the argument is not a federated TFF value placed at
`tff.CLIENTS`.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be summed'
)
type_analysis.check_is_structure_of_integers(value.type_signature)
max_input_value = value_impl.to_value(max_input, type_spec=None)
value_member_type = value.type_signature.member # pytype: disable=attribute-error
max_input_type = max_input_value.type_signature
if not type_analysis.is_single_integer_or_matches_structure(
max_input_type, value_member_type
):
raise TypeError(
'Expected `federated_secure_sum` parameter `max_input` to match '
'the structure of `value`, with one integer max per tensor in '
'`value`. Found `value` of `{}` and `max_input` of `{}`.'.format(
value_member_type, max_input_type
)
)
if isinstance(max_input_type, computation_types.TensorType) and isinstance(
value_member_type, computation_types.StructType
):
max_input_value = value_impl.to_value(
structure.map_structure(lambda _: max_input, value_member_type),
type_spec=None,
)
comp = building_block_factory.create_federated_secure_sum(
value.comp, max_input_value.comp
)
comp = _bind_comp_as_reference(comp)
return value_impl.Value(comp)
def federated_secure_sum_bitwidth(value, bitwidth):
"""Computes a sum at `tff.SERVER` of a `value` placed on the `tff.CLIENTS`.
This function computes a sum such that it should not be possible for the
server to learn any clients individual value. The specific algorithm and
mechanism used to compute the secure sum may vary depending on the target
runtime environment the computation is compiled for or executed on. See
https://research.google/pubs/pub47246/ for more information.
Not all executors support `tff.federated_secure_sum_bitwidth()`; consult the
documentation for the specific executor or executor stack you plan on using
for the specific of how it's handled by that executor.
The `bitwidth` argument represents the bitwidth of the aggregand, that is the
bitwidth of the input `value`. The federated secure sum bitwidth (i.e., the
bitwidth of the *sum* of the input `value`s over all clients) will be a
function of this bitwidth and the number of participating clients.
Example:
```python
value = tff.federated_value(1, tff.CLIENTS)
result = tff.federated_secure_sum_bitwidth(value, 2)
value = tff.federated_value([1, 1], tff.CLIENTS)
result = tff.federated_secure_sum_bitwidth(value, [2, 4])
value = tff.federated_value([1, [1, 1]], tff.CLIENTS)
result = tff.federated_secure_sum_bitwidth(value, [2, [4, 8]])
```
Note: To sum non-integer values or to sum integers with fewer constraints and
weaker privacy properties, consider using `federated_sum`.
Args:
value: An integer value of a TFF federated type placed at the `tff.CLIENTS`,
in the range [0, 2^bitwidth - 1].
bitwidth: An integer or nested structure of integers matching the structure
of `value`. If integer `bitwidth` is used with a nested `value`, the same
integer is used for each tensor in `value`.
Returns:
A representation of the sum of the member constituents of `value` placed
on the `tff.SERVER`.
Raises:
TypeError: If the argument is not a federated TFF value placed at
`tff.CLIENTS`.
"""
value = value_impl.to_value(value, type_spec=None)
value = value_utils.ensure_federated_value(
value, placements.CLIENTS, 'value to be summed'
)
type_analysis.check_is_structure_of_integers(value.type_signature)
bitwidth_value = value_impl.to_value(bitwidth, type_spec=None)
value_member_type = value.type_signature.member # pytype: disable=attribute-error
bitwidth_type = bitwidth_value.type_signature
if not type_analysis.is_single_integer_or_matches_structure(
bitwidth_type, value_member_type
):
raise TypeError(
'Expected `federated_secure_sum_bitwidth` parameter `bitwidth` to '
'match the structure of `value`, with one integer bitwidth per tensor '
'in `value`. Found `value` of `{}` and `bitwidth` of `{}`.'.format(
value_member_type, bitwidth_type
)
)
if isinstance(bitwidth_type, computation_types.TensorType) and isinstance(
value_member_type, computation_types.StructType
):
bitwidth_value = value_impl.to_value(
structure.map_structure(lambda _: bitwidth, value_member_type),
type_spec=None,
)
comp = building_block_factory.create_federated_secure_sum_bitwidth(
value.comp, bitwidth_value.comp