<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L47-L167) |

Class that performs dense feature vector extraction on audio.

    tflite_support.task.audio.AudioEmbedder(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/audio/AudioEmbedderOptions,
        cpp_embedder: _CppAudioEmbedder
    ) -> None

<br />

<br />

<br />

| ## Attributes ||
|---|---|
| `number_of_output_layers` | Gets the number of output layers of the model. |
| `required_audio_format` | Gets the required audio format for the model. |
| `required_input_buffer_size` | Gets the required input buffer size for the model. |

<br />

## Methods

### `cosine_similarity`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L133-L136)

    cosine_similarity(
        u: https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/FeatureVector,
        v: https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/FeatureVector
    ) -> float

Computes cosine similarity \[1\] between two feature vectors.

### `create_audio_record`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L105-L113)

    create_audio_record() -> https://developers.google.com/edge/api/tflite/python/tflite_support/task/audio/AudioRecord

Creates an AudioRecord instance to record audio.

<br />

<br />

<br />

| Returns ||
|---|---|
| An AudioRecord instance. ||

<br />

### `create_from_file`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L56-L73)

    @classmethod
    create_from_file(
        file_path: str
    ) -> 'AudioEmbedder'

Creates the `AudioEmbedder` object from a TensorFlow Lite model.

<br />

<br />

<br />

| Args ||
|---|---|
| `file_path` | Path to the model. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `AudioEmbedder` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `AudioEmbedder` object from the provided file such as invalid file. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `create_from_options`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L75-L93)

    @classmethod
    create_from_options(
        options: https://developers.google.com/edge/api/tflite/python/tflite_support/task/audio/AudioEmbedderOptions
    ) -> 'AudioEmbedder'

Creates the `AudioEmbedder` object from audio embedder options.

<br />

<br />

<br />

| Args ||
|---|---|
| `options` | Options for the audio embedder task. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| `AudioEmbedder` object that's created from `options`. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If failed to create `AudioEmbedder` object from `AudioEmbedderOptions` such as missing the model. |
| `RuntimeError` | If other types of error occurred. |

<br />

### `create_input_tensor_audio`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L95-L103)

    create_input_tensor_audio() -> https://developers.google.com/edge/api/tflite/python/tflite_support/task/audio/TensorAudio

Creates a TensorAudio instance to store the audio input.

<br />

<br />

<br />

| Returns ||
|---|---|
| A TensorAudio instance. ||

<br />

### `embed`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L115-L131)

    embed(
        audio: https://developers.google.com/edge/api/tflite/python/tflite_support/task/audio/TensorAudio
    ) -> https://developers.google.com/edge/api/tflite/python/tflite_support/task/processor/EmbeddingResult

Performs actual feature vector extraction on the provided audio.

<br />

<br />

<br />

| Args ||
|---|---|
| `audio` | Tensor audio, used to extract the feature vectors. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| embedding result. ||

<br />

<br />

<br />

<br />

| Raises ||
|---|---|
| `ValueError` | If any of the input arguments is invalid. |
| `RuntimeError` | If failed to calculate the embedding vector. |

<br />

### `get_embedding_dimension`

[View source](https://github.com/tensorflow/tflite-support/blob/v0.4.4/tensorflow_lite_support/python/task/audio/audio_embedder.py#L138-L148)

    get_embedding_dimension(
        output_index: int
    ) -> int

Gets the dimensionality of the embedding output.

<br />

<br />

<br />

| Args ||
|---|---|
| `output_index` | The output index of output layer. |

<br />

<br />

<br />

<br />

| Returns ||
|---|---|
| Dimensionality of the embedding output by the output_index'th output layer. Returns -1 if `output_index` is out of bounds. ||

<br />