Update app.py

app.py

@@ -3,9 +3,11 @@ import time
 import streamlit.components.v1 as components
 
 # FIRST: Set page config before ANY other Streamlit command
-st.set_page_config(page_title="Spirituality Q&A", page_icon="🕉️")
+# Update title to "Anveshak"
+st.set_page_config(page_title="Anveshak", page_icon="🕉️")
 
 # Initialize ALL session state variables right at the beginning
+# This ensures consistent state management across application reruns
 if 'initialized' not in st.session_state:
     st.session_state.initialized = False
 if 'model' not in st.session_state:
@@ -42,10 +44,17 @@ from utils import setup_all_auth
 
 # Function to toggle acknowledgment visibility
 def toggle_acknowledgment():
+    """Toggle the visibility of the acknowledgment section."""
     st.session_state.show_acknowledgment = not st.session_state.show_acknowledgment
 
 # Custom HTML/JS to navigate to sources page
 def navigate_to_sources():
+    """
+    Create a JavaScript function to navigate to the Sources page.
+    
+    This uses Streamlit components to inject JavaScript that finds and clicks
+    the Sources link in the sidebar navigation.
+    """
     components.html(
         """
         <script>
@@ -190,6 +199,14 @@ div.stInfo {
     text-align: center;
     margin-bottom: 1rem;
 }
+/* Subtitle styling */
+.subtitle {
+    font-size: 1.2rem;
+    color: #555;
+    text-align: center;
+    margin-bottom: 1.5rem;
+    font-style: italic;
+}
 /* Button container for centering */
 .center-container {
     display: flex;
@@ -208,7 +225,8 @@ div.stInfo {
     color: #6a1b9a;
 }
 </style>
-<div class="main-title">Spirituality Q&A</div>
+<div class="main-title">Anveshak</div>
+<div class="subtitle">A Spirituality Q&A Application</div>
 """, unsafe_allow_html=True)
 
 # Centered button layout without columns
@@ -226,6 +244,7 @@ with center_col:  # Put everything in the center column
         st.markdown('</div>', unsafe_allow_html=True)
 
 # Preload resources during initialization
+# This ensures the model, index, and data are loaded before the user interacts with the app
 init_message = st.empty()
 if not st.session_state.initialized:
     init_message.info("Hang in there! We are setting the system up for you. 😊")
@@ -247,15 +266,16 @@ elif st.session_state.init_time is not None:
         init_message.empty()
         st.session_state.init_time = None
 
+# Display the acknowledgment section if toggled on
 if st.session_state.show_acknowledgment:
     st.markdown('<div class="acknowledgment-container">', unsafe_allow_html=True)
     st.markdown('<div class="acknowledgment-header">A Heartfelt Thank You</div>', unsafe_allow_html=True)
     st.markdown("""
-    It is believed that one cannot be in a spiritual path without the will of the Lord. One need not be a believer or a non-believer, merely proceeding to thoughtlessness and observation is enough to evolve and shape perspectives. But that happens through grace. It is believed that without the will of the Lord, one cannot be blessed by real saints, and without the will of the saints, one cannot get close to them or God.
+    It is believed that one cannot be in a spiritual path without the will of the Lord. One need not be a believer or a non-believer, merely proceeding to thoughtlessness and observation is enough to evolve and shape perspectives. But that happens through grace. It is believed that without the will of the Lord, one cannot be blessed by real Saints, and without the will of the Saints, one cannot get close to them or God.
     
     Therefore, with deepest reverence, we express our gratitude to:
     
-    **The Saints, Sages, Siddhas, Yogis, and Spiritual Masters** whose timeless wisdom illuminates this application. From ancient sages to modern masters, their selfless dedication to uplift humanity through selfless love and spiritual knowledge continues to guide seekers on the path.
+    **The Saints, Sages, Siddhas, Yogis, Sadhus, Rishis, Gurus, Mystics, and Spiritual Masters** of all backgrounds, genders, and traditions whose timeless wisdom illuminates this application. From ancient sages to modern masters, their selfless dedication to uplift humanity through selfless love and spiritual knowledge continues to guide seekers on the path.
     
     **The Sacred Texts** that have preserved the eternal truths across millennia, offering light in times of darkness and clarity in times of confusion.
     
@@ -274,7 +294,16 @@ if st.session_state.show_acknowledgment:
 
 # Function to handle query selection from the common questions buttons
 def set_query(query):
-    # If already processing, ignore further input
+    """
+    Handle selection of a pre-defined question from the UI.
+    
+    This sets the selected question as the current query, marks it for processing,
+    and triggers a rerun of the app to process the query.
+    
+    Args:
+        query (str): The selected question text
+    """
+    # If already processing, ignore further input to prevent multiple submissions
     if st.session_state.is_processing:
         return
     st.session_state.last_query = query
@@ -284,6 +313,19 @@ def set_query(query):
 
 # Function to group questions into rows based on length
 def group_buttons(questions, max_chars_per_row=100):
+    """
+    Organize common questions into rows for better UI layout.
+    
+    This function groups questions into rows based on character length to
+    ensure they fit well in the UI and look visually balanced.
+    
+    Args:
+        questions (list): List of question strings
+        max_chars_per_row (int): Maximum total characters per row
+        
+    Returns:
+        list: A list of rows, where each row is a list of questions
+    """
     rows = []
     current_row = []
     current_length = 0
@@ -301,7 +343,8 @@ def group_buttons(questions, max_chars_per_row=100):
         rows.append(current_row)
     return rows
 
-# All common questions in a single list
+# Common spiritual questions for users to select from
+# These represent fundamental spiritual inquiries across traditions
 common_questions = [
     "What is the Atman or the soul?",
     "Are there rebirths?",
@@ -327,9 +370,18 @@ for row_idx, row in enumerate(question_rows):
             if st.button(q, key=f"r{row_idx}_q{i}", use_container_width=True, disabled=st.session_state.is_processing):
                 set_query(q)
 
-# Function to handle form submission
+# Function to handle custom question submission from the form
 def handle_form_submit():
-    # If already processing, ignore further input
+    """
+    Process user-submitted questions from the input form.
+    
+    This function:
+    1. Checks if a query is already being processed
+    2. Validates that the input isn't empty
+    3. Sets the query for processing
+    4. Increments the form key to force a reset after submission
+    """
+    # If already processing, ignore further input to prevent multiple submissions
     if st.session_state.is_processing:
         return
     if st.session_state.query_input and st.session_state.query_input.strip():
@@ -339,7 +391,7 @@ def handle_form_submit():
         # Increment the form key to force a reset
         st.session_state.form_key += 1
 
-# Create a form with a dynamic key (to allow resetting)
+# Create a form with a dynamic key (to allow resetting after submission)
 with st.form(key=f"query_form_{st.session_state.form_key}"):
     query = st.text_input("Ask your question:", key="query_input", 
                           placeholder="Press enter to submit your question", disabled=st.session_state.is_processing)
@@ -350,18 +402,22 @@ if st.session_state.last_query:
     st.markdown("### Current Question:")
     st.info(st.session_state.last_query)
 
-# Sliders for customization
+# Sliders for customization - allows users to control retrieval parameters
 col1, col2 = st.columns(2)
 with col1:
+    # Control how many different sources will be used for the answer
     top_k = st.slider("Number of sources:", 3, 10, 5)
 with col2:
+    # Control the maximum length of the generated answer
     word_limit = st.slider("Word limit:", 50, 500, 200)
 
 # Process the query only if it has been explicitly submitted
+# This prevents automatic processing on page load or slider adjustments
 if st.session_state.submit_clicked and st.session_state.last_query:
     st.session_state.submit_clicked = False
     with st.spinner("Processing your question..."):
         try:
+            # Call the RAG engine with the user's question and retrieval parameters
             result = process_query(st.session_state.last_query, top_k=top_k, word_limit=word_limit)
             st.session_state.last_answer = result  # Store result in session state
         except Exception as e:
@@ -370,7 +426,7 @@ if st.session_state.submit_clicked and st.session_state.last_query:
     st.session_state.is_processing = False
     st.rerun()
 
-# Display the answer if available
+# Display the answer and citations if available
 if st.session_state.last_answer is not None:
     st.subheader("Answer:")
     st.write(st.session_state.last_answer["answer_with_rag"])
@@ -383,11 +439,12 @@ st.markdown("---")
 
 # About section with enhanced explanations
 st.markdown("""
-### About this app
-**General:** This application uses a Retrieval-Augmented Generation (RAG) system to answer questions about spirituality based on insights from Indian 
-spiritual texts. It searches through a database of texts to find relevant passages and generates answers based on those passages. 
+### About Anveshak
+
+**General:** Anveshak (meaning "seeker" in Sanskrit) is a Retrieval-Augmented Generation (RAG) system that answers questions about spirituality based on insights from Indian 
+spiritual texts. It searches through a database of texts to find relevant passages and generates concise answers based on those passages.
 
-**Techical**: The RAG pipeline is powered by an underlying large embedding model that converts texts into searchable 
+**Technical:** The RAG pipeline is powered by an underlying large embedding model that converts texts into searchable 
 vector representations (using FAISS indices) and a Large Language Model (LLM) that summarizes and presents the findings of the system.
 
 #### Goal
@@ -395,21 +452,23 @@ The path and journey to the SELF is designed to be undertaken alone. The all-enc
 Not all find the SatGuru - the true, real Guru, for guidance.
 
 It has been observed that all of the necessary knowledge for spiritual progress is available in Indian spiritual texts. 
-Additionally, great saints, sages, siddhas, sadhus, rishis, yogis, mystics, and spiritual masters have imparted spiritual wisdom, 
+Additionally, great Saints, Sages, Siddhas, Yogis, Sadhus, Rishis, Gurus, Mystics, and Spiritual Masters of all genders, backgrounds, and traditions have imparted spiritual wisdom, 
 knowledge, and guidance to beings for ages in the Indian subcontinent and beyond.
 
 Our goal is to make a small contribution to the journey of beings toward self-discovery by making this knowledge available and accessible within 
 ethical, moral, and resource-based constraints. **We have no commercial or for-profit interests; this application is purely for educational purposes.** 
 We sincerely hope this humble offering supports your spiritual progress. God bless.
 
-**Additionally, through this humble effort, we offer our tribute, love, and gratitude to the higher beings — the saints and masters — whose works, 
+**Additionally, through this humble effort, we offer our tribute, love, and gratitude to the higher beings — the Saints, Sages, and Masters — whose works, 
 teachings, and wisdom have guided humanity and have inspired and informed this application.**
 
 #### Important to note
-- This is not a general chatbot. It is specifically designed to answer spiritual questions based on referenced texts, as against generating historical information or reproducing stories of saints or spiritual leaders.
+- This is not a general chatbot or conversational AI. It is specifically designed to answer spiritual questions with short, concise answers based on referenced texts. It does not generate historical information, reproduce lengthy stories, create lists, or remember past conversations.
 - You may receive slightly different answers when asking the same question multiple times. This variation is intentional and reflects the nuanced nature of spiritual teachings across different traditions.
 - While you can select a specific number of citations and word limit, the actual response may contain fewer citations based on relevance and availability of information. Similarly, explanations may be shorter than the selected word limit if the retrieved information is concise.
 - We apologize for any inconsistencies or misinterpretations that may occur. This application is educational in nature and continuously improving.
+- Currently, Anveshak is only available in English.
+- We do not save any user data or queries.
 
 We value your feedback to enhance this application. Please visit the *Contacts* page to share your suggestions or report any issues.
 
@@ -417,6 +476,7 @@ For more information about the source texts used, see *Sources* in the navigatio
 """)
 
 # Citation note at the bottom - improved with support message
+# This encourages users to purchase original works from publishers
 st.markdown('<div class="citation-note">', unsafe_allow_html=True)
 st.markdown("""
 The answers presented in this application are re-presented summaries of relevant passages from the listed citations.