audio-embedding-vggish/README.md

# Pipeline: Audio Embedding using VGGish

Authors: Jael Gu

## Overview

This pipeline extracts features of a given audio file using a VGGish model implemented in Pytorch. This is a supervised model pre-trained with [AudioSet](https://research.google.com/audioset/), which contains over 2 million sound clips.

## Interface

**Input Arguments:**

- audio_path:
  - the input audio in `.wav`
  - supported types: `str` (path to the audio)
  - the audio should be as least 1 second

**Pipeline Output:**

The Operator returns a list of named tuple `[NamedTuple('AudioOutput', [('vec', 'ndarray')])]` containing following fields:

- each item in the output list represents for embedding(s) for an audio clip,
length & timestamps of which depend on `time-window` in [yaml](./audio_embedding_vggish.yaml) 
(You can modify `time_range_sec` & `time_step_sec` to change the way of audio split.)

- vec:
  - embeddings of input audio
  - data type: numpy.ndarray
  - shape: (num_clips, 128)

## How to use

1. Install [Towhee](https://github.com/towhee-io/towhee)

```bash
$ pip3 install towhee
```

> You can refer to [Getting Started with Towhee](https://towhee.io/) for more details. If you have any questions, you can [submit an issue to the towhee repository](https://github.com/towhee-io/towhee/issues).

2. Run it with Towhee

```python
>>> from towhee import pipeline

>>> embedding_pipeline = pipeline('towhee/audio-embedding-vggish')
>>> outs = embedding_pipeline('/path/to/your/audio')
>>> embeds = outs[0][0]
```

## How it works

This pipeline includes two main operator types:
[audio-decode](https://towhee.io/operators?limit=30&page=1&filter=1%3Aaudio-decode) & [audio-embedding](https://towhee.io/operators?limit=30&page=1&filter=3%3Aaudio-embedding).
By default, the pipeline uses [towhee/audio-decoder](https://towhee.io/towhee/audio-decoder) to load audio path as a list of audio frames in ndarray.
Then `time-window` will combine audio frames into a list of ndarray, each of which represents an audio clip in fixed length.
At the end, the [towhee/torch-vggish](https://hub.towhee.io/towhee/torch-vggish)) operator will generate a list of audio embeddings for each audio clip.