-
Notifications
You must be signed in to change notification settings - Fork 579
/
cardinality_carrying_base.py
33 lines (28 loc) · 1.23 KB
/
cardinality_carrying_base.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
# Copyright 2021, 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.
"""Asbtract interface for objects that carry information about cardinality."""
import abc
class CardinalityCarrying(metaclass=abc.ABCMeta):
"""Asbtract interface for objects that carry information about cardinality."""
@property
@abc.abstractmethod
def cardinality(self):
"""Returns the cardinality information associated with this object.
Returns:
A dictionary in which the keys are placements, and values are integers
that indicate the cardinalities associated with these placements. The
cardinality payload might contain cardinalities for zero, one, or more
than one placement.
"""
raise NotImplementedError