Update app.py

app.py

@@ -2,18 +2,18 @@ import gradio as gr
 import re
 import pandas as pd
 
-def build_keywords_dict(primary_inputs, synonym_inputs):
-    """Build keyword dictionary from separate primary and synonym inputs"""
+def build_keywords_dict(primary_inputs, associated_inputs):
+    """Build keyword dictionary from separate primary and associated word inputs"""
     keywords_dict = {}
     
-    for primary, synonyms in zip(primary_inputs, synonym_inputs):
+    for primary, associated in zip(primary_inputs, associated_inputs):
         if primary and primary.strip():  # Only process if primary keyword exists
             primary_clean = primary.strip()
-            if synonyms and synonyms.strip():
-                synonym_list = [s.strip() for s in synonyms.split(';') if s.strip()]
+            if associated and associated.strip():
+                associated_list = [s.strip() for s in associated.split(';') if s.strip()]
             else:
-                synonym_list = []
-            keywords_dict[primary_clean] = synonym_list
+                associated_list = []
+            keywords_dict[primary_clean] = associated_list
     
     return keywords_dict
 
@@ -24,8 +24,8 @@ def find_keywords(story, keywords_dict):
     
     found_keywords = set()
     
-    # Search for each primary keyword and its synonyms
-    for primary_keyword, synonyms in keywords_dict.items():
+    # Search for each primary keyword and its associated words
+    for primary_keyword, associated_words in keywords_dict.items():
         keyword_group_found = False
         
         # Check primary keyword
@@ -37,19 +37,19 @@ def find_keywords(story, keywords_dict):
             if re.search(pattern, story, re.IGNORECASE):
                 keyword_group_found = True
         
-        # Check each synonym
-        for synonym in synonyms:
-            if synonym.upper() == "US":
+        # Check each associated word
+        for associated in associated_words:
+            if associated.upper() == "US":
                 if ' US ' in story or story.startswith('US ') or story.endswith(' US'):
                     keyword_group_found = True
             else:
-                if re.search(r'\b' + re.escape(synonym) + r'\b', story, re.IGNORECASE):
+                if re.search(r'\b' + re.escape(associated) + r'\b', story, re.IGNORECASE):
                     keyword_group_found = True
         
         # If any keyword from this group was found, add ALL keywords from the group
         if keyword_group_found:
             found_keywords.add(primary_keyword)  # Always include the primary
-            found_keywords.update(synonyms)     # Add all synonyms
+            found_keywords.update(associated_words)  # Add all associated words
     
     return '; '.join(sorted(found_keywords))
 
@@ -83,15 +83,15 @@ def create_keyword_results_table(found_keywords_str, keywords_dict, input_text):
     
     # Group keywords by their primary category
     keyword_groups = {}
-    for primary, synonyms in keywords_dict.items():
+    for primary, associated_words in keywords_dict.items():
         found_in_group = []
         # Check if primary keyword was found
         if primary in found_keywords:
             found_in_group.append(primary)
-        # Check if any synonyms were found
-        for synonym in synonyms:
-            if synonym in found_keywords:
-                found_in_group.append(synonym)
+        # Check if any associated words were found
+        for associated in associated_words:
+            if associated in found_keywords:
+                found_in_group.append(associated)
         
         if found_in_group:
             keyword_groups[primary] = found_in_group
@@ -189,15 +189,15 @@ def create_keyword_results_table(found_keywords_str, keywords_dict, input_text):
     
     return table_html
 
-def process_text(input_text, primary1, synonyms1, primary2, synonyms2, primary3, synonyms3, primary4, synonyms4, primary5, synonyms5):
+def process_text(input_text, primary1, associated1, primary2, associated2, primary3, associated3, primary4, associated4, primary5, associated5):
     """Main processing function with added results table"""
     if not input_text.strip():
         return "Please enter some text to analyse", "", "", "No keywords found"
     
     # Build keywords dictionary from separate inputs
     primary_inputs = [primary1, primary2, primary3, primary4, primary5]
-    synonym_inputs = [synonyms1, synonyms2, synonyms3, synonyms4, synonyms5]
-    keywords_dict = build_keywords_dict(primary_inputs, synonym_inputs)
+    associated_inputs = [associated1, associated2, associated3, associated4, associated5]
+    keywords_dict = build_keywords_dict(primary_inputs, associated_inputs)
     
     if not keywords_dict:
         return "Please enter at least one primary keyword", "", "", "No keyword dictionary provided"
@@ -222,7 +222,7 @@ def process_text(input_text, primary1, synonyms1, primary2, synonyms2, primary3,
 **Matched Keywords:** {found_keywords_str}
 **Keyword Dictionary Stats:**
 - Primary keywords loaded: {len(keywords_dict)}
-- Total searchable terms: {sum(len(synonyms) + 1 for synonyms in keywords_dict.values())}
+- Total searchable terms: {sum(len(associated) + 1 for associated in keywords_dict.values())}
 **Copy this result to your spreadsheet:**
 {found_keywords_str}
 """
@@ -234,15 +234,15 @@ def create_interface():
     # theme stays in gr.Blocks(), ssr_mode goes in launch()
     with gr.Blocks(title="Keyword Tagging Tool", theme=gr.themes.Soft()) as demo:
         gr.HTML("""
-        <h1>Controlled Vocabluary Keyword Tagging Tool</h1>
+        <h1>Controlled Vocabulary Keyword Tagging Tool</h1>
         
-        <p>This tool demonstrates how a simple python script can be used to extract keywords from text using a controlled vocabulary of primary keywords and associated keywords/synonyms. 
+        <p>This tool demonstrates how a simple python script can be used to extract keywords from text using a controlled vocabulary of primary keywords and associated words (abbreviations, alternate spellings, or related concepts). 
        </p>
         
         <h2>How to use this tool:</h2>
         <ol>
         <li>📝 <strong>Enter your text</strong> in the left panel</li>
-        <li>📚 <strong>Define your keyword dictionary</strong> in the right panel - enter primary keywords and their synonyms</li>
+        <li>📚 <strong>Define your keyword dictionary</strong> in the right panel - enter primary keywords and their associated words</li>
         <li>🔍 <strong>Click "Find Keywords"</strong> to see results</li>
         <li>📋 <strong>Copy the results</strong> to paste into your spreadsheet</li>
         </ol>
@@ -258,32 +258,32 @@ def create_interface():
                 )
             
             with gr.Column(scale=1):
-                gr.Markdown("**Keyword Dictionary** - Enter primary keywords and their synonyms:")
+                gr.Markdown("**Keyword Dictionary** - Enter primary keywords and their associated words:")
                 
                 # Row 1
                 with gr.Row():
                     primary1 = gr.Textbox(label="Primary Keyword 1", placeholder="e.g., Prisoner of War", scale=1)
-                    synonyms1 = gr.Textbox(label="Synonyms 1", placeholder="e.g., POW; POWs; prisoner of war", scale=2)
+                    associated1 = gr.Textbox(label="Associated Words 1", placeholder="e.g., POW; POWs; prisoner of war", scale=2)
                 
                 # Row 2
                 with gr.Row():
                     primary2 = gr.Textbox(label="Primary Keyword 2", placeholder="e.g., United States", scale=1)
-                    synonyms2 = gr.Textbox(label="Synonyms 2", placeholder="e.g., USA; US; America", scale=2)
+                    associated2 = gr.Textbox(label="Associated Words 2", placeholder="e.g., USA; US; America", scale=2)
                 
                 # Row 3
                 with gr.Row():
                     primary3 = gr.Textbox(label="Primary Keyword 3", placeholder="e.g., University", scale=1)
-                    synonyms3 = gr.Textbox(label="Synonyms 3", placeholder="e.g., university; institution; college", scale=2)
+                    associated3 = gr.Textbox(label="Associated Words 3", placeholder="e.g., university; institution; college", scale=2)
                 
                 # Row 4
                 with gr.Row():
                     primary4 = gr.Textbox(label="Primary Keyword 4", placeholder="Optional", scale=1)
-                    synonyms4 = gr.Textbox(label="Synonyms 4", placeholder="Optional", scale=2)
+                    associated4 = gr.Textbox(label="Associated Words 4", placeholder="Optional", scale=2)
                 
                 # Row 5
                 with gr.Row():
                     primary5 = gr.Textbox(label="Primary Keyword 5", placeholder="Optional", scale=1)
-                    synonyms5 = gr.Textbox(label="Synonyms 5", placeholder="Optional", scale=2)
+                    associated5 = gr.Textbox(label="Associated Words 5", placeholder="Optional", scale=2)
         
         # Full width Find Keywords button
         with gr.Row():
@@ -335,7 +335,7 @@ def create_interface():
         
         gr.Examples(
             examples=[example1, example2],
-            inputs=[text_input, primary1, synonyms1, primary2, synonyms2, primary3, synonyms3, primary4, synonyms4, primary5, synonyms5],
+            inputs=[text_input, primary1, associated1, primary2, associated2, primary3, associated3, primary4, associated4, primary5, associated5],
             label="Click an example to try it out"
         )
         
@@ -351,7 +351,7 @@ def create_interface():
         # Button functions
         find_btn.click(
             fn=process_text,
-            inputs=[text_input, primary1, synonyms1, primary2, synonyms2, primary3, synonyms3, primary4, synonyms4, primary5, synonyms5],
+            inputs=[text_input, primary1, associated1, primary2, associated2, primary3, associated3, primary4, associated4, primary5, associated5],
             outputs=[results_output, highlighted_output, results_table_output, copy_output]
         )
         
@@ -362,7 +362,7 @@ def create_interface():
         
         clear_dict_btn.click(
             fn=clear_dictionary_only,
-            outputs=[primary1, synonyms1, primary2, synonyms2, primary3, synonyms3, primary4, synonyms4, primary5, synonyms5]
+            outputs=[primary1, associated1, primary2, associated2, primary3, associated3, primary4, associated4, primary5, associated5]
         )
         
         # Instructions
@@ -371,13 +371,13 @@ def create_interface():
         
         **How to enter keywords:**
         - **Primary Keyword:** Enter the main/preferred term for a concept
-        - **Synonyms:** Enter alternative terms separated by semicolons `;`
+        - **Associated Words:** Enter alternative terms separated by semicolons `;`
         - Leave rows blank if you don't need all 5 keyword groups
         - The tool will find ANY of these terms and return ALL related terms
         
         **Example:**
         - Primary: `Prisoner of War`
-        - Synonyms: `POW; POWs; prisoner of war`
+        - Associated Words: `POW; POWs; prisoner of war`
         
         **Special Handling:**
         - "US" is matched exactly to avoid confusion with the word "us"
@@ -385,7 +385,7 @@ def create_interface():
         - Results are alphabetised and deduplicated
         
         **How it works:**
-        When ANY variant is found in your text (primary OR synonym), the tool returns the complete standardized set of terms for that concept.
+        When ANY variant is found in your text (primary OR associated word), the tool returns the complete standardised set of terms for that concept.
         """)
         
         # Bottom horizontal line and footer