tff.framework.RemoteExecutor

The remote executor is a local proxy for a remote executor instance.

tff.framework.RemoteExecutor(
    stub: tff.framework.RemoteExecutorStub,
    dispose_batch_size=20,
    stream_structs: bool = False
)

stub An instance of stub used for communication with the remote executor service.
dispose_batch_size The batch size for requests to dispose of remote worker values. Lower values will result in more requests to the remote worker, but will result in values being cleaned up sooner and therefore may result in lower memory usage on the remote worker.
stream_structs The flag to enable decomposing and streaming struct values.

Methods

close

View source

close()

Release resources associated with this Executor, if any.

If the executor has one or more target Executors, implementation of this method must close them.

create_call

View source

create_call(
    comp, arg=None
)

A coroutine that creates a call to comp with optional argument arg.

Args
comp The computation to invoke. It must have been first embedded in the executor by calling create_value() on it first.
arg An optional argument of the call, or None if no argument was supplied. If it is present, it must have been embedded in the executor by calling create_value() on it first.

Returns
An instance of ExecutorValue that represents the constructed call.

create_selection

View source

create_selection(
    source, index
)

A coroutine that creates a selection from source.

Args
source The source to select from. The source must have been embedded in this executor by invoking create_value() on it first.
index An integer index to select.

Returns
An instance of ExecutorValue that represents the constructed selection.

create_struct

View source

create_struct(
    elements
)

A coroutine that creates a tuple of elements.

Args
elements A collection of ExecutorValues to create a tuple from. The collection may be of any kind accepted by structure.from_container, including dictionaries and lists. The ExecutorValues in the container must have been created by calling create_value on this executor.

Returns
An instance of ExecutorValue that represents the constructed tuple.

create_value

View source

create_value(
    value, type_spec=None
)

A coroutine that creates embedded value from value of type type_spec.

This function is used to embed a value within the executor. The argument can be one of the plain Python types, a nested structure, a representation of a TFF computation, etc. Once embedded, the value can be further passed around within the executor. For functional values, embedding them prior to invocation potentially allows the executor to amortize overhead across multiple calls.

Args
value An object that represents the value to embed within the executor.
type_spec An optional tff.Type of the value represented by this object, or something convertible to it. The type can only be omitted if the value is a instance of tff.TypedObject.

Returns
An instance of ExecutorValue that represents the embedded value.

create_value_stream_structs

View source

create_value_stream_structs(
    value, type_spec
)

set_cardinalities

View source

set_cardinalities(
    cardinalities: Mapping[tff.framework.PlacementLiteral, int]
)