docs: add TODOs

speaches-ai · Jan 11, 2025 · 9922993 · 9922993
1 parent 59bd630
commit 9922993
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 1 deletion.
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -1,6 +1,10 @@
 !!! note
 
-    This project was previously named `faster-whisper-server`. It has been renamed to `speaches` to ...
+    This project was previously named `faster-whisper-server`. I've decided to change the name from `faster-whisper-server`, as the project has evolved to support more than just transcription.
+
+!!! note
+
+    These docs are a work in progress. If you have any questions, suggestions, or find a bug, please create an issue.
 
 TODO: add HuggingFace Space URL
 

diff --git a/docs/usage/dynamic-loading.md b/docs/usage/dynamic-loading.md
@@ -0,0 +1,6 @@
+https://github.com/vllm-project/vllm/issues/5491
+https://medium.com/@noel.B/preventing-model-swapping-in-ollama-a-guide-to-persistent-loading-f81f1dfb858d
+
+TODO: warn about some space still being used
+TODO: mention that it's inspired by ollama
+TODO: mention that un like ollama it supports keeping multiple models loaded
diff --git a/docs/usage/live-transcription.md b/docs/usage/live-transcription.md
@@ -1,3 +1,5 @@
+TODO: live vs streaming
+
 ## Live Transcription (using WebSocket)
 
 !!! note

diff --git a/docs/usage/speech-to-text.md b/docs/usage/speech-to-text.md
@@ -2,6 +2,8 @@ TODO: add a note about automatic downloads
 TODO: mention streaming
 TODO: add a demo
 TODO: talk about audio format
+TODO: add a note about performance
+TODO: add a note about vad
 
 !!! note
 

diff --git a/docs/usage/text-to-speech.md b/docs/usage/text-to-speech.md
@@ -5,6 +5,9 @@
 http://localhost:8001/faster-whisper-server/api/
 TODO: add a note about automatic downloads
 TODO: add a demo
+TODO: add a note about tts only running on cpu
+TODO: add a note about exploring other models
+TODO: add a note about performance
 
 !!! note