tff.framework.ExecutionContext

See Stable See Nightly

Represents an execution context backed by an executor_base.Executor.

Inherits From: Context

tff.framework.ExecutionContext(
    executor_fn: tff.framework.ExecutorFactory,
    compiler_fn: Optional[Callable[[computation_base.Computation], Any]] = None
)

Used in the notebooks

Used in the tutorials
Custom Federated Algorithms, Part 2: Implementing Federated Averaging TFF for Federated Learning Research: Model and Update Compression

Args
executor_fn	Instance of executor_factory.ExecutorFactory.
compiler_fn	A Python function that will be used to compile a computation.

Attributes
executor_factory

Methods

ingest

View source

ingest(
    val, type_spec
)

Ingests value 'val' given the expected type type_spec.

This function is invoked on Python call arguments and/or their constituents to translate them into a form that can be used in the given context. This is performed in the process of handling a computation's __call__(), while bundling arguments together, and prior to calling invoke().

Args
val	An object that represents the value to ingest in the given context.
type_spec	The tff.Type of the value represented by this object.

Returns
The result of ingestion, which is context-dependent.

invoke

View source

invoke(
    comp, arg
)

Invokes computation comp with argument arg.

Prior to calling invoke, the argument arg or its constituents must have been ingested by the context by calling ingest.

Args
comp	The computation being invoked. The Python type of comp expected here (e.g., pb.Computation. ComputationImpl, or other) may depend on the context. It is the responsibility of the concrete implementation of this interface to verify that the type of comp matches what the context is expecting.
arg	The optional argument of the call (possibly an argument tuple with a nested structure), or None if no argument was supplied. Computations accept arguments in a variety of forms, but those are first ingested by calling ingest() above, then bundled together into a single object before calling invoke() in the given context.

Returns
The result of invocation, which is context-dependent.