xref: /aosp_15_r20/external/federated-compute/fcp/client/README.md (revision 14675a029014e728ec732f129a32e299b2da0601)
1*14675a02SAndroid Build Coastguard Worker# Federated Computations Client
2*14675a02SAndroid Build Coastguard Worker
3*14675a02SAndroid Build Coastguard WorkerThis directory contains the portable client implementation of Google's platform
4*14675a02SAndroid Build Coastguard Workerfor federated and local computations. A final build of the client will consist
5*14675a02SAndroid Build Coastguard Workerof
6*14675a02SAndroid Build Coastguard Worker
7*14675a02SAndroid Build Coastguard Worker1.  The portable core functionality provided by this directory - `:fl_runner`
8*14675a02SAndroid Build Coastguard Worker    and`:lc_runner` for running federated and local computations. This code
9*14675a02SAndroid Build Coastguard Worker    contains the network stack and model / query interpreter.
10*14675a02SAndroid Build Coastguard Worker1.  Platform-dependent implementations of the `:interfaces` target. This allows
11*14675a02SAndroid Build Coastguard Worker    to inject dependencies for e.g. telemetry, attestation, flag-guarding,
12*14675a02SAndroid Build Coastguard Worker    access to example stores etc.
13*14675a02SAndroid Build Coastguard Worker
14*14675a02SAndroid Build Coastguard WorkerThe stand-alone binary `:client_runner_main` provides a bare bones example of a
15*14675a02SAndroid Build Coastguard Workerfederated computation client. Most practical implementations will wrap the calls
16*14675a02SAndroid Build Coastguard Workerto the client in a scheduler that respects device constraints and the returned
17*14675a02SAndroid Build Coastguard Workerretry window.
18