tff.types.StructType

An implementation of tff.Type representing structural types in TFF.

Inherits From: Struct, Type

tff.types.StructType(
    elements: Iterable[object], *, convert: bool = True
)

Used in the notebooks

Used in the tutorials

Elements initialized by name can be accessed as foo.name, and otherwise by index, foo[index].

elements An iterable of element specifications. Each element specification is either a type spec (an instance of tff.Type or something convertible to it via tff.types.to_type) for the element, or a (name, spec) for elements that have defined names. Alternatively, one can supply here an instance of collections.OrderedDict mapping element names to their types (or things that are convertible to types).
convert A flag to determine if the elements should be converted using tff.types.to_type or not.

python_container

Methods

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_identical_to

View source

check_identical_to(
    other: 'Type'
) -> None

Raises if other and Type are not exactly identical.

children

View source

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

is_assignable_from(
    source_type: tff.types.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.

named

View source

@classmethod
named(
    **kwargs
) -> 'Struct'

Constructs a new Struct with all named elements.

unnamed

View source

@classmethod
unnamed(
    *args
) -> 'Struct'

Constructs a new Struct with all unnamed elements.

__eq__

View source

__eq__(
    other
)

Return self==value.

__getitem__

View source

__getitem__(
    key: Union[int, str, slice]
) -> _T

__iter__

View source

__iter__() -> Iterator[_T]

__len__

View source

__len__() -> int

__ne__

View source

__ne__(
    other: object
) -> bool

Return self!=value.