feat: improve logs and comments

aip_trainer/WordMatching.py

@@ -84,7 +84,7 @@ def get_best_path_from_distance_matrix(word_distance_matrix):
         return []
 
 
-def get_resulting_string(mapped_indices: np.array, words_estimated: list, words_real: list) -> list:
+def get_resulting_string(mapped_indices: np.array, words_estimated: list, words_real: list) -> tuple[list, list]:
     mapped_words = []
     mapped_words_indices = []
     WORD_NOT_FOUND_TOKEN = '-'

aip_trainer/lambdas/lambdaSpeechToScore.py

@@ -50,7 +50,7 @@ def lambda_handler(event, context):
 
     start = time.time()
     app_logger.info(f'Loading .ogg file file {random_file_name} ...')
-    signal, fs = audioread_load(random_file_name)
+    signal, _ = audioread_load(random_file_name)
 
     duration = time.time() - start
     app_logger.info(f'Read .ogg file {random_file_name} in {duration}s.')
@@ -86,8 +86,9 @@ def lambda_handler(event, context):
 
     is_letter_correct_all_words = ''
     for idx, word_real in enumerate(words_real):
-        mapped_letters, mapped_letters_indices = wm.get_best_mapped_words(
-            mapped_words[idx], word_real)
+        mapped_letters, _ = wm.get_best_mapped_words(
+            mapped_words[idx], word_real
+        )
 
         is_letter_correct = wm.getWhichLettersWereTranscribedCorrectly(
             word_real, mapped_letters)  # , mapped_letters_indices)

aip_trainer/models/RuleBasedModels.py

@@ -13,10 +13,9 @@ class EpitranPhonemConverter(ModelInterfaces.ITextToPhonemModel):
         self.epitran_model = epitran_model
 
     def convertToPhonem(self, sentence: str) -> str:
-
-        app_logger.info(f'starting EpitranPhonemConverter.convertToPhonem...')
+        app_logger.debug(f'starting EpitranPhonemConverter.convertToPhonem for sentence/token "{sentence}"...')
         phonem_representation = self.epitran_model.transliterate(sentence)
-        app_logger.info(f'EpitranPhonemConverter: got phonem_representation!')
+        app_logger.debug(f'EpitranPhonemConverter: got phonem_representation for sentence/token "{sentence}"!')
         return phonem_representation
 
 
@@ -26,6 +25,8 @@ class EngPhonemConverter(ModelInterfaces.ITextToPhonemModel):
         super().__init__()
 
     def convertToPhonem(self, sentence: str) -> str:
+        app_logger.debug(f'starting EngPhonemConverter.convertToPhonem for sentence/token "{sentence}"...')
         phonem_representation = eng_to_ipa.convert(sentence)
         phonem_representation = phonem_representation.replace('*','')
+        app_logger.debug(f'EngPhonemConverter: got phonem_representation for sentence/token "{sentence}"!')
         return phonem_representation

webApp.py

@@ -31,7 +31,6 @@ def getNext():
 @app.route(rootPath+'/GetAccuracyFromRecordedAudio', methods=['POST'])
 def GetAccuracyFromRecordedAudio():
     try:
-        # todo: inserire 
         event = {'body': json.dumps(request.get_json(force=True))}
         lambda_correct_output = lambdaSpeechToScore.lambda_handler(event, [])
         return lambda_correct_output