docs: add missing docs

winstxnhdw · Sep 6, 2024 · d41b4e2 · d41b4e2
1 parent 4f2b300
commit d41b4e2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/server/config.py b/server/config.py
@@ -33,6 +33,7 @@ class Config(BaseSettings):
     server_root_path (str) : the root path for the server
     worker_count (int) : the number of workers to use
     use_cuda (bool) : whether to use CUDA for inference
+    transcriber_model_name (str) : the name of the transcriber model to use
     """
 
     server_port: int = 49494

diff --git a/server/state.py b/server/state.py
@@ -8,6 +8,10 @@ class AppState(State):
     Summary
     -------
     the Litestar application state that will be injected into the routers
+
+    Attributes
+    ----------
+    transcriber (TranscriberProtocol) : the transcriber instance for transcribing audio
     """
 
     transcriber: TranscriberProtocol