tff.framework.Literal

View source on GitHub

A representation of a literal in TFF's internal language.

Inherits From: ComputationBuildingBlock, TypedObject

tff.framework.Literal(
    value: array.Array,
    type_signature: tff.types.TensorType
)

Args
value	The value of the literal.
type_signature	A tff.TensorType.

Raises
ValueError	If value is not compatible with type_signature.

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).
value

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

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.