From 16e2425f47bdd60a728e70f35efa9a0ed223a857 Mon Sep 17 00:00:00 2001
From: Spycsh <sihan.chen@intel.com>
Date: Wed, 28 Aug 2024 20:10:13 -0700
Subject: [PATCH 1/3] add readme with supported model

---
 AudioQnA/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 AudioQnA/README.md

diff --git a/AudioQnA/README.md b/AudioQnA/README.md
new file mode 100644
index 0000000000..07d483fdb6
--- /dev/null
+++ b/AudioQnA/README.md
@@ -0,0 +1,35 @@
+# AudioQnA Application
+
+AudioQnA is an example that demonstrates the integration of Generative AI (GenAI) models for performing question-answering (QnA) on audio files, with the added functionality of Text-to-Speech (TTS) for generating spoken responses. The example showcases how to convert audio input to text using Automatic Speech Recognition (ASR), generate answers to user queries using a language model, and then convert those answers back to speech using Text-to-Speech (TTS).
+
+## Deploy AudioQnA Service
+
+The AudioQnA service can be deployed on either Intel Gaudi2 or Intel XEON Scalable Processor.
+
+### Deploy AudioQnA on Gaudi
+
+Refer to the [Gaudi Guide](./docker/gaudi/README.md) for instructions on deploying AudioQnA on Gaudi.
+
+### Deploy AudioQnA on Xeon
+
+Refer to the [Xeon Guide](./docker/xeon/README.md) for instructions on deploying AudioQnA on Xeon.
+
+
+## Supported Models
+
+### ASR
+
+The default model is [openai/whisper-small](https://huggingface.co/openai/whisper-small). It also supports all models in the Whisper family, such as `openai/whisper-large-v3`, `openai/whisper-medium`, `openai/whisper-base`, `openai/whisper-tiny`, etc.
+
+To replace the model, please edit the `compose.yaml` and add the `command` line to pass the name of the model you want to use:
+
+```yml
+services:
+  whisper-service:
+    ...
+    command: --model_name_or_path openai/whisper-tiny
+```
+
+### TTS
+
+The default model is [microsoft/SpeechT5](https://huggingface.co/microsoft/speecht5_tts). More models under the commercial license will be added in the future.

From fb7796ac0ab31af90d470357336237426fbf52be Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Thu, 29 Aug 2024 03:11:53 +0000
Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 AudioQnA/README.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/AudioQnA/README.md b/AudioQnA/README.md
index 07d483fdb6..2b5361ffd1 100644
--- a/AudioQnA/README.md
+++ b/AudioQnA/README.md
@@ -14,7 +14,6 @@ Refer to the [Gaudi Guide](./docker/gaudi/README.md) for instructions on deployi
 
 Refer to the [Xeon Guide](./docker/xeon/README.md) for instructions on deploying AudioQnA on Xeon.
 
-
 ## Supported Models
 
 ### ASR

From 707023f778854c08a5a10549f0293a075572cadf Mon Sep 17 00:00:00 2001
From: Spycsh <sihan.chen@intel.com>
Date: Wed, 28 Aug 2024 23:25:10 -0700
Subject: [PATCH 3/3] add explaination

---
 AudioQnA/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/AudioQnA/README.md b/AudioQnA/README.md
index 2b5361ffd1..2ebf6162c3 100644
--- a/AudioQnA/README.md
+++ b/AudioQnA/README.md
@@ -31,4 +31,4 @@ services:
 
 ### TTS
 
-The default model is [microsoft/SpeechT5](https://huggingface.co/microsoft/speecht5_tts). More models under the commercial license will be added in the future.
+The default model is [microsoft/SpeechT5](https://huggingface.co/microsoft/speecht5_tts). We currently do not support replacing the model. More models under the commercial license will be added in the future.