Added comments

sonogram.py

@@ -6,6 +6,12 @@ import torch
 class Sonogram():
 
     def __init__(self,enableDenoise=False):
+        '''
+        Initialize Sonogram Class
+
+        enableDenoise : False|True
+            Legacy code to support denoise, which has currently been removed.  Consider removing if denoise will not be reimplemented in the future.
+        '''
         #TODO: Should these be adjustable via initialization, or constants?
         self.secondDifference = 5
         self.gainWindow = 4
@@ -38,7 +44,27 @@ class Sonogram():
             self.groupClassifier = pickle.load(f)
     
     def processFile(self,filePath):
-        print("Loading file")
+        '''
+        Processes audio file to generate diarization output
+
+        filePath : string
+            Path to the audio file
+
+        Returns
+        --------
+        diarizationOutput : DiarizeOutput 
+            found here https://github.com/pyannote/pyannote-audio/blob/main/src/pyannote/audio/pipelines/speaker_diarization.py#L64
+
+        totalTimeInSeconds : int
+            Approximate total seconds of audio file
+
+        waveformGainAdjusted : np.array
+            The waveform of the audio file after equalization
+
+        sampleRate : int
+            The sample rate of the audio file
+        '''
+        print(f"Loading file : {filePath}")
         waveformList, sampleRate = su.splitIntoTimeSegments(filePath,600)
         print("File loaded")
         waveformEnhanced = su.combineWaveforms(waveformList)    
@@ -74,5 +100,6 @@ class Sonogram():
             else:
                 # May not be necessary, consider using to reformat default names away from SPEAKER_XX
                 labelMapping[speaker] = speaker
+        # Rename in place
         annotation.rename_labels(labelMapping)
         return annotation, totalTimeInSeconds, waveformGainAdjusted, sampleRate