Merge branch 'main' of github.com:pluja/whishper
This commit is contained in:
40
README.md
40
README.md
@@ -1,12 +1,11 @@
|
|||||||

|
[](https://whishper.net)
|
||||||
|
|
||||||
# [Whishper](https://whishper.net)
|
[](https://whishper.net)
|
||||||
|
[](https://whishper.net/guides/install)
|
||||||
|
[](#screenshots)
|
||||||
|
[](https://hub.docker.com/r/pluja/whishper)
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
> [Self-hosting docs](https://whishper.net/guides/install/)
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -15,7 +14,7 @@ Whishper (formerly known as Web Whisper Plus) is a complete transcription suite.
|
|||||||
- 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] ✍️ **Powerful subtitle editor** so you don't need to leave the 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.
|
||||||
@@ -29,16 +28,15 @@ Whishper (formerly known as Web Whisper Plus) is a complete transcription suite.
|
|||||||
|
|
||||||
### Roadmap
|
### 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.~~
|
- [x] ~~Support for GPU acceleration.~~
|
||||||
- [ ] Non NVIDIA GPU support. Is it possible with faster-whisper?
|
- [ ] 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)?
|
- [ ] 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:
|
Whishper is a collection of pieces that work together. The three main pieces are:
|
||||||
@@ -50,7 +48,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.
|
||||||
|
|
||||||
@@ -67,12 +65,22 @@ 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)
|
||||||
|
|
||||||
|
## Star History
|
||||||
|
|
||||||
|
<a href="https://star-history.com/#pluja/whishper&Date">
|
||||||
|
<picture>
|
||||||
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=pluja/whishper&type=Date&theme=dark" />
|
||||||
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=pluja/whishper&type=Date" />
|
||||||
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=pluja/whishper&type=Date" />
|
||||||
|
</picture>
|
||||||
|
</a>
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
- [Faster Whisper](https://github.com/guillaumekln/faster-whisper)
|
- [Faster Whisper](https://github.com/guillaumekln/faster-whisper)
|
||||||
|
|||||||
Reference in New Issue
Block a user