-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2b2543d
commit 517fe84
Showing
4 changed files
with
61 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# Automatic Speech Recognition utilizing Faster Whisper. | ||
|
||
## Stack: | ||
- [FastAPI](https://fastapi.tiangolo.com) | ||
- [Python](https://www.python.org) | ||
- [Docker](https://docker.com) | ||
|
||
## Installation | ||
|
||
- For ease of use it's recommended to use the provided [docker-compose.yml](https://github.com/doppeltilde/automatic_speech_recognition/blob/main/docker-compose.yml). | ||
```yml | ||
services: | ||
automatic_speech_recognition: | ||
image: ghcr.io/doppeltilde/automatic_speech_recognition:latest | ||
ports: | ||
- "8000:8000" | ||
volumes: | ||
- models:/root/.cache/huggingface/hub:rw | ||
environment: | ||
- DEFAULT_SUMMARIZATION_MODEL_NAME | ||
- DEFAULT_TRANSLATION_MODEL_NAME | ||
- USE_API_KEYS | ||
- API_KEYS | ||
restart: unless-stopped | ||
|
||
volumes: | ||
models: | ||
``` | ||
|
||
- Create a `.env` file and set the preferred values. | ||
```sh | ||
DEFAULT_ASR_MODEL_NAME=base | ||
COMPUTE_TYPE=float16 | ||
|
||
# False == Public Access | ||
# True == Access Only with API Key | ||
USE_API_KEYS=False | ||
|
||
# Comma seperated api keys | ||
API_KEYS=abc,123,xyz | ||
``` | ||
|
||
## Models | ||
Any model designed and compatible with faster-whisper should work. | ||
|
||
## Usage | ||
|
||
> [!NOTE] | ||
> Please be aware that the initial process may require some time, as the model is being downloaded. | ||
> [!TIP] | ||
> Interactive API documentation can be found at: http://localhost:8000/docs | ||
--- | ||
|
||
_Notice:_ _This project was initally created to be used in-house, as such the | ||
development is first and foremost aligned with the internal requirements._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters