Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/3choff/fastwhisperapi

API designed to transcribe audio files leveraging the Faster Whisper library and FastAPI framework.
https://github.com/3choff/fastwhisperapi

Last synced: 22 days ago
JSON representation

API designed to transcribe audio files leveraging the Faster Whisper library and FastAPI framework.

Host: GitHub
URL: https://github.com/3choff/fastwhisperapi
Owner: 3choff
License: apache-2.0
Created: 2024-05-04T10:00:32.000Z (8 months ago)
Default Branch: main
Last Pushed: 2024-09-12T14:57:34.000Z (4 months ago)
Last Synced: 2024-09-13T03:14:45.447Z (4 months ago)
Language: Python
Size: 753 KB
Stars: 20
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# FastWhisperAPI

FastWhisperAPI is a web service built with the FastAPI framework, specifically tailored for the accurate and efficient transcription of audio files using the Faster Whisper library.
This project is an open-source initiative that leverages the remarkable Faster Whisper model. It is four times faster than openai/whisper while maintaining the same level of accuracy and consuming less memory, whether running on CPU or GPU. The API is built to provide compatibility with the OpenAI API standard, facilitating seamless integration into existing applications that use [OpenAI - Whisper](https://platform.openai.com/docs/api-reference/making-requests).

If you find FastWhisperAPI useful, please consider leaving a star ⭐ or [donate](https://ko-fi.com/3choff).

## Features
- FastWhisperAPI is fully compatible with the OpenAI API standard.
- Transcribe audio files asynchronously using a ThreadPoolExecutor.
- Support for submitting multiple files per request.
- Support for multiple languages and model sizes.
- Customizable initial prompt to guide the model's transcription process.
- Voice activity detection filter.
- Customizable response format and timestamp granularities.

## Requirements
- Python 3.8 or greater
- Refer to the Faster Whisper documentation for the GPU requirements [here](https://github.com/SYSTRAN/faster-whisper/blob/master/README.md).

## Installation
You can check out this [YouTube video](https://youtu.be/xu-8hLOAI94?t=176) by [Prompt Engineering](https://www.youtube.com/@engineerprompt), which shows how to install and use the FastWhisperAPI, or follow the instructions below.

[![YouTube Video](./images/thumbnail.png)](https://www.youtube.com/watch?v=xu-8hLOAI94&t=176)

1. Clone the repository:
```bash
git clone https://github.com/3choff/FastWhisperAPI.git
```

2. Navigate to the project directory:
```bash
cd FastWhisperAPI
```

3. Create a new environment:
```bash
python3 -m venv FastWhisperAPI
```

4. Activate the virtual environment:

- **On Unix/Linux/macOS**:
```bash
source FastWhisperAPI/bin/activate
```

- **On Windows**:
```bash
FastWhisperAPI\Scripts\activate
```

5. Install the required packages:
```bash
pip install -r requirements.txt
```

## Usage

To run the FastAPI app, use the following command:

```bash
fastapi run main.py
```

If you want to specify a different port, use the --port option followed by the desired port number:

```bash
fastapi run main.py --port 5000
```

The API automatically detects the availability of a GPU and configures the device accordingly, either on CPU or CUDA.

If you wish to explicitly run the application on CPU, even if CUDA cores are available, set the FORCE_CPU environment variable to "true":

```bash
FORCE_CPU=true fastapi run main.py
```
The environment variable is unnecessary if only the CPU is available.

The application will begin running at `http://localhost:8000` if the port was not specified, or at `http://localhost:PORT_NUMBER` if a different port was specified.

To authenticate API requests, set the API key to "dummy_api_key" in your environment.

## Alternative Setup and Run Methods

### Docker

This API can be dockerized for deployment, and a Dockerfile is included in the repository. Please note that you may need to edit the Dockerfile based on your specific setup and CUDA version installed.

Use the following commands to build and run the container:

***Build a Docker container:***
```shell
docker build -t fastwhisperapi .
```
***Run the container***
```shell
docker run -p 8000:8000 fastwhisperapi
```
### Google Colab

Additionally, it is possible to run the API from a Google Colab environment using the Ngrok service. The Ngrok service will generate a random public URL that you can use to replace localhost in your project. For example, if the URL assigned is https://a3bd-34-171-99-34.ngrok-free.app, the transcription endpoint will be https://a3bd-34-171-99-34.ngrok-free.app/v1/transcriptions.

The Jupyter Notebook for running the API in Colab is also included in the repository. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://github.com/3choff/FastWhisperAPI/blob/main/FastWhisperAPI_notebook.ipynb)

## Parameters

- `file`: A list of audio files to transcribe. This is a required parameter.
- `model`: The size of the model to use for transcription. This is an optional parameter. The options are 'large', 'medium', 'small', 'base', 'tiny'. Default is 'base'.
- `language`: This parameter specifies the language of the audio files. It is optional, with accepted values being lowercase ISO-639-1 format (e.g., 'en' for English). If not provided, the system will automatically detect the language.
- `initial_prompt`: This optional parameter provides an initial prompt to guide the model's transcription process. It can be used to pass a dictionary of the correct spellings of words and to provide context for better understanding speech, thus maintaining a consistent writing style.
- `vad_filter`: Whether to apply a voice activity detection filter. This is an optional parameter. Default is False.
- `min_silence_duration_ms`: The minimum duration of silence to be considered as a pause. This is an optional parameter. Default is 1000.
- `response_format`: The format of the response. This is an optional parameter. The options are 'text', 'verbose_json'. Default is 'text'.
- `timestamp_granularities`: The granularity of the timestamps. This is an optional parameter. The options are 'segment', 'word'. Default is 'segment'. **This is a string and not an array like the OpenAI API**, and the timestamps will be returned only if the response_format is set to verbose_json.

### Example curl request

You can use the following `curl` command to send a POST request to the `/v1/transcriptions` endpoint:

```bash
curl -X POST "http://localhost:8000/v1/transcriptions" \
-H "accept: application/json" \
-H "Content-Type: multipart/form-data" \
-F "[email protected];type=audio/wav" \
-F "[email protected];type=audio/wav" \
-F "model=base" \
-F "language=en" \
-F "initial_prompt=RoBERTa, Mixtral, Claude 3, Command R+, LLama 3." \
-F "vad_filter=False" \
-F "min_silence_duration_ms=1000" \
-F "response_format=text" \
-F "timestamp_granularities=segment"
```
## Endpoints

- `/`: Redirects to the `/docs` endpoint, which provides a Swagger UI for interactive exploration of the API. You can call and test the API directly from your browser.
- `/info`: Provides information about the device used for transcription and the parameters.
- `/v1/transcriptions`: API designed to transcribe audio files.

## Acknowledgements

This project was made possible thanks to:

- [Faster Whisper](https://github.com/SYSTRAN/faster-whisper): For providing the transcription model used in this project.
- [FastAPI](https://github.com/tiangolo/fastapi): For the web framework used to build the API.
- [AI Anytime](https://www.youtube.com/watch?v=NU406wZz1eU): For inspiring this project.

## Support

If you find this project helpful and would like to support its development, there are several ways you can contribute:

- **Support**: Consider [donate](https://ko-fi.com/3choff) to support my work.
- **Contribute**: If you're a developer, feel free to contribute to the project by submitting pull requests or opening issues.
- **Spread the Word**: Share this project with others who might find it useful.

Your support means a lot and helps keep this project going. Thank you for your contribution!

## License

This project is licensed under the Apache License 2.0.