TrainingExamplesInput
class TrainingExamplesInput
kotlin.Any | |
↳ | android.adservices.ondevicepersonalization.TrainingExamplesInput |
The input data for IsolatedWorker#onTrainingExamples
.
Summary
Public methods | |
---|---|
Boolean |
Indicates whether some other object is "equal to" this one. |
String |
The name of the federated compute population. |
ByteArray? |
Token used to support the resumption of training. |
String |
The name of the task within the population. |
Int |
hashCode() |
Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
Parameters | |
---|---|
obj |
the reference object with which to compare. |
o |
This value may be null . |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getPopulationName
fun getPopulationName(): String
The name of the federated compute population. It should match the population name in android.adservices.ondevicepersonalization.FederatedComputeInput#getPopulationName
.
Return | |
---|---|
String |
This value cannot be null . |
getResumptionToken
fun getResumptionToken(): ByteArray?
Token used to support the resumption of training. If client app wants to use resumption token to track what examples are already used in previous federated compute jobs, it need set TrainingExampleRecord.Builder#setResumptionToken
, OnDevicePersonalization will store it and pass it here for generating new training examples.
Return | |
---|---|
ByteArray? |
This value may be null . |
getTaskName
fun getTaskName(): String
The name of the task within the population. It should match task plan configured at remote federated compute server. One population may have multiple tasks. The task name can be used to uniquely identify the job.
Return | |
---|---|
String |
This value cannot be null . |