tff.framework.Struct

A struct with named or unnamed elements in TFF's internal language.

Inherits From: ComputationBuildingBlock, TypedObject, Struct

tff.framework.Struct(
    elements, container_type=None
)

The concise notation for structs is <name_1=value_1, ...., name_n=value_n> for structs with named elements, <value_1, ..., value_n> for structs with unnamed elements, or a mixture of these for structs with some named and some unnamed elements, where name_k are the names, and value_k are the value expressions.

For example, a lambda expression that applies fn to elements of 2-structs pointwise could be represented as (arg -> <fn(arg[0]),fn(arg[1])>).

Args
elements	The elements of the struct, supplied as a list of (name, value) pairs, where 'name' can be None in case the corresponding element is not named and only accessible via an index (see also structure.Struct).
container_type	An optional Python container type to associate with the struct.

Raises
TypeError	if arguments are of the wrong types.

Attributes
proto	Returns a serialized form of this object as a pb.Computation instance.
type_signature	Returns the TFF type of this object (an instance of tff.Type).

Methods

check_block

View source

check_block()

Check that this is a 'Block'.

check_call

View source

check_call()

Check that this is a 'Call'.

check_compiled_computation

View source

check_compiled_computation()

Check that this is a 'CompiledComputation'.

check_data

View source

check_data()

Check that this is a 'Data'.

check_intrinsic

View source

check_intrinsic()

Check that this is an 'Intrinsic'.

check_lambda

View source

check_lambda()

Check that this is a 'Lambda'.

check_placement

View source

check_placement()

Check that this is a 'Placement'.

check_reference

View source

check_reference()

Check that this is a 'Reference'.

check_selection

View source

check_selection()

Check that this is a 'Selection'.

check_struct

View source

check_struct()

Check that this is a Struct.

children

View source

children() -> Iterator[tff.framework.ComputationBuildingBlock]

Returns an iterator yielding immediate child building blocks.

compact_representation

View source

compact_representation()

Returns the compact string representation of this building block.

formatted_representation

View source

formatted_representation()

Returns the formatted string representation of this building block.

from_proto

View source

@classmethod
from_proto(
    computation_proto: pb.Computation
) -> 'Struct'

Returns an instance of a derived class based on 'computation_proto'.

Args
computation_proto	An instance of pb.Computation.

Returns
An instance of a class that implements 'ComputationBuildingBlock' and that contains the deserialized logic from in 'computation_proto'.

Raises
NotImplementedError	if computation_proto contains a kind of computation for which deserialization has not been implemented yet.
ValueError	if deserialization failed due to the argument being invalid.

is_block

View source

is_block()

Returns whether or not this block is a Block.

is_call

View source

is_call()

Returns whether or not this block is a Call.

is_compiled_computation

View source

is_compiled_computation()

Returns whether or not this block is a CompiledComputation.

is_data

View source

is_data()

Returns whether or not this block is a Data.

is_intrinsic

View source

is_intrinsic()

Returns whether or not this block is an Intrinsic.

is_lambda

View source

is_lambda()

Returns whether or not this block is a Lambda.

is_placement

View source

is_placement()

Returns whether or not this block is a Placement.

is_reference

View source

is_reference()

Returns whether or not this block is a Reference.

is_selection

View source

is_selection()

Returns whether or not this block is a Selection.

is_struct

View source

is_struct()

Returns whether or not this block is a Struct.

named

View source

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

Constructs a new Struct with all named elements.

structural_representation

View source

structural_representation()

Returns the structural string representation of this building block.

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]
)

__iter__

View source

__iter__()

__len__

View source

__len__()

__ne__

View source

__ne__(
    other
)

Return self!=value.