tff.framework.Data

A representation of data (an input pipeline).

Inherits From: ComputationBuildingBlock, TypedObject

tff.framework.Data(
    content: any_pb2.Any, type_spec: object
)

This class does not deal with parsing data protos and verifying correctness, it is only a container. Parsing and type analysis are a responsibility or a component external to this module.

content The proto that characterizes the data.
type_spec Either the types.Type that represents the type of this data, or something convertible to it by types.to_type().

TypeError if the arguments are of the wrong types.
ValueError if the user tries to specify an empty URI.

content

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

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
) -> 'Data'

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.

__eq__

View source

__eq__(
    other: object
) -> bool

Return self==value.