tff.framework.CompiledComputation

View source on GitHub

A representation of a fully constructed and serialized computation.

Inherits From: ComputationBuildingBlock, TypedObject

tff.framework.CompiledComputation(
    proto: pb.Computation,
    name: Optional[str] = None,
    type_signature: Optional[tff.types.Type] = None
)

A compile comutation is one that has not been parsed into constituents, and is simply represented as an embedded Computation protocol buffer. Whereas technically, any computation can be represented and passed around this way, this structure is generally only used to represent TensorFlow sections, for which otherwise there isn't any dedicated structure.

Args
proto	An instance of pb.Computation with the computation logic.
name	An optional string name to associate with this computation, used only for debugging purposes. If the name is not specified (None), it is autogenerated as a hexadecimal string from the hash of the proto.
type_signature	An optional type signature to associate with this computation rather than the serialized one.

Raises
TypeError	if the arguments are of the wrong types.

Attributes
name
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
) -> 'ComputationBuildingBlock'

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.

structural_representation

View source

structural_representation()

Returns the structural string representation of this building block.