Update src/streamlit_app.py

src/streamlit_app.py

@@ -8,8 +8,6 @@ import plotly.express as px
 import zipfile
 import json
 import hashlib
-
-
 from typing import Optional
 from gliner import GLiNER
 from comet_ml import Experiment
@@ -18,8 +16,6 @@ from comet_ml import Experiment
 st.set_page_config(layout="wide", page_title="NER")
 st.subheader("HR.ai", divider="green")
 st.link_button("by nlpblogs", "https://nlpblogs.com", type="tertiary")
-
-
 st.markdown(
     """
     <style>
@@ -67,40 +63,11 @@ st.markdown(
         background-color: #D4F4D4;
         color: #000000;
     }
-    
     </style>
     """,
-    unsafe_allow_html=True
-)
-
+    unsafe_allow_html=True)
 expander = st.expander("**Important notes**")
-expander.write(""" 
-**How to Use the HR.ai web app:** 
-
-1. Type or paste your text into the text area, then press Ctrl + Enter.
-2. Click the 'Results' button to extract and tag entities in your text data. 
-
-Results are presented in easy-to-read tables, visualized in an interactive tree map, pie chart and bar chart, and are available for download along with a Glossary of tags.      
-
-**How to Use the Question-Answering feature:**
-
-1. Type or paste your text into the text area, then press Ctrl + Enter. 
-2. Click the 'Add Question' button to add your question to the Record of Questions. You can manage your questions by deleting them one by one.
-3. Click the 'Extract Answers' button to extract the answer to your question.
-
-Results are presented in an easy-to-read table, visualized in an interactive tree map, and is available for download.   
-
-**Entities:** "Email", "Phone_number", "Street_address", "City", "Country", "Date_of_birth", "Marital_status", "Person", "Full_time", "Part_time", "Contract", "Terminated", "Retired", "Job_title", "Date", "Organization", "Role", "Performance_score", "Leave_of_absence", "Retirement_plan", "Bonus", "Stock_options", "Health_insurance", "Pay_rate", "Annual_salary", "Tax", "Deductions", "Interview_type", "Applicant", "Referral", "Job_board", "Recruiter", "Offer_letter", "Agreement", "Certification", "Skill"
-
-**Usage Limits:** You can request results unlimited times for one (1) month.      
-
-**Supported Languages:** English     
-
-**Technical issues:** If your connection times out, please refresh the page or reopen the app's URL. 
-
-For any errors or inquiries, please contact us at info@nlpblogs.com""")
-
-
+expander.write(""" **How to Use the HR.ai web app:** 1. Type or paste your text into the text area, then press Ctrl + Enter.2. Click the 'Results' button to extract and tag entities in your text data. Results are presented in easy-to-read tables, visualized in an interactive tree map, pie chart and bar chart, and are available for download along with a Glossary of tags.      **How to Use the Question-Answering feature:**1. Type or paste your text into the text area, then press Ctrl + Enter. 2. Click the 'Add Question' button to add your question to the Record of Questions. You can manage your questions by deleting them one by one.3. Click the 'Extract Answers' button to extract the answer to your question.Results are presented in an easy-to-read table, visualized in an interactive tree map, and is available for download.   **Entities:** "Email", "Phone_number", "Street_address", "City", "Country", "Date_of_birth", "Marital_status", "Person", "Full_time", "Part_time", "Contract", "Terminated", "Retired", "Job_title", "Date", "Organization", "Role", "Performance_score", "Leave_of_absence", "Retirement_plan", "Bonus", "Stock_options", "Health_insurance", "Pay_rate", "Annual_salary", "Tax", "Deductions", "Interview_type", "Applicant", "Referral", "Job_board", "Recruiter", "Offer_letter", "Agreement", "Certification", "Skill"**Usage Limits:** You can request results unlimited times for one (1) month.      **Supported Languages:** English     **Technical issues:** If your connection times out, please refresh the page or reopen the app's URL. For any errors or inquiries, please contact us at info@nlpblogs.com""")
 with st.sidebar:
     st.write("Use the following code to embed the web app on your website. Feel free to adjust the width and height values to fit your page.")
     code = '''
@@ -117,16 +84,13 @@ with st.sidebar:
     st.divider()
     st.subheader("🚀 Ready to build your own AI Web App?", divider="green")
     st.link_button("AI Web App Builder", "https://nlpblogs.com/build-your-named-entity-recognition-app/", type="primary")
-
 # --- Comet ML Setup ---
 COMET_API_KEY = os.environ.get("COMET_API_KEY")
 COMET_WORKSPACE = os.environ.get("COMET_WORKSPACE")
 COMET_PROJECT_NAME = os.environ.get("COMET_PROJECT_NAME")
 comet_initialized = bool(COMET_API_KEY and COMET_WORKSPACE and COMET_PROJECT_NAME)
-
 if not comet_initialized:
     st.warning("Comet ML not initialized. Check environment variables.")
-
 # --- Model Loading and Caching ---
 @st.cache_resource
 def load_gliner_model(model_name):
@@ -139,10 +103,8 @@ def load_gliner_model(model_name):
     except Exception as e:
         st.error(f"Error loading the GLiNER model: {e}")
         st.stop()
-
 # --- HR_AI Model Labels and Mappings ---
 labels = ["Email", "Phone_number", "Street_address", "City", "Country", "Date_of_birth", "Marital_status", "Person", "Full_time", "Part_time", "Contract", "Terminated", "Retired", "Job_title", "Date", "Organization", "Role", "Performance_score", "Leave_of_absence", "Retirement_plan", "Bonus", "Stock_options", "Health_insurance", "Pay_rate", "Annual_salary", "Tax", "Deductions", "Interview_type", "Applicant", "Referral", "Job_board", "Recruiter", "Offer_letter", "Agreement", "Certification", "Skill"]
-
 category_mapping = {
     "Contact Information": ["Email", "Phone_number", "Street_address", "City", "Country"],
     "Personal Details": ["Date_of_birth", "Marital_status", "Person"],
@@ -155,51 +117,53 @@ category_mapping = {
     "Deductions": ["Tax", "Deductions"],
     "Recruitment & Sourcing": ["Interview_type", "Applicant", "Referral", "Job_board", "Recruiter"],
     "Legal & Compliance": ["Offer_letter", "Agreement"],
-    "Professional_Development": ["Certification", "Skill"]
-}
+    "Professional_Development": ["Certification", "Skill"]}
 reverse_category_mapping = {label: category for category, label_list in category_mapping.items() for label in label_list}
-
 # --- InfoFinder Helpers ---
 if 'user_labels' not in st.session_state:
     st.session_state.user_labels = []
-
 def get_stable_color(label):
     hash_object = hashlib.sha1(label.encode('utf-8'))
     hex_dig = hash_object.hexdigest()
     return '#' + hex_dig[:6]
-
 # --- Main App with Tabs ---
 tab1, tab2 = st.tabs(["HR.ai", "Question-Answering"])
-
 with tab1:
-    
-    
     # Load model for this tab
     model_hr = load_gliner_model("HR_AI")
-
-    text = st.text_area("Type or paste your text below, and then press Ctrl + Enter", height=250, key='my_text_area_hr')
-
+    
+    # Define the word limit
+    word_limit = 200
+    
+    text = st.text_area("Type or paste your text below (max 200 words), and then press Ctrl + Enter", height=250, key='my_text_area_hr')
+    
+    # Calculate and display the word count
+    word_count = len(text.split())
+    st.markdown(f"**Word count:** {word_count}/{word_limit}")
+    
     def clear_text_hr():
         st.session_state['my_text_area_hr'] = ""
-
+    
     st.button("Clear text", on_click=clear_text_hr, key="clear_hr")
-
+    
     if st.button("Results"):
         start_time = time.time()
+        
+        # Check for word limit and empty text
         if not text.strip():
             st.warning("Please enter some text to extract entities.")
+        elif word_count > word_limit:
+            st.warning(f"Your text exceeds the {word_limit} word limit. Please shorten it to continue.")
         else:
             with st.spinner("Extracting entities...", show_time=True):
                 entities = model_hr.predict_entities(text, labels)
                 df = pd.DataFrame(entities)
-
                 if not df.empty:
                     df['category'] = df['label'].map(reverse_category_mapping)
                     if comet_initialized:
                         experiment = Experiment(api_key=COMET_API_KEY, workspace=COMET_WORKSPACE, project_name=COMET_PROJECT_NAME)
                         experiment.log_parameter("input_text", text)
                         experiment.log_table("predicted_entities", df)
-
                     st.subheader("Grouped Entities by Category", divider="green")
                     category_names = sorted(list(category_mapping.keys()))
                     category_tabs_hr = st.tabs(category_names)
@@ -210,7 +174,6 @@ with tab1:
                                 st.dataframe(df_category_filtered.drop(columns=['category']), use_container_width=True)
                             else:
                                 st.info(f"No entities found for the '{category_name}' category.")
-
                     with st.expander("See Glossary of tags"):
                         st.write('''
                         - **text**: ['entity extracted from your text data']
@@ -220,12 +183,10 @@ with tab1:
                         - **end**: ['index of the end of the corresponding entity']
                         ''')
                     st.divider()
-                    
                     st.subheader("Candidate Card", divider="green")
                     fig_treemap = px.treemap(df, path=[px.Constant("all"), 'category', 'label', 'text'], values='score', color='category')
                     fig_treemap.update_layout(margin=dict(t=50, l=25, r=25, b=25), paper_bgcolor='#F5FFFA', plot_bgcolor='#F5FFFA')
                     st.plotly_chart(fig_treemap)
-                    
                     col1, col2 = st.columns(2)
                     with col1:
                         st.subheader("Pie chart", divider="green")
@@ -235,13 +196,11 @@ with tab1:
                         fig_pie.update_traces(textposition='inside', textinfo='percent+label')
                         fig_pie.update_layout(paper_bgcolor='#F5FFFA', plot_bgcolor='#F5FFFA')
                         st.plotly_chart(fig_pie)
-                    
                     with col2:
                         st.subheader("Bar chart", divider="green")
                         fig_bar = px.bar(grouped_counts, x="count", y="category", color="category", text_auto=True, title='Occurrences of predicted categories')
                         fig_bar.update_layout(paper_bgcolor='#F5FFFA', plot_bgcolor='#F5FFFA')
                         st.plotly_chart(fig_bar)
-                    
                     st.subheader("Most Frequent Entities", divider="green")
                     word_counts = df['text'].value_counts().reset_index()
                     word_counts.columns = ['Entity', 'Count']
@@ -253,50 +212,37 @@ with tab1:
                         st.plotly_chart(fig_repeating_bar)
                     else:
                         st.warning("No entities were found that occur more than once.")
-                    
                     st.divider()
-                    
                     dfa = pd.DataFrame(data={'Column Name': ['text', 'label', 'score', 'start', 'end'], 'Description': ['entity extracted from your text data', 'label (tag) assigned to a given extracted entity', 'accuracy score; how accurately a tag has been assigned to a given entity', 'index of the start of the corresponding entity', 'index of the end of the corresponding entity']})
                     buf = io.BytesIO()
                     with zipfile.ZipFile(buf, "w") as myzip:
                         myzip.writestr("Summary of the results.csv", df.to_csv(index=False))
                         myzip.writestr("Glossary of tags.csv", dfa.to_csv(index=False))
-                    
                     st.download_button(
                         label="Download results and glossary (zip)",
                         data=buf.getvalue(),
                         file_name="nlpblogs_results.zip",
                         mime="application/zip",
                     )
-                    
                     if comet_initialized:
                         experiment.log_figure(figure=fig_treemap, figure_name="entity_treemap_categories")
                         experiment.end()
                 else:
                     st.warning("No entities were found in the provided text.")
-            
             end_time = time.time()
             elapsed_time = end_time - start_time
             st.text("")
             st.text("")
             st.info(f"Results processed in **{elapsed_time:.2f} seconds**.")
-
 with tab2:
-    
-
     # Load model for this tab
     model_qa = load_gliner_model("InfoFinder")
-
     user_text = st.text_area("Type or paste your text below, and then press Ctrl + Enter", height=250, key='my_text_area_infofinder')
-
     def clear_text_qa():
         st.session_state['my_text_area_infofinder'] = ""
-
     st.button("Clear text", on_click=clear_text_qa, key="clear_qa")
-
     st.subheader("Question-Answering", divider="green")
     question_input = st.text_input("Ask wh-questions. **Wh-questions begin with what, when, where, who, whom, which, whose, why and how. We use them to ask for specific information.**")
-
     if st.button("Add Question"):
         if question_input:
             if question_input not in st.session_state.user_labels:
@@ -306,10 +252,8 @@ with tab2:
                 st.warning("This question has already been added.")
         else:
             st.warning("Please enter a question.")
-            
     st.markdown("---")
     st.subheader("Record of Questions", divider="green")
-
     if st.session_state.user_labels:
         for i, label in enumerate(st.session_state.user_labels):
             col_list, col_delete = st.columns([0.9, 0.1])
@@ -321,9 +265,7 @@ with tab2:
                     st.rerun()
     else:
         st.info("No questions defined yet. Use the input above to add one.")
-
     st.divider()
-
     if st.button("Extract Answers"):
         if not user_text.strip():
             st.warning("Please enter some text to analyze.")
@@ -334,7 +276,6 @@ with tab2:
                 experiment = Experiment(api_key=COMET_API_KEY, workspace=COMET_WORKSPACE, project_name=COMET_PROJECT_NAME)
                 experiment.log_parameter("input_text_length", len(user_text))
                 experiment.log_parameter("defined_labels", st.session_state.user_labels)
-
             start_time = time.time()
             with st.spinner("Analyzing text...", show_time=True):
                 try:
@@ -342,27 +283,22 @@ with tab2:
                     end_time = time.time()
                     elapsed_time = end_time - start_time
                     st.info(f"Processing took **{elapsed_time:.2f} seconds**.")
-
                     if entities:
                         df1 = pd.DataFrame(entities)
                         df2 = df1[['label', 'text', 'score']]
                         df = df2.rename(columns={'label': 'question', 'text': 'answer'})
-                        
                         st.subheader("Extracted Answers", divider="green")
                         expander = st.expander("**Download**")
-                        expander.write(""" 
-                        To download the data, simply hover your cursor over the table. A download icon will appear on the right side.
+                        expander.write("""
+                         To download the data, simply hover your cursor over the table. A download icon will appear on the right side.
                         """)
                         st.dataframe(df, use_container_width=True)
-
                         st.subheader("Tree map", divider="green")
                         all_labels = df['question'].unique()
                         label_color_map = {label: get_stable_color(label) for label in all_labels}
                         fig_treemap = px.treemap(df, path=[px.Constant("all"), 'question', 'answer'], values='score', color='question', color_discrete_map=label_color_map)
                         fig_treemap.update_layout(margin=dict(t=50, l=25, r=25, b=25), paper_bgcolor='#F3E5F5', plot_bgcolor='#F3E5F5')
                         st.plotly_chart(fig_treemap)
-
-                       
                         if comet_initialized:
                             experiment.log_metric("processing_time_seconds", elapsed_time)
                             experiment.log_table("predicted_entities", df)
@@ -377,6 +313,4 @@ with tab2:
                     st.write(f"Error details: {e}")
                     if comet_initialized:
                         experiment.log_text(f"Error: {e}")
-                        experiment.end()
-
-      
+                        experiment.end()