diff --git a/README.md b/README.md index 3b171b7ed9eacf78f179f8a8e9cd2eb639f92258..75bd94cce740d9eed1b7506206ffded5d12abbbe 100644 --- a/README.md +++ b/README.md @@ -12,5 +12,25 @@ Current release (v1.2.0) supports following whisper models: - [openai/whisper](https://github.com/openai/whisper)@[v20230918](https://github.com/openai/whisper/releases/tag/v20230918) - [guillaumekln/faster-whisper](https://github.com/guillaumekln/faster-whisper)@[0.9.0](https://github.com/guillaumekln/faster-whisper/releases/tag/v0.9.0) + +## Quick Usage + +### CPU + +```sh +docker run -d -p 9000:9000 -e ASR_MODEL=base -e ASR_ENGINE=openai_whisper onerahmet/openai-whisper-asr-webservice:latest +``` + +### GPU + +```sh +docker run -d --gpus all -p 9000:9000 -e ASR_MODEL=base -e ASR_ENGINE=openai_whisper onerahmet/openai-whisper-asr-webservice:latest-gpu +``` + +for more information: + +- [Documentation/Run](https://ahmetoner.github.io/whisper-asr-webservice/run) +- [Docker Hub](https://hub.docker.com/r/onerahmet/openai-whisper-asr-webservice) + # Documentation Explore the documentation by clicking [here](https://ahmetoner.github.io/whisper-asr-webservice). diff --git a/docs/index.md b/docs/index.md index 14969d2e23f834275889ab2938526aba004d19ad..6dff66127244d3e9bf8c7781e36dae702d9d3f0b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,3 +5,22 @@ Current release (v1.2.0) supports following whisper models: - [openai/whisper](https://github.com/openai/whisper)@[v20230918](https://github.com/openai/whisper/releases/tag/v20230918) - [guillaumekln/faster-whisper](https://github.com/guillaumekln/faster-whisper)@[0.9.0](https://github.com/guillaumekln/faster-whisper/releases/tag/v0.9.0) + +## Quick Usage + +=== ":octicons-file-code-16: `CPU`" + + ```sh + docker run -d -p 9000:9000 -e ASR_MODEL=base -e ASR_ENGINE=openai_whisper onerahmet/openai-whisper-asr-webservice:latest + ``` + +=== ":octicons-file-code-16: `GPU`" + + ```sh + docker run -d --gpus all -p 9000:9000 -e ASR_MODEL=base -e ASR_ENGINE=openai_whisper onerahmet/openai-whisper-asr-webservice:latest-gpu + ``` + +for more information: + +- [Documentation/Run](https://ahmetoner.github.io/whisper-asr-webservice/run) +- [Docker Hub](https://hub.docker.com/r/onerahmet/openai-whisper-asr-webservice)