![]() |
An implementation of tff.Type
representing federated types in TFF.
Inherits From: Type
tff.types.FederatedType(
member: object,
placement: tff.framework.PlacementLiteral
,
all_equal: Optional[bool] = None
)
Used in the notebooks
Used in the tutorials |
---|
Args | |
---|---|
member
|
An instance of tff.Type or something convertible to it, that
represents the type of the member components of each value of this
federated type.
|
placement
|
The specification of placement that the member components of
this federated type are hosted on. Must be either a placement literal
such as tff.SERVER or tff.CLIENTS to refer to a globally defined
placement, or a placement label to refer to a placement defined in other
parts of a type signature. Specifying placement labels is not
implemented yet.
|
all_equal
|
A bool value that indicates whether all members of the
federated type are equal (True ), or are allowed to differ (False ).
If all_equal is None , the value is selected as the default for the
placement, e.g., True for tff.SERVER and False for tff.CLIENTS .
|
Attributes | |
---|---|
all_equal
|
|
member
|
|
placement
|
Methods
check_abstract
check_abstract() -> None
Check that this is a tff.AbstractType
.
check_assignable_from
check_assignable_from(
source_type: 'Type'
) -> None
Raises if values of source_type
cannot be cast to this type.
check_equivalent_to
check_equivalent_to(
other: 'Type'
) -> None
Raises if values of 'other' cannot be cast to and from this type.
check_federated
check_federated() -> None
Check that this is a tff.FederatedType
.
check_function
check_function() -> None
Check that this is a tff.FunctionType
.
check_identical_to
check_identical_to(
other: 'Type'
) -> None
Raises if other
and Type
are not exactly identical.
check_placement
check_placement() -> None
Check that this is a tff.PlacementType
.
check_sequence
check_sequence() -> None
Check that this is a tff.SequenceType
.
check_struct
check_struct() -> None
Check that this is a tff.StructType
.
check_struct_with_python
check_struct_with_python() -> None
Check that this is a tff.StructWithPythonType
.
check_tensor
check_tensor() -> None
Check that this is a tff.TensorType
.
children
children()
Returns a generator yielding immediate child types.
compact_representation
compact_representation() -> str
Returns the compact string representation of this type.
formatted_representation
formatted_representation() -> str
Returns the formatted string representation of this type.
is_abstract
is_abstract() -> bool
Returns whether or not this type is a tff.AbstractType
.
is_assignable_from
is_assignable_from(
source_type: tff.types.Type
) -> bool
Returns whether values of source_type
can be cast to this type.
is_equivalent_to
is_equivalent_to(
other: 'Type'
) -> bool
Returns whether values of other
can be cast to and from this type.
is_federated
is_federated() -> bool
Returns whether or not this type is a tff.FederatedType
.
is_function
is_function() -> bool
Returns whether or not this type is a tff.FunctionType
.
is_identical_to
is_identical_to(
other: 'Type'
) -> bool
Returns whether or not self
and other
are exactly identical.
is_placement
is_placement() -> bool
Returns whether or not this type is a tff.PlacementType
.
is_sequence
is_sequence() -> bool
Returns whether or not this type is a tff.SequenceType
.
is_struct
is_struct() -> bool
Returns whether or not this type is a tff.StructType
.
is_struct_with_python
is_struct_with_python() -> bool
Returns whether or not this type is a tff.StructWithPythonType
.
is_tensor
is_tensor() -> bool
Returns whether or not this type is a tff.TensorType
.
__eq__
__eq__(
other
)
Determines whether two type definitions are identical.
Note that this notion of equality is stronger than equivalence. Two types with equivalent definitions may not be identical, e.g., if they represent templates with differently named type variables in their definitions.
Args | |
---|---|
other
|
The other type to compare against. |
Returns | |
---|---|
True if type definitions are syntactically identical (as defined above),
otherwise False .
|
Raises | |
---|---|
NotImplementedError
|
If not implemented in the derived class. |
__ne__
__ne__(
other
)
Return self!=value.