Skip to content

Commit

Permalink
Updated ASR, TTS Readme (#106)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

Signed-off-by: preethivenkatesh <preethi.venkatesh@intel.com>

* Update README.md

Signed-off-by: preethivenkatesh <preethi.venkatesh@intel.com>

* Update retrieve and reranking README.md (#101)

Signed-off-by: Wang, Xigui <xigui.wang@intel.com>
Signed-off-by: preethivenkatesh <preethi.venkatesh@intel.com>

* update docker image name in readme (#99)

Signed-off-by: letonghan <letong.han@intel.com>
Co-authored-by: Sihan Chen <39623753+Spycsh@users.noreply.github.com>
Signed-off-by: preethivenkatesh <preethi.venkatesh@intel.com>

---------

Signed-off-by: preethivenkatesh <preethi.venkatesh@intel.com>
Signed-off-by: Wang, Xigui <xigui.wang@intel.com>
Signed-off-by: letonghan <letong.han@intel.com>
Co-authored-by: xiguiw <111278656+xiguiw@users.noreply.github.com>
Co-authored-by: Letong Han <106566639+letonghan@users.noreply.github.com>
Co-authored-by: Sihan Chen <39623753+Spycsh@users.noreply.github.com>
  • Loading branch information
4 people authored May 29, 2024
1 parent 2ac7af5 commit ada0022
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions comps/asr/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ASR Microservice

ASR (Audio-Speech-Recognition) micro-service helps users convert speech to text. When building a talkingbot with LLM, users may need to convert their audio inputs (What they talk, or Input audio from other sources) to text, so LLM is able to tokenize the text and generate the answer. This microservice is built for that conversion stage.
ASR (Audio-Speech-Recognition) microservice helps users convert speech to text. When building a talking bot with LLM, users will need to convert their audio inputs (What they talk, or Input audio from other sources) to text, so the LLM is able to tokenize the text and generate an answer. This microservice is built for that conversion stage.

# 🚀Start Microservice with Python

To start the ASR microservice with Python, you need to install python packages first.
To start the ASR microservice with Python, you need to first install python packages.

## Install Requirements

Expand All @@ -20,7 +20,7 @@ python asr.py

# 🚀Start Microservice with Docker

The other way is to start the ASR microservice with Docker.
Alternatively, you can also start the ASR microservice with Docker.

## Build Docker Image

Expand All @@ -37,7 +37,7 @@ docker run -p 9099:9099 --network=host --ipc=host -e http_proxy=$http_proxy -e h

# Test

You can use the following `curl` command to test whether the service is up. Notice that the first request can be slow because it need to pre-download the models.
You can use the following `curl` command to test whether the service is up. Notice that the first request can be slow because it needs to download the models.

```bash
curl http://localhost:9099/v1/audio/transcriptions -H "Content-Type: application/json" -d '{"url": "https://github.com/intel/intel-extension-for-transformers/raw/main/intel_extension_for_transformers/neural_chat/assets/audio/sample_2.wav"}'
Expand Down
8 changes: 4 additions & 4 deletions comps/tts/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# TTS Microservice

TTS (Text-To-Speech) micro-service helps users convert text to speech. When building a talkingbot with LLM, users may need to get the LLM dgenerated answer in audio. This microservice is built for that conversion stage.
TTS (Text-To-Speech) microservice helps users convert text to speech. When building a talking bot with LLM, users might need an LLM generated answer in audio format. This microservice is built for that conversion stage.

# 🚀Start Microservice with Python

To start the TTS microservice, you need to install python packages first.
To start the TTS microservice, you need to first install python packages.

## Install Requirements

Expand All @@ -20,7 +20,7 @@ python tts.py

# 🚀Start Microservice with Docker

The other way is to start the ASR microservice with Docker.
Alternatively, you can start the ASR microservice with Docker.

## Build Docker Image

Expand All @@ -37,7 +37,7 @@ docker run -p 9999:9999 --network=host --ipc=host -e http_proxy=$http_proxy -e h

# Test

You can use the following `curl` command to test whether the service is up. Notice that the first request can be slow because it need to pre-download the models.
You can use the following `curl` command to test whether the service is up. Notice that the first request can be slow because it needs to download the models.

```bash
curl http://localhost:9999/v1/audio/speech -H "Content-Type: application/json" -d '{"text":"Hello there."}'
Expand Down

0 comments on commit ada0022

Please sign in to comment.