tff.framework.Placement

View source on GitHub

Class Placement

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

Inherits From: ComputationBuildingBlock

Currently this can only be tff.SERVER or tff.CLIENTS.

__init__

View source

__init__(literal)

Constructs a new placement instance for the given placement literal.

Args:

  • literal: The placement literal.

Raises:

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

Properties

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

uri

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

@classmethod
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.