Skip to content
Snippets Groups Projects
Commit 50aefcfa authored by Ahmet Oner's avatar Ahmet Oner
Browse files

Add Quick Usage section

parent 78c7205f
No related branches found
No related tags found
No related merge requests found
......@@ -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).
......@@ -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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment