Skip to content

Commit

Permalink
docs: deprecate live-transcription (#310)
Browse files Browse the repository at this point in the history
  • Loading branch information
Fedir Zadniprovskyi authored and fedirz committed Feb 13, 2025
1 parent 3a6cf40 commit 9be74ed
Show file tree
Hide file tree
Showing 5 changed files with 0 additions and 56 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ See the documentation for installation instructions and usage: [speaches.ai](htt
- [Highly configurable](https://speaches.ai/configuration/)
- OpenAI API compatible. All tools and SDKs that work with OpenAI's API should work with `speaches`.
- Streaming support (transcription is sent via SSE as the audio is transcribed. You don't need to wait for the audio to fully be transcribed before receiving it).

- LocalAgreement2 ([paper](https://aclanthology.org/2023.ijcnlp-demo.3.pdf) | [original implementation](https://github.com/ufal/whisper_streaming)) algorithm is used for live transcription.

- Live transcription support (audio is sent via websocket as it's generated).
- Dynamic model loading / offloading. Just specify which model you want to use in the request and it will be loaded automatically. It will then be unloaded after a period of inactivity.
- Text-to-Speech via `kokoro`(Ranked #1 in the [TTS Arena](https://huggingface.co/spaces/Pendrokar/TTS-Spaces-Arena)) and `piper` models.
- [Coming soon](https://github.com/speaches-ai/speaches/issues/231): Audio generation (chat completions endpoint) | [OpenAI Documentation](https://platform.openai.com/docs/guides/realtime)
Expand All @@ -39,7 +35,3 @@ TODO
### Speech Generation

https://github.com/user-attachments/assets/0021acd9-f480-4bc3-904d-831f54c4d45b

### Live Transcription (using WebSockets)

https://github.com/fedirz/faster-whisper-server/assets/76551385/e334c124-af61-41d4-839c-874be150598f
8 changes: 0 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
- Perform sentiment analysis on a recording (audio in, text out)
- Async speech to speech interactions with a model (audio in, audio out)
- Streaming support (transcription is sent via SSE as the audio is transcribed. You don't need to wait for the audio to fully be transcribed before receiving it).
- Live transcription support (audio is sent via websocket as it's generated).
- LocalAgreement2 ([paper](https://aclanthology.org/2023.ijcnlp-demo.3.pdf) | [original implementation](https://github.com/ufal/whisper_streaming)) algorithm is used for live transcription.
- Dynamic model loading / offloading. Just specify which model you want to use in the request and it will be loaded automatically. It will then be unloaded after a period of inactivity.
- Text-to-Speech via `kokoro`(Ranked #1 in the [TTS Arena](https://huggingface.co/spaces/Pendrokar/TTS-Spaces-Arena)) and `piper` models.
- GPU and CPU support.
Expand All @@ -44,9 +42,3 @@ TODO
<video width="100%" controls>
<source src="https://github.com/user-attachments/assets/0021acd9-f480-4bc3-904d-831f54c4d45b" type="video/webm">
</video>

### Live Transcription (using WebSockets)

<video width="100%" controls>
<source src="https://github.com/fedirz/faster-whisper-server/assets/76551385/e334c124-af61-41d4-839c-874be150598f" type="video/mp4">
</video>
20 changes: 0 additions & 20 deletions docs/usage/live-transcription.md

This file was deleted.

19 changes: 0 additions & 19 deletions examples/live-audio/script.sh

This file was deleted.

1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ nav:
- Voice Chat: usage/voice-chat.md
- Speech-to-Text: usage/speech-to-text.md
- Text-to-Speech: usage/text-to-speech.md
- Live Transcription (using WebSockets): usage/live-transcription.md
- Open WebUI Integration: usage/open-webui-integration.md
- Installation: installation.md
- Configuration: configuration.md
Expand Down

0 comments on commit 9be74ed

Please sign in to comment.