Added in API level 35

Summary: Nested Classes | Methods | Inherited Methods

InferenceInput

---

Kotlin |Java

public final class InferenceInput
extends Object

java.lang.Object
↳	android.adservices.ondevicepersonalization.InferenceInput

---

Contains all the information needed for a run of model inference. The input of ModelManager.run(InferenceInput, Executor, OutcomeReceiver).

Summary

Nested classes
class	InferenceInput.Builder A builder for InferenceInput
class	InferenceInput.Params

Public methods
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
int	getBatchSize() The number of input examples.
InferenceOutput	getExpectedOutputStructure() The empty InferenceOutput representing the expected output structure.
Object[]	getInputData() Note: use ERROR(InferenceInput.getData()/android.adservices.ondevicepersonalization.InferenceInput#getData() InferenceInput.getData()) instead.
InferenceInput.Params	getParams() The configuration that controls runtime interpreter behavior.
int	hashCode() Returns a hash code value for the object.

Inherited methods

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

equals

Added in API level 35

public boolean equals (Object o)

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 return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

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
o	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getBatchSize

Added in API level 35

public int getBatchSize ()

The number of input examples. Adopter can set this field to run batching inference. The batch size is 1 by default. The batch size should match the input data size.

Returns
int

getExpectedOutputStructure

Added in API level 35

public InferenceOutput getExpectedOutputStructure ()

The empty InferenceOutput representing the expected output structure. For LiteRT, the inference code will verify whether this expected output structure matches model output signature.

If a model produce string tensors:

String[] output = new String[3][2];  // Output tensor shape is [3, 2].
 HashMap<Integer, Object> outputs = new HashMap<>();
 outputs.put(0, output);
 expectedOutputStructure = new InferenceOutput.Builder().setDataOutputs(outputs).build();
 

Returns
InferenceOutput	This value cannot be null.

getInputData

Added in API level 35

public Object[] getInputData ()

Note: use ERROR(InferenceInput.getData()/android.adservices.ondevicepersonalization.InferenceInput#getData() InferenceInput.getData()) instead.

An array of input data. The inputs should be in the same order as inputs of the model.

For example, if a model takes multiple inputs:

String[] input0 = {"foo", "bar"}; // string tensor shape is [2].
 int[] input1 = new int[]{3, 2, 1}; // int tensor shape is [3].
 Object[] inputData = {input0, input1, ...};
 

For LiteRT, this field is mapped to inputs of runForMultipleInputsOutputs: https://www.tensorflow.org/lite/api_docs/java/org/tensorflow/lite/InterpreterApi#parameters_9

Returns
Object[]	This value cannot be null.

getParams

Added in API level 35

public InferenceInput.Params getParams ()

The configuration that controls runtime interpreter behavior.

Returns
InferenceInput.Params	This value cannot be null.

hashCode

Added in API level 35

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.