FederatedComputeScheduler
public
class
FederatedComputeScheduler
extends Object
java.lang.Object | |
↳ | android.adservices.ondevicepersonalization.FederatedComputeScheduler |
Handles scheduling federated learning and federated analytic jobs.
Summary
Nested classes | |
---|---|
class |
FederatedComputeScheduler.Params
The parameters related to job scheduling. |
Public methods | |
---|---|
void
|
cancel(String populationName)
Cancel a federated computation job with input training params. |
void
|
schedule(FederatedComputeScheduler.Params params, FederatedComputeInput input)
Schedule a federated computation job. |
Inherited methods | |
---|---|
Public methods
cancel
public void cancel (String populationName)
Cancel a federated computation job with input training params.
This method may take several seconds to complete, so it should
only be called from a worker thread.
Parameters | |
---|---|
populationName |
String : population name of the job that caller wants to cancel
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
caused by an internal failure of FederatedComputeScheduler. |
schedule
public void schedule (FederatedComputeScheduler.Params params, FederatedComputeInput input)
Schedule a federated computation job.
This method may take several seconds to complete, so it should
only be called from a worker thread.
Parameters | |
---|---|
params |
FederatedComputeScheduler.Params : parameters related to job scheduling.
This value cannot be null . |
input |
FederatedComputeInput : the configuration related o federated computation. It should be consistent with
federated computation server setup. TODO(b/300461799): add federated compute server
document.
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
caused by caller supplied invalid input argument. |
IllegalStateException |
caused by an internal failure of FederatedComputeScheduler. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2023-12-20 UTC.