tff.types.Type

An abstract interface for all classes that represent TFF types.

Methods

check_abstract

View source

check_abstract() -> None

Check that this is a tff.AbstractType.

check_assignable_from

View source

check_assignable_from(
    source_type: 'Type'
) -> None

Raises if values of source_type cannot be cast to this type.

check_equivalent_to

View source

check_equivalent_to(
    other: 'Type'
) -> None

Raises if values of 'other' cannot be cast to and from this type.

check_federated

View source

check_federated() -> None

Check that this is a tff.FederatedType.

check_function

View source

check_function() -> None

Check that this is a tff.FunctionType.

check_identical_to

View source

check_identical_to(
    other: 'Type'
) -> None

Raises if other and Type are not exactly identical.

check_placement

View source

check_placement() -> None

Check that this is a tff.PlacementType.

check_sequence

View source

check_sequence() -> None

Check that this is a tff.SequenceType.

check_struct

View source

check_struct() -> None

Check that this is a tff.StructType.

check_struct_with_python

View source

check_struct_with_python() -> None

Check that this is a tff.StructWithPythonType.

check_tensor

View source

check_tensor() -> None

Check that this is a tff.TensorType.

children

View source

@abc.abstractmethod
children() -> Iterator['Type']

Returns a generator yielding immediate child types.

compact_representation

View source

compact_representation() -> str

Returns the compact string representation of this type.

formatted_representation

View source

formatted_representation() -> str

Returns the formatted string representation of this type.

is_assignable_from

View source

@abc.abstractmethod
is_assignable_from(
    source_type: 'Type'
) -> bool

Returns whether values of source_type can be cast to this type.

is_equivalent_to

View source

is_equivalent_to(
    other: 'Type'
) -> bool

Returns whether values of other can be cast to and from this type.

is_identical_to

View source

is_identical_to(
    other: 'Type'
) -> bool

Returns whether or not self and other are exactly identical.

__eq__

View source

@abc.abstractmethod
__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__

View source

__ne__(
    other
)

Return self!=value.