Improved comments and docstrings

app.py

@@ -11,31 +11,60 @@ from utils.params import default_audio_params
 
 
 def initialize_services():
-    """Initialize configuration, LLM, TTS, and STT services."""
+    """
+    Initialize configuration, LLM, TTS, and STT services.
+
+    Returns:
+        tuple: Containing Config, LLMManager, TTSManager, and STTManager instances.
+    """
     config = Config()
     llm = LLMManager(config, prompts)
     tts = TTSManager(config)
     stt = STTManager(config)
+
+    # Update default audio parameters with STT streaming setting
     default_audio_params["streaming"] = stt.streaming
+
+    # Disable TTS in silent mode
     if os.getenv("SILENT", False):
         tts.read_last_message = lambda x: None
+
     return config, llm, tts, stt
 
 
 def create_interface(llm, tts, stt, audio_params):
-    """Create and configure the Gradio interface."""
+    """
+    Create and configure the Gradio interface.
+
+    Args:
+        llm (LLMManager): Language model manager instance.
+        tts (TTSManager): Text-to-speech manager instance.
+        stt (STTManager): Speech-to-text manager instance.
+        audio_params (dict): Audio parameters for the interface.
+
+    Returns:
+        gr.Blocks: Configured Gradio interface.
+    """
     with gr.Blocks(title="AI Interviewer", theme=gr.themes.Default()) as demo:
+        # Create audio output component (visible only in debug mode)
         audio_output = gr.Audio(label="Play audio", autoplay=True, visible=os.environ.get("DEBUG", False), streaming=tts.streaming)
+
+        # Render problem-solving and instructions UI components
         get_problem_solving_ui(llm, tts, stt, audio_params, audio_output).render()
         get_instructions_ui(llm, tts, stt, audio_params).render()
+
     return demo
 
 
 def main():
-    """Main function to initialize services and launch the Gradio interface."""
+    """
+    Main function to initialize services and launch the Gradio interface.
+    """
     config, llm, tts, stt = initialize_services()
     demo = create_interface(llm, tts, stt, default_audio_params)
     demo.config["dependencies"][0]["show_progress"] = "hidden"
+
+    # Launch the Gradio interface
     demo.launch(show_api=False)