Merge pull request #72 from ahmetoner/docs

Docs
This commit is contained in:
Ahmet Oner
2023-02-05 02:11:06 +01:00
committed by GitHub
3 changed files with 8 additions and 3 deletions

View File

@@ -1,8 +1,12 @@
# Whisper ASR Webservice
![Whisper ASR Webservice](https://github.com/ahmetoner/whisper-asr-webservice/blob/docs/docs/assets/img/banner.png?raw=true)
![Release](https://img.shields.io/github/v/release/ahmetoner/whisper-asr-webservice.svg)
![Docker Pulls](https://img.shields.io/docker/pulls/onerahmet/openai-whisper-asr-webservice.svg)
![Build](https://img.shields.io/github/actions/workflow/status/ahmetoner/whisper-asr-webservice/docker-publish.yml.svg)
![Licence](https://img.shields.io/github/license/ahmetoner/whisper-asr-webservice.svg)
Whisper is a general-purpose speech recognition model. It is trained on a large dataset of diverse audio and is also a multi-task model that can perform multilingual speech recognition as well as speech translation and language identification. For more details: [github.com/openai/whisper](https://github.com/openai/whisper/)
## Run (Docker Hub)
## Usage
Whisper ASR Webservice now available on Docker Hub. You can find the latest version of this repository on docker hub for CPU and GPU.
@@ -33,6 +37,7 @@ docker run -d -p 9000:9000 -e ASR_MODEL=base onerahmet/openai-whisper-asr-webser
```sh
# Interactive Swagger API documentation is available at http://localhost:9000/docs
```
![Whisper ASR Webservice](https://github.com/ahmetoner/whisper-asr-webservice/blob/docs/docs/assets/img/swagger-ui.png?raw=true)
Available ASR_MODELs are `tiny`, `base`, `small`, `medium`, `large`, `large-v1` and `large-v2`. Please note that `large` and `large-v2` are the same model.
@@ -126,7 +131,7 @@ docker build -t whisper-asr-webservice .
# Run Container
docker run -d -p 9000:9000 whisper-asr-webservice
# or
docker run -d -p 9000:9000 -e ASR_MODEL=base whisper-asr-webservice
docker run -d -p 9001:9000 -e ASR_MODEL=base whisper-asr-webservice3
```
### For GPU

BIN
docs/assets/img/banner.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB