Skip to content

A self-hostable platform on which users can create transcripts of their audio files (speech-to-text) using Whisper AI

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE.md
Unknown
COPYING.md
Notifications You must be signed in to change notification settings

JulianFP/project-W

Repository files navigation

Welcome to project W!

License: AGPLv3 GitHub Workflow Status Documentation Status codecov

What is this?

Project W is a self-hostable platform on which users can create transcripts of their audio files (speech-to-text). It leverages OpenAIs Whisper model for the actual transcription while providing an easy-to-use interface on which users can create and manage their transcription jobs.

Why do we need this? Why not just use OpenAIs own service?

In short: OpenAIs service is not good enough when it comes to data privacy.

In some research fields at our university a lot of interviews (and transcriptions of these interviews) need to be done. Traditionally the transcriptions are done manually, however with recent advancements AI can do this job as good or even better than the average human and fully automated. Since the faculties are required to keep these interviews private they can't just give it to third-parties like OpenAI. Everything must stay inside the university. Furthermore Whisper has high hardware requirements (for the large models you need powerful GPUs) making it quite difficult or impossible for the average person to use on their work laptop/desktop. Also the setup of CUDA and whisper and its usage (it only has a CLI interface) is not something that the average user would like to do.

This is where Project W comes in: It is designed so that everything can be hosted by the university itself on powerful hardware (like an A100 GPU) while it is very easy to be used by the average person. Just go to the website, sign up and upload some files!

Why are there three repositories?

Project W consists of three components: The frontend/client, the backend, and the runner. We decided to host them on different git repositories to seperate them better.

UML-diagram

The backend and runner are written in Python, and we use Flask for the backends HTTP-Server. The Frontend is written in Svelte with svelte-spa-router so that it can be compiled into native Javascript, HTML and CSS. No Nodejs or anything other than a webserver (e.g. nginx) is required to serve the frontend. Of course you can also choose to write your own client with anything you like that can communicate with a REST API. This means you can use Project W with some bash or python script to automate certain tasks.

Documentation: RTFM!

You can access the full documentation for administrators and developers here. Most notably this includes installation and configuration instructions for all three components if you want to host them yourself.

output

Presentation

This project was created as part of the software practical "Research Software Engineering" at the university of Heidelberg during the winter term 2023/24. At the end of this practical we also held a presentation that you can find here.

Acknowledgments

This repository was set up using the SSC Cookiecutter for Python Packages.

About

A self-hostable platform on which users can create transcripts of their audio files (speech-to-text) using Whisper AI

Topics

Resources

License

AGPL-3.0, Unknown licenses found

Licenses found

AGPL-3.0
LICENSE.md
Unknown
COPYING.md

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •  

Languages