From a2966a845f965d1c5412bb2743157d7fc03a8d5a Mon Sep 17 00:00:00 2001 From: Jael Gu Date: Thu, 21 Apr 2022 17:34:25 +0800 Subject: [PATCH] Update readme Signed-off-by: Jael Gu --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 168ff1f..0adc80c 100644 --- a/README.md +++ b/README.md @@ -9,23 +9,22 @@ This operator uses reads the waveform of an audio file and then applies VGGish t ## Interface ```python -__call__(self, audio_path: str) +__call__(self, datas: List[NamedTuple('data', [('audio', 'ndarray'), ('sample_rate', 'int')])]) ``` **Args:** -- audio_path: - - the input audio path - - supported types: str +- datas: + - a named tuple including audio data in numpy.ndarray and sample rate in integer **Returns:** The Operator returns a tuple Tuple[('embs', numpy.ndarray)] containing following fields: -- embs: +- vec: - embeddings of the audio - data type: `numpy.ndarray` - - shape: (num_clips,128) + - shape: (num_clips, 128) ## Requirements