# InterpreterApi.Options

```
class InterpreterApi.Options
```

*** ** * ** ***

An options class for controlling runtime interpreter behavior.

## Summary

| ### Nested types |
|---|
| `enum https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options.TfLiteRuntime` Enum to represent where to get the TensorFlow Lite runtime implementation from. |

| ### Public constructors |
|---|
| `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#Options()()` |
| `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#Options(org.tensorflow.lite.InterpreterApi.Options)(other: https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options!)` |

| ### Public functions |
|---|---|
| `https://developers.google.com/edge/api/litert/kotlin/kotlin/Boolean` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#getUseXNNPACK()()` |
| `https://developers.google.com/edge/api/litert/kotlin/kotlin/Boolean` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#isCancellable()()` Advanced: Returns whether the interpreter is able to be cancelled. |
| `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options!` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#setCancellable(boolean)(allow: https://developers.google.com/edge/api/litert/kotlin/kotlin/Boolean)` Advanced: Set if the interpreter is able to be cancelled. |
| `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options!` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#setUseXNNPACK(boolean)(useXNNPACK: https://developers.google.com/edge/api/litert/kotlin/kotlin/Boolean)` Enable or disable an optimized set of CPU kernels (provided by XNNPACK). |

| ### Public properties |
|---|---|
| `https://developers.google.com/edge/api/litert/kotlin/kotlin/Int` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#numThreads()` |
| `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options.TfLiteRuntime!` | `https://developers.google.com/edge/api/litert/kotlin/org/tensorflow/lite/InterpreterApi.Options#runtime()` |

## Public constructors

### Options

```
Options()
```

### Options

```
Options(other: InterpreterApi.Options!)
```

## Public functions

### getUseXNNPACK

```
fun getUseXNNPACK(): Boolean
```

### isCancellable

```
fun isCancellable(): Boolean
```

Advanced: Returns whether the interpreter is able to be cancelled.

Interpreters may have an experimental API [setCancelled(boolean)](https://www.tensorflow.org/lite/api_docs/java/org/tensorflow/lite/Interpreter#setCancelled(boolean)). If this interpreter is cancellable and such a method is invoked, a cancellation flag will be set to true. The interpreter will check the flag between Op invocations, and if it's `
true`, the interpreter will stop execution. The interpreter will remain a cancelled state until explicitly "uncancelled" by `setCancelled(false)`.

### setCancellable

```
fun setCancellable(allow: Boolean): InterpreterApi.Options!
```

Advanced: Set if the interpreter is able to be cancelled.

Interpreters may have an experimental API [setCancelled(boolean)](https://www.tensorflow.org/lite/api_docs/java/org/tensorflow/lite/Interpreter#setCancelled(boolean)). If this interpreter is cancellable and such a method is invoked, a cancellation flag will be set to true. The interpreter will check the flag between Op invocations, and if it's `
true`, the interpreter will stop execution. The interpreter will remain a cancelled state until explicitly "uncancelled" by `setCancelled(false)`.

### setUseXNNPACK

```
fun setUseXNNPACK(useXNNPACK: Boolean): InterpreterApi.Options!
```

Enable or disable an optimized set of CPU kernels (provided by XNNPACK). Enabled by default.

## Public properties

### numThreads

```
var numThreads: Int
```

### runtime

```
var runtime: InterpreterApi.Options.TfLiteRuntime!
```