From 76ec83824994384b62c99848928b0fc8a72e7ab8 Mon Sep 17 00:00:00 2001 From: pluja <64632615+pluja@users.noreply.github.com> Date: Tue, 21 Nov 2023 22:21:38 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c05b5a..570a9d7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # [Whishper](https://whishper.net) -Whishper (formerly known as Web Whisper Plus) is a complete transcription suite. In simple words, it is a frontend for the Whisper model family, but [with batteries included](#features)! +**Whishper** is an open-source, 100% local audio transcription and subtitling suite with a full-featured web UI. > [Show me the screenshots!](#screenshots) From 3f1d1a71c0f6594749139f4be26f75eead3620f6 Mon Sep 17 00:00:00 2001 From: pluja <64632615+pluja@users.noreply.github.com> Date: Wed, 22 Nov 2023 09:27:24 +0100 Subject: [PATCH 2/4] update roadmap --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 570a9d7..8676864 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,13 @@ ### Roadmap +- [ ] Local folder as media input ([#15](https://github.com/pluja/whishper/issues/15)). +- [ ] Full-text search all transcriptions. +- [ ] User authentication. +- [ ] Audio recording from the browser. +- [ ] Add [insanely-fast-whisper](https://github.com/Vaibhavs10/insanely-fast-whisper) as an optional backend ([#53](https://github.com/pluja/whishper/issues/53)). - [x] ~~Support for GPU acceleration.~~ - [ ] Non NVIDIA GPU support. Is it possible with faster-whisper? -- [ ] Full-text search all transcriptions -- [ ] Audio recording from the browser. - [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)? ## Self hosting From e5d7521cb65db623924e579110dc6e50e75b00e5 Mon Sep 17 00:00:00 2001 From: pluja <64632615+pluja@users.noreply.github.com> Date: Fri, 24 Nov 2023 14:59:48 +0100 Subject: [PATCH 3/4] update readme structure --- README.md | 38 ++++++++++++++++++-------------------- 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 8676864..91a885f 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,35 @@ ![whishper banner](misc/banner.png) -# [Whishper](https://whishper.net) +[![](https://img.shields.io/badge/Website-8A2BE2)](https://whishper.net) +[![](https://img.shields.io/badge/%F0%9F%96%BC%EF%B8%8FScreenshots-8A2BE2)](#🖼️-screenshots) +[![](https://img.shields.io/badge/%F0%9F%8F%A0%20Selfhosting%20Guide-purple)](https://whishper.net/guides/install) **Whishper** is an open-source, 100% local audio transcription and subtitling suite with a full-featured web UI. -> [Show me the screenshots!](#screenshots) +> [Show me the screenshots!](#-screenshots) > [Self-hosting docs](https://whishper.net/guides/install/) -## Features +## ✨ Features - [x] 🗣️ **Transcribe any media** to text: audio, video, etc. - - Transcribe from URLs (any source supported by yt-dlp). - - Upload a file to transcribe. + - Transcribe from URLs (any source supported by yt-dlp). + - Upload a file to transcribe. - [x] 📥 **Download transcriptions in many formats**: TXT, JSON, VTT, SRT or copy the raw text to your clipboard. - [x] 🌐 **Translate your transcriptions** to any language supported by [Libretranslate](https://libretranslate.com). - [x] ✍️ **Edit your subtitles** in a comfy and complete web UI! - - Transcription highlighting based on media position. - - CPS (Characters per second) warnings. - - Segment splitting. - - Segment insertion. - - Subtitle language selection. + - Transcription highlighting based on media position. + - CPS (Characters per second) warnings. + - Segment splitting. + - Segment insertion. + - Subtitle language selection. - [x] 🏠 **100% Local**: transcription, translation and subtitle edition happen 100% on your machine (can even work offline!). - [x] 🚀 **Fast**: uses FasterWhisper as the Whisper backend: get much faster transcription times on CPU! - [x] 👍 **Quick and easy setup**: use the quick start script, or run through a few steps! - [x] 🔥 **GPU support**: use your NVIDIA GPU to get even faster transcription times! - [x] 🐎 **CPU support**: no GPU? No problem! Whishper can run on CPU too. -### Roadmap +### 🧭 Roadmap - [ ] Local folder as media input ([#15](https://github.com/pluja/whishper/issues/15)). - [ ] Full-text search all transcriptions. @@ -38,11 +40,7 @@ - [ ] Non NVIDIA GPU support. Is it possible with faster-whisper? - [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)? -## Self hosting - -Check out the self-hosting documentation [here](https://whishper.net/guides/install/). - -## Project structure +## 🩻 Project structure Whishper is a collection of pieces that work together. The three main pieces are: @@ -53,7 +51,7 @@ Whishper is a collection of pieces that work together. The three main pieces are - MongoDB (3rd party): This is the database that stores all the information about your transcriptions. - Nginx (3rd party): This is the proxy that allows running everything from a single domain. -## Contributing +### Contributing Contributions are welcome! Feel free to open a PR with your changes, or take a look at the issues to see if there is something you can help with. @@ -61,7 +59,7 @@ Contributions are welcome! Feel free to open a PR with your changes, or take a l Check out the development documentation [here](https://whishper.net/guides/development/). -## Screenshots +## 🖼️ Screenshots These screenshots are available on [the official website](https://whishper.net/usage/transcriptions/), click any of the following links to see: @@ -70,13 +68,13 @@ These screenshots are available on [the official website](https://whishper.net/u - [A transcription download](https://whishper.net/usage/download/) - [The subtitle editor](https://whishper.net/usage/editor/) -## Support: +## 🫀 Support - [Monero](https://www.getmonero.org/): `82x6cn628oTUXV63DxBd6MJB8d997FhaSaGFvoWMgwihVmgiXYQPAwm2BCH31AovA9Qnnv1qQRrJk83TaJ8DaSZU2zkbWfM` - [Bitcoin](https://bitcoin.org/en/): `bc1qfph44jl4cy03stwfkk7g0qlwx2grldr9xpk086` - [Lightning Network (kycnotme)](https://getalby.com/p/kycnotme) -## Credits +## 🤝 Credits - [Faster Whisper](https://github.com/guillaumekln/faster-whisper) - [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) From 5e561c6466a23183bccbbaa03bf49bd2c0950327 Mon Sep 17 00:00:00 2001 From: pluja <64632615+pluja@users.noreply.github.com> Date: Fri, 24 Nov 2023 15:26:22 +0100 Subject: [PATCH 4/4] improve README.md --- README.md | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 91a885f..3678421 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,20 @@ -![whishper banner](misc/banner.png) +[![whishper banner](misc/banner.png)](https://whishper.net) -[![](https://img.shields.io/badge/Website-8A2BE2)](https://whishper.net) -[![](https://img.shields.io/badge/%F0%9F%96%BC%EF%B8%8FScreenshots-8A2BE2)](#🖼️-screenshots) -[![](https://img.shields.io/badge/%F0%9F%8F%A0%20Selfhosting%20Guide-purple)](https://whishper.net/guides/install) +[![](https://img.shields.io/badge/website-066da5?style=for-the-badge&logo=icloud&logoColor=white)](https://whishper.net) +[![](https://img.shields.io/badge/self%20host%20guide-066da5?style=for-the-badge&logo=googledocs&logoColor=white)](https://whishper.net/guides/install) +[![](https://img.shields.io/badge/screenshots-5c1f87?style=for-the-badge&logo=slickpic&logoColor=white)](#screenshots) +[![](https://img.shields.io/docker/pulls/pluja/whishper?style=for-the-badge&logo=docker&logoColor=white)](https://hub.docker.com/r/pluja/whishper) **Whishper** is an open-source, 100% local audio transcription and subtitling suite with a full-featured web UI. -> [Show me the screenshots!](#-screenshots) - -> [Self-hosting docs](https://whishper.net/guides/install/) - -## ✨ Features +## Features - [x] 🗣️ **Transcribe any media** to text: audio, video, etc. - Transcribe from URLs (any source supported by yt-dlp). - Upload a file to transcribe. - [x] 📥 **Download transcriptions in many formats**: TXT, JSON, VTT, SRT or copy the raw text to your clipboard. - [x] 🌐 **Translate your transcriptions** to any language supported by [Libretranslate](https://libretranslate.com). -- [x] ✍️ **Edit your subtitles** in a comfy and complete web UI! +- [x] ✍️ **Powerful subtitle editor** so you don't need to leave the UI! - Transcription highlighting based on media position. - CPS (Characters per second) warnings. - Segment splitting. @@ -29,7 +26,7 @@ - [x] 🔥 **GPU support**: use your NVIDIA GPU to get even faster transcription times! - [x] 🐎 **CPU support**: no GPU? No problem! Whishper can run on CPU too. -### 🧭 Roadmap +### Roadmap - [ ] Local folder as media input ([#15](https://github.com/pluja/whishper/issues/15)). - [ ] Full-text search all transcriptions. @@ -40,7 +37,7 @@ - [ ] Non NVIDIA GPU support. Is it possible with faster-whisper? - [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)? -## 🩻 Project structure +## Project structure Whishper is a collection of pieces that work together. The three main pieces are: @@ -59,7 +56,7 @@ Contributions are welcome! Feel free to open a PR with your changes, or take a l Check out the development documentation [here](https://whishper.net/guides/development/). -## 🖼️ Screenshots +## Screenshots These screenshots are available on [the official website](https://whishper.net/usage/transcriptions/), click any of the following links to see: @@ -68,13 +65,23 @@ These screenshots are available on [the official website](https://whishper.net/u - [A transcription download](https://whishper.net/usage/download/) - [The subtitle editor](https://whishper.net/usage/editor/) -## 🫀 Support +## Support - [Monero](https://www.getmonero.org/): `82x6cn628oTUXV63DxBd6MJB8d997FhaSaGFvoWMgwihVmgiXYQPAwm2BCH31AovA9Qnnv1qQRrJk83TaJ8DaSZU2zkbWfM` - [Bitcoin](https://bitcoin.org/en/): `bc1qfph44jl4cy03stwfkk7g0qlwx2grldr9xpk086` - [Lightning Network (kycnotme)](https://getalby.com/p/kycnotme) -## 🤝 Credits +## Star History + + + + + + Star History Chart + + + +## Credits - [Faster Whisper](https://github.com/guillaumekln/faster-whisper) - [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)