Coder/whishper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme structure

Browse Source
This commit is contained in:
pluja
2023-11-24 14:59:48 +01:00
committed by GitHub
parent 3f1d1a71c0
commit e5d7521cb6
1 changed files with 18 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -1,33 +1,35 @@
![whishper banner](misc/banner.png) ![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. **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/) > [Self-hosting docs](https://whishper.net/guides/install/)
## Features ## ✨ Features
- [x] 🗣️ **Transcribe any media** to text: audio, video, etc. - [x] 🗣️ **Transcribe any media** to text: audio, video, etc.
- Transcribe from URLs (any source supported by yt-dlp). - Transcribe from URLs (any source supported by yt-dlp).
- Upload a file to transcribe. - Upload a file to transcribe.
- [x] 📥 **Download transcriptions in many formats**: TXT, JSON, VTT, SRT or copy the raw text to your clipboard. - [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] 🌐 **Translate your transcriptions** to any language supported by [Libretranslate](https://libretranslate.com).
- [x] ✍️ **Edit your subtitles** in a comfy and complete web UI! - [x] ✍️ **Edit your subtitles** in a comfy and complete web UI!
- Transcription highlighting based on media position. - Transcription highlighting based on media position.
- CPS (Characters per second) warnings. - CPS (Characters per second) warnings.
- Segment splitting. - Segment splitting.
- Segment insertion. - Segment insertion.
- Subtitle language selection. - Subtitle language selection.
- [x] 🏠 **100% Local**: transcription, translation and subtitle edition happen 100% on your machine (can even work offline!). - [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] 🚀 **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] 👍 **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] 🔥 **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. - [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)). - [ ] Local folder as media input ([#15](https://github.com/pluja/whishper/issues/15)).
- [ ] Full-text search all transcriptions. - [ ] Full-text search all transcriptions.
@@ -38,11 +40,7 @@
- [ ] Non NVIDIA GPU support. Is it possible with faster-whisper? - [ ] Non NVIDIA GPU support. Is it possible with faster-whisper?
- [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)? - [ ] Can we do something with [seamless_communication](https://github.com/facebookresearch/seamless_communication)?
## Self hosting ## 🩻 Project structure
Check out the self-hosting documentation [here](https://whishper.net/guides/install/).
## Project structure
Whishper is a collection of pieces that work together. The three main pieces are: 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. - 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. - 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. 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/). 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: 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/) - [A transcription download](https://whishper.net/usage/download/)
- [The subtitle editor](https://whishper.net/usage/editor/) - [The subtitle editor](https://whishper.net/usage/editor/)
## Support: ## 🫀 Support
- [Monero](https://www.getmonero.org/): `82x6cn628oTUXV63DxBd6MJB8d997FhaSaGFvoWMgwihVmgiXYQPAwm2BCH31AovA9Qnnv1qQRrJk83TaJ8DaSZU2zkbWfM` - [Monero](https://www.getmonero.org/): `82x6cn628oTUXV63DxBd6MJB8d997FhaSaGFvoWMgwihVmgiXYQPAwm2BCH31AovA9Qnnv1qQRrJk83TaJ8DaSZU2zkbWfM`
- [Bitcoin](https://bitcoin.org/en/): `bc1qfph44jl4cy03stwfkk7g0qlwx2grldr9xpk086` - [Bitcoin](https://bitcoin.org/en/): `bc1qfph44jl4cy03stwfkk7g0qlwx2grldr9xpk086`
- [Lightning Network (kycnotme)](https://getalby.com/p/kycnotme) - [Lightning Network (kycnotme)](https://getalby.com/p/kycnotme)
## Credits ## 🤝 Credits
- [Faster Whisper](https://github.com/guillaumekln/faster-whisper) - [Faster Whisper](https://github.com/guillaumekln/faster-whisper)
- [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) - [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)