tff.framework.FederatedComposingStrategy

A strategy for composing federated types and intrinsics in disjoint scopes.

Inherits From: FederatingStrategy

tff.framework.FederatedComposingStrategy(
    executor: tff.framework.FederatingExecutor,
    server_executor: tff.framework.Executor,
    target_executors: List[tff.framework.Executor]
)

This strategy implements the FederatingStrategy interface and provides logic for handling federated types and federated intrinsics on an underlying collection of target executors. This strategy can be used in hierarchical aggregation structures with federating executors handling disjoint scopes at the leafs.

This strategy only supports the placements:

executor A federating_executor.FederatingExecutor to use to handle unplaced types, computations, and processing.
server_executor The parent executor to use for all processing at the parent, such as combining values from child executors, unplaced and server-side processing, etc.
target_executors The list of executors that manage disjoint scopes to combine in this executor, delegate to and collect or aggregate from.

TypeError If server_executor is not an executor_base.Executor or if target_executors is not a list of executor_base.Executors.

Methods

close

View source

close()

Release resources associated with this strategy, if any.

compute_federated_aggregate

View source

compute_federated_aggregate(
    *fn_args, **fn_kwargs
)

compute_federated_apply

View source

compute_federated_apply(
    *fn_args, **fn_kwargs
)

compute_federated_broadcast

View source

compute_federated_broadcast(
    *fn_args, **fn_kwargs
)

compute_federated_collect

View source

compute_federated_collect(
    *fn_args, **fn_kwargs
)

compute_federated_eval_at_clients

View source

compute_federated_eval_at_clients(
    *fn_args, **fn_kwargs
)

compute_federated_eval_at_server

View source

compute_federated_eval_at_server(
    *fn_args, **fn_kwargs
)

compute_federated_intrinsic

View source

compute_federated_intrinsic(
    uri, arg=None
)

Returns an embedded call for a federated intrinsic.

Args
uri The URI of an intrinsic to embed.
arg An optional embedded argument of the call, or None if no argument is supplied.

compute_federated_map

View source

compute_federated_map(
    *fn_args, **fn_kwargs
)

compute_federated_map_all_equal

View source

compute_federated_map_all_equal(
    *fn_args, **fn_kwargs
)

compute_federated_mean

View source

compute_federated_mean(
    *fn_args, **fn_kwargs
)

compute_federated_reduce

View source

compute_federated_reduce(
    *fn_args, **fn_kwargs
)

compute_federated_secure_sum

View source

compute_federated_secure_sum(
    *fn_args, **fn_kwargs
)

compute_federated_sum

View source

compute_federated_sum(
    *fn_args, **fn_kwargs
)

compute_federated_value

View source

compute_federated_value(
    value, type_signature
)

Returns an embedded value for a federated type.

Args
value An object to embed in the executor.
type_signature A tff.Type, the type of value.

compute_federated_value_at_clients

View source

compute_federated_value_at_clients(
    *fn_args, **fn_kwargs
)

compute_federated_value_at_server

View source

compute_federated_value_at_server(
    *fn_args, **fn_kwargs
)

compute_federated_weighted_mean

View source

compute_federated_weighted_mean(
    *fn_args, **fn_kwargs
)

compute_federated_zip_at_clients

View source

compute_federated_zip_at_clients(
    *fn_args, **fn_kwargs
)

compute_federated_zip_at_server

View source

compute_federated_zip_at_server(
    *fn_args, **fn_kwargs
)

factory

View source

@classmethod
factory(
    server_executor: tff.framework.Executor,
    target_executors: List[tff.framework.Executor]
)

ingest_value

View source

ingest_value(
    value: Any,
    type_signature: tff.Type
) -> tff.framework.ExecutorValue