Environment

class Environment : JniHandle

kotlin.Any
↳	com.google.ai.edge.litert.JniHandle
	↳	com.google.ai.edge.litert.Environment

---

Environment to hold configuration options for LiteRT runtime.

Summary

Nested types
enum Environment.Option : Enum Options configurable in LiteRT environment.

Public companion functions
Environment	create(options: Map<Environment.Option, String>) Creates an environment.
Environment	create(     npuAcceleratorProvider: NpuAcceleratorProvider,     options: Map<Environment.Option, String> ) Creates an environment with a NpuAcceleratorProvider.
Environment	create(     context: Context,     options: Map<Environment.Option, String>,     enableCompilerCache: Boolean ) Creates an environment.
Environment	create(     context: Context,     npuAcceleratorProvider: NpuAcceleratorProvider,     options: Map<Environment.Option, String>,     enableCompilerCache: Boolean ) Creates an environment with a NpuAcceleratorProvider, which provides the NPU libraries.

Public functions
Set<Accelerator>	getAvailableAccelerators() Returns the set of accelerators available in the environment.

Protected functions
open Unit	destroy() Clean up resources associated with the handle.

Inherited functions
From com.google.ai.edge.litert.JniHandle Unit assertNotDestroyed() Asserts that the handle is not destroyed, otherwise throws an IllegalStateException. final Unit close() Clean up the handle safely to avoid releasing the same JNI handle multiple times.

Public companion functions

create

fun create(options: Map<Environment.Option, String> = mapOf()): Environment

Creates an environment.

Note: This version does not enable compiler caching. Use create(Context, Map, Boolean) to enable caching.

Parameters
options: Map<Environment.Option, String> = mapOf()	The options to configure the environment.

create

fun create(
    npuAcceleratorProvider: NpuAcceleratorProvider,
    options: Map<Environment.Option, String> = mapOf()
): Environment

Creates an environment with a NpuAcceleratorProvider.

Note: This version does not enable compiler caching. Use create(Context, NpuAcceleratorProvider, Map, Boolean) to enable caching.

Parameters
npuAcceleratorProvider: NpuAcceleratorProvider	The NPU accelerator provider.
options: Map<Environment.Option, String> = mapOf()	The options to configure the environment.

create

fun create(
    context: Context,
    options: Map<Environment.Option, String> = mapOf(),
    enableCompilerCache: Boolean = true
): Environment

Creates an environment.

Parameters
context: Context	The Android context.
options: Map<Environment.Option, String> = mapOf()	The options to configure the environment.
enableCompilerCache: Boolean = true	Whether to enable the compiler cache.

create

fun create(
    context: Context,
    npuAcceleratorProvider: NpuAcceleratorProvider,
    options: Map<Environment.Option, String> = mapOf(),
    enableCompilerCache: Boolean = true
): Environment

Creates an environment with a NpuAcceleratorProvider, which provides the NPU libraries.

Parameters
context: Context	The Android context.
npuAcceleratorProvider: NpuAcceleratorProvider	The NPU accelerator provider.
options: Map<Environment.Option, String> = mapOf()	The options to configure the environment.
enableCompilerCache: Boolean = true	Whether to enable the compiler cache.

Public functions

getAvailableAccelerators

fun getAvailableAccelerators(): Set<Accelerator>

Returns the set of accelerators available in the environment.

Protected functions

destroy

protected open fun destroy(): Unit

Clean up resources associated with the handle.