Added in API level 35

Params


class Params
kotlin.Any
   ↳ android.adservices.ondevicepersonalization.InferenceInput.Params

Summary

Nested classes

A builder for Params

Constants
static Int

The model inference will run on CPU.

static Int

The model is a tensorflow lite model.

Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

open Int

The delegate to run model inference.

open KeyValueStore

A KeyValueStore where pre-trained model is stored.

open String

The key of the table where the corresponding value stores a pre-trained model.

open Int

The type of the pre-trained model.

open Int

The number of threads used for intraop parallelism on CPU, must be positive number.

open Int

Constants

DELEGATE_CPU

Added in API level 35
static val DELEGATE_CPU: Int

The model inference will run on CPU.

Value: 1

MODEL_TYPE_TENSORFLOW_LITE

Added in API level 35
static val MODEL_TYPE_TENSORFLOW_LITE: Int

The model is a tensorflow lite model.

Value: 1

Public methods

equals

Added in API level 35
open 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 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
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.

getDelegateType

Added in API level 35
open fun getDelegateType(): Int

The delegate to run model inference. If not set, the default value is DELEGATE_CPU.

Return
Int Value is android.adservices.ondevicepersonalization.InferenceInput.Params#DELEGATE_CPU

getKeyValueStore

Added in API level 35
open fun getKeyValueStore(): KeyValueStore

A KeyValueStore where pre-trained model is stored. Only supports TFLite model now.

Return
KeyValueStore This value cannot be null.

getModelKey

Added in API level 35
open fun getModelKey(): String

The key of the table where the corresponding value stores a pre-trained model. Only supports TFLite model now.

Return
String This value cannot be null.

getModelType

Added in API level 35
open fun getModelType(): Int

The type of the pre-trained model. If not set, the default value is MODEL_TYPE_TENSORFLOW_LITE . Only supports MODEL_TYPE_TENSORFLOW_LITE for now.

Return
Int Value is android.adservices.ondevicepersonalization.InferenceInput.Params#MODEL_TYPE_TENSORFLOW_LITE

getRecommendedNumThreads

Added in API level 35
open fun getRecommendedNumThreads(): Int

The number of threads used for intraop parallelism on CPU, must be positive number. Adopters can set this field based on model architecture. The actual thread number depends on system resources and other constraints.

Return
Int Value is 1 or greater

hashCode

Added in API level 35
open fun hashCode(): Int
Return
Int a hash code value for this object.