code documentation

gemini_call.py

@@ -69,6 +69,7 @@ genai.configure(api_key=api_key)
 model = genai.GenerativeModel("gemini-2.0-flash-exp" , system_instruction=final_prompt)
 
 def extract_histogram_data(text):
+    """Searches for reges to extract the info required for building the histogram"""
     # Regex to match the sentences and their sentiment score
     histogram_pattern = r"Sentence (\d+): (-?\+?\d+)"
     
@@ -82,6 +83,7 @@ def extract_histogram_data(text):
     return sentences, sentiment_scores
 
 def plot_histogram(sentences, sentiment_scores):
+    """Plots the histogram"""
     plt.figure(figsize=(6, 4))
     plt.bar(sentences, sentiment_scores, color='skyblue')
     plt.xlabel('Sentence Number')
@@ -93,7 +95,7 @@ def plot_histogram(sentences, sentiment_scores):
     plt.close()
 
 def ask_gemini(prompt:str) ->str:
-    
+    """Performs the api call to gemini and returns the answear and makes the plot of the histogram"""
     
     response = model.generate_content(prompt)
     

sentiment_analysis.py

@@ -5,7 +5,7 @@ from dotenv import load_dotenv
 load_dotenv()
 
 def get_analysis(file_path)->str:
-    
+    """Makes the pipeline to perform the sentiment analysis on a .wav file"""
     transcript = get_transcription_from_sound(file_path)
     
     analysis = ask_gemini(transcript)

streamlit_app.py

@@ -16,6 +16,7 @@ def save_audio(audio_data, filename):
         wf.writeframes(audio_data)  # Write audio data to file
 
 def display_message(role, content, image_path=None):
+    """Displays the messages on the screen along with the plots"""
     if role == "user":
         st.chat_message(role).markdown(f"**User:** {content}")
     elif role == "gemini":
@@ -29,6 +30,7 @@ def display_message(role, content, image_path=None):
                 st.error(f"Error loading image: {e}")
 
 def main():
+    """Main function that loops and can record audio and dispaly the messages from gemini"""
     st.title("Streamlit Voice Recorder")
 
     if "messages" not in st.session_state:

translation.py

@@ -12,11 +12,15 @@ def get_audio_properties(file_path):
     return sample_rate, channels
 
 def convert_to_mono(input_path, output_path):
+    """Convert video from 2+ channel audio to 1 channel audio for a 
+    single detection"""
     audio = AudioSegment.from_wav(input_path)
     mono_audio = audio.set_channels(1)
     mono_audio.export(output_path, format="wav")
 
 def transcribe_audio(file_path):
+    """Gets the .wav file path and perform speech to text
+    returns the string witch represents the words spoken"""
     # Initialize the speech client
     client = speech.SpeechClient()
 
@@ -47,6 +51,7 @@ def transcribe_audio(file_path):
     return concatenated_transcript
 
 def get_transcription_from_sound(file_path:str)->str:
+    """Converts the audio to a single channel and calls the transcription function"""
     output_path = "audio_mono.wav"
     convert_to_mono(file_path,output_path)