Introducing Google AI Edge Portal: Benchmark Edge AI at scale. Sign-up to request access during private preview.

ModelProvider

interface ModelProvider

Known direct subclasses

AiPackModelProvider

A ModelProvider that's backed by on-demand Google Play AI Pack.

A model provider that provides a model file and relevant information.

Summary

Nested types
`enum ModelProvider.Type : Enum` Model files could be either an asset or a file.

Public companion functions
`ModelProvider`	`@<Error class: unknown class> staticModel( type: ModelProvider.Type, path: String, vararg accelerators: Accelerator )` Creates a model provider that represents a model available on the device.

Public functions
`suspend Unit`	`download()` Downloads the model if it is not available on the device.
`open <Error class: unknown class><Void?>`	`downloadFuture(lifecycleOwner: <Error class: unknown class>)` Returns a future that completes when the model is downloaded.
`Set<Accelerator>`	`getCompatibleAccelerators()` Returns the set of accelerators that the model is compatible with.
`String`	`getPath()` Returns the path to the model asset or file.
`ModelProvider.Type`	`getType()`
`Boolean`	`isReady()` Returns true if the model is ready to be used.

@<Error class: unknown class>
fun staticModel(
    type: ModelProvider.Type,
    path: String,
    vararg accelerators: Accelerator
): ModelProvider

Creates a model provider that represents a model available on the device.

suspend fun download(): Unit

Downloads the model if it is not available on the device.

open fun downloadFuture(lifecycleOwner: <Error class: unknown class>): <Error class: unknown class><Void?>

Returns a future that completes when the model is downloaded.

NOTE: Kotlin callers should use download instead.

fun getCompatibleAccelerators(): Set<Accelerator>

Returns the set of accelerators that the model is compatible with.

fun getPath(): String

Returns the path to the model asset or file.

fun getType(): ModelProvider.Type

fun isReady(): Boolean

Returns true if the model is ready to be used.