tff.framework.CompiledComputation

View source on GitHub

Class CompiledComputation

A representation of a fully constructed and serialized computation.

Inherits From: ComputationBuildingBlock

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.

__init__

View source

__init__(
    proto,
    name=None
)

Creates a representation of a fully constructed computation.

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.

Raises:

  • TypeError: if the arguments are of the wrong types.

Properties

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

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

from_proto(
    cls,
    computation_proto
)

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.

structural_representation

View source

structural_representation()

Returns the structural string representation of this building block.