update

app.py

@@ -5,17 +5,8 @@ import os
 import string
 import logging
 from datetime import datetime
-
-
-import os
-from huggingface_hub import login
-
-# Use the Hugging Face token from environment variables
-hf_token = os.environ.get("HF_TOKEN")
-if hf_token:
-    login(token=hf_token)
-else:
-    logger.error("HF_TOKEN not found in environment variables")
+import uuid
+from huggingface_hub import login, HfApi, hf_hub_download
 
 # Set up logging
 logging.basicConfig(level=logging.INFO,
@@ -26,64 +17,37 @@ logging.basicConfig(level=logging.INFO,
                     ])
 logger = logging.getLogger(__name__)
 
+# Use the Hugging Face token from environment variables
+hf_token = os.environ.get("HF_TOKEN")
+if hf_token:
+    login(token=hf_token)
+else:
+    logger.error("HF_TOKEN not found in environment variables")
+
 app = Flask(__name__)
 app.config['SECRET_KEY'] = 'supersecretkey'  # Change this to a random secret key
 
 # Directories for visualizations
-VISUALIZATION_DIRS_PLAN_OF_SQLS = {
-    "TP": "htmls_POS/TP",
-    "TN": "htmls_POS/TN",
-    "FP": "htmls_POS/FP",
-    "FN": "htmls_POS/FN"
+VISUALIZATION_DIRS = {
+    "No-XAI": "htmls_NO_XAI",
+    "Dater": "htmls_DATER",
+    "Chain-of-Table": "htmls_COT",
+    "Plan-of-SQLs": "htmls_POS"
 }
 
-VISUALIZATION_DIRS_CHAIN_OF_TABLE = {
-    "TP": "htmls_COT/TP",
-    "TN": "htmls_COT/TN",
-    "FP": "htmls_COT/FP",
-    "FN": "htmls_COT/FN"
-}
 
-VISUALIZATION_DIRS_NO_XAI = {
-    "TP": "htmls_NO_XAI/TP",
-    "TN": "htmls_NO_XAI/TN",
-    "FP": "htmls_NO_XAI/FP",
-    "FN": "htmls_NO_XAI/FN"
-}
+def generate_session_id():
+    return str(uuid.uuid4())
 
-VISUALIZATION_DIRS_DATER = {
-    "TP": "htmls_DATER/TP",
-    "TN": "htmls_DATER/TN",
-    "FP": "htmls_DATER/FP",
-    "FN": "htmls_DATER/FN"
-}
 
-import json
-import os
-from datetime import datetime
-
-from huggingface_hub import HfApi
-def save_session_data(username, data):
+def save_session_data(session_id, data):
     try:
-        # Extract seed and start_time from the data
-        seed = data.get('seed', 'unknown')
-        start_time = data.get('start_time', datetime.now().isoformat())
-
-        # Create a filename with username, seed, and start_time
-        file_name = f'{username}_seed{seed}_{start_time}_session.json'
-
-        # Remove any characters that might not be safe for filenames
-        file_name = "".join(c for c in file_name if c.isalnum() or c in ['_', '-', '.'])
-
-        # Convert data to JSON string
+        file_name = f'{session_id}_session.json'
         json_data = json.dumps(data, indent=4)
-
-        # Create a temporary file
         temp_file_path = f"/tmp/{file_name}"
         with open(temp_file_path, 'w') as f:
             f.write(json_data)
 
-        # Upload the file to the Hugging Face Space, overwriting if it exists
         api = HfApi()
         api.upload_file(
             path_or_fileobj=temp_file_path,
@@ -92,198 +56,140 @@ def save_session_data(username, data):
             repo_type="space",
         )
 
-        # Remove the temporary file
         os.remove(temp_file_path)
-
-        logger.info(f"Session data saved for user {username} with seed {seed} and start time {start_time} in Hugging Face Data Space")
+        logger.info(f"Session data saved for session ID {session_id} in Hugging Face Data Space")
     except Exception as e:
-        logger.exception(f"Error saving session data for user {username}: {e}")
+        logger.exception(f"Error saving session data for session ID {session_id}: {e}")
 
-from huggingface_hub import hf_hub_download, HfApi
 
-def load_session_data(username):
+def load_session_data(session_id):
     try:
-        # List all files in the repo
-        api = HfApi()
-        files = api.list_repo_files(repo_id="luulinh90s/Tabular-LLM-Study-Data", repo_type="space")
-
-        # Filter files for the user
-        user_files = [f for f in files if f.startswith(f'session_data_pref/{username}_')]
-
-        if not user_files:
-            logger.warning(f"No session data found for user {username}")
-            return None
-
-        # Get the most recent file
-        latest_file = sorted(user_files, reverse=True)[0]
-
-        # Download the file from the data storage Space
-        file_path = hf_hub_download(repo_id="luulinh90s/Tabular-LLM-Study-Data", repo_type="space",
-                                    filename=latest_file)
+        file_name = f'{session_id}_session.json'
+        file_path = hf_hub_download(
+            repo_id="luulinh90s/Tabular-LLM-Study-Data",
+            repo_type="space",
+            filename=f"session_data_pref/{file_name}"
+        )
 
         with open(file_path, 'r') as f:
             data = json.load(f)
 
-        logger.info(f"Session data loaded for user {username} from Hugging Face Data Space")
+        logger.info(f"Session data loaded for session ID {session_id} from Hugging Face Data Space")
         return data
     except Exception as e:
-        logger.exception(f"Error loading session data for user {username}: {e}")
+        logger.exception(f"Error loading session data for session ID {session_id}: {e}")
         return None
 
+
 def load_samples(methods):
     logger.info(f"Loading samples for methods: {methods}")
-    samples = set()  # Use a set to avoid duplicates
+    samples = set()
     categories = ["TP", "TN", "FP", "FN"]
 
-    method_dirs = [get_method_dir(method) for method in methods]
-
     for category in categories:
-        dir_a = f'htmls_{method_dirs[0].upper()}/{category}'
-        dir_b = f'htmls_{method_dirs[1].upper()}/{category}'
-
-        files_a = set(os.listdir(dir_a))
-        files_b = set(os.listdir(dir_b))
-
+        files_a = set(os.listdir(f'{VISUALIZATION_DIRS[methods[0]]}/{category}'))
+        files_b = set(os.listdir(f'{VISUALIZATION_DIRS[methods[1]]}/{category}'))
         matching_files = files_a & files_b
-
         for file in matching_files:
             samples.add((category, file))
 
-    # Convert set of tuples back to list of dictionaries
     samples = [{'category': category, 'file': file} for category, file in samples]
-
     logger.info(f"Loaded {len(samples)} unique samples across all categories")
     return samples
 
+
 def select_balanced_samples(samples):
     try:
-        # Ensure we have at least 10 unique samples
         unique_samples = list({(s['category'], s['file']) for s in samples})
-
         if len(unique_samples) < 10:
             logger.warning(f"Not enough unique samples. Only {len(unique_samples)} available.")
             selected_samples = unique_samples
         else:
             selected_samples = random.sample(unique_samples, 10)
 
-        logger.info(f"Unique sampled samples:\n{selected_samples}")
-
-        # Convert back to dictionary format
         selected_samples = [{'category': category, 'file': file} for category, file in selected_samples]
-
         logger.info(f"Selected {len(selected_samples)} unique samples")
         return selected_samples
     except Exception as e:
         logger.exception("Error selecting balanced samples")
         return []
 
-def generate_random_string(length=8):
-    return ''.join(random.choices(string.ascii_letters + string.digits, k=length))
 
 @app.route('/', methods=['GET', 'POST'])
 def index():
-    logger.info("Rendering index page.")
     if request.method == 'POST':
         username = request.form.get('username')
         seed = request.form.get('seed')
         methods = request.form.get('method').split(',')
 
         if not username or not seed or len(methods) != 2:
-            logger.error("Missing username, seed, or incorrect number of methods.")
             return "Please fill in all fields and select exactly two methods.", 400
 
         try:
-            seed_int = int(seed)  # Convert to int for random.seed()
+            seed_int = int(seed)
             random.seed(seed_int)
             all_samples = load_samples(methods)
             selected_samples = select_balanced_samples(all_samples)
-            logger.info(f"Number of selected samples: {len(selected_samples)}")
 
             if len(selected_samples) == 0:
-                logger.error("No samples were selected.")
                 return "No samples were selected", 500
 
+            session_id = generate_session_id()
             start_time = datetime.now().isoformat()
             session_data = {
+                'session_id': session_id,
                 'username': username,
-                'seed': seed,  # Store as string
+                'seed': seed,
                 'methods': methods,
                 'selected_samples': selected_samples,
                 'current_index': 0,
                 'responses': [],
                 'start_time': start_time
             }
-            save_session_data(username, session_data)
-            logger.info(f"Session data initialized for user: {username}")
+            save_session_data(session_id, session_data)
+            logger.info(f"New session initialized for user: {username}, session ID: {session_id}")
 
-            return redirect(url_for('experiment', username=username))
+            return redirect(url_for('experiment', session_id=session_id))
         except Exception as e:
             logger.exception(f"Error in index route: {e}")
             return "An error occurred", 500
     return render_template('index.html')
 
-@app.route('/experiment/<username>', methods=['GET', 'POST'])
-def experiment(username):
+
+@app.route('/experiment/<session_id>', methods=['GET', 'POST'])
+def experiment(session_id):
     try:
-        session_data = load_session_data(username)
+        session_data = load_session_data(session_id)
         if not session_data:
-            logger.error(f"No session data found for user: {username}")
+            logger.error(f"No session data found for session ID: {session_id}")
             return redirect(url_for('index'))
 
-
-        logger.info(f"Session data:\n{session_data}")
-
         selected_samples = session_data['selected_samples']
         methods = session_data['methods']
         current_index = session_data['current_index']
 
-        logger.info(f"current_index:\n{current_index}")
-
         if current_index >= len(selected_samples):
-            return redirect(url_for('completed', username=username))
+            return redirect(url_for('completed', session_id=session_id))
 
         sample = selected_samples[current_index]
-        logger.info(f"sample:\n{sample}")
-
         method_a, method_b = methods
 
-        # Find matching files for both methods
-
-        method_a_dir = get_method_dir(method_a)
-        method_b_dir = get_method_dir(method_b)
+        file_a = os.path.join(VISUALIZATION_DIRS[method_a], sample['category'], sample['file'])
+        file_b = os.path.join(VISUALIZATION_DIRS[method_b], sample['category'], sample['file'])
 
-        # for category in ['TP', 'TN', 'FP', 'FN']:
-        category = sample['category']
-        dir_a = f'htmls_{method_a_dir.upper()}/{category}'
-        dir_b = f'htmls_{method_b_dir.upper()}/{category}'
-
-        file_a = os.path.join(dir_a, sample['file'])
-        file_b = os.path.join(dir_b, sample['file'])
-        logger.info(f"file_a:\n{file_a}")
-        logger.info(f"file_b:\n{file_a}")
-
-            # files_a = os.listdir(dir_a)
-            # files_b = os.listdir(dir_b)
-            #
-            # matching_files = set(files_a) & set(files_b)
-            # if matching_files:
-            #     file_a = os.path.join(dir_a, next(iter(matching_files)))
-            #     file_b = os.path.join(dir_b, next(iter(matching_files)))
-            #     break
-
-        if not file_a or not file_b:
+        if not os.path.exists(file_a) or not os.path.exists(file_b):
             logger.error(f"Missing files for comparison at index {current_index}")
             session_data['current_index'] += 1
-            save_session_data(username, session_data)
-            return redirect(url_for('experiment', username=username))
+            save_session_data(session_id, session_data)
+            return redirect(url_for('experiment', session_id=session_id))
 
         visualization_a = url_for('send_visualization', filename=file_a)
         visualization_b = url_for('send_visualization', filename=file_b)
 
         statement = """
-Please note that in select row function, starting index is 0 for Chain-of-Table 1 for Dater and Index * represents the selection of the whole Table.
-You are now given two explanations that describe the reasoning process of the Table QA model. 
-Please analyze the explanations and determine which one provides a clearer and more accurate reasoning process.
+        Please note that in select row function, starting index is 0 for Chain-of-Table 1 for Dater and Index * represents the selection of the whole Table.
+        You are now given two explanations that describe the reasoning process of the Table QA model. 
+        Please analyze the explanations and determine which one provides a clearer and more accurate reasoning process.
         """
 
         return render_template('experiment.html',
@@ -293,76 +199,51 @@ Please analyze the explanations and determine which one provides a clearer and m
                                visualization_b=visualization_b,
                                method_a=method_a,
                                method_b=method_b,
-                               username=username)
+                               session_id=session_id)
     except Exception as e:
         logger.exception(f"An error occurred in the experiment route: {e}")
         return "An error occurred", 500
 
-def get_method_dir(method):
-    if method == 'No-XAI':
-        return 'NO_XAI'
-    elif method == 'Dater':
-        return 'DATER'
-    elif method == 'Chain-of-Table':
-        return 'COT'
-    elif method == 'Plan-of-SQLs':
-        return 'POS'
-
-def get_visualization_dir(method):
-    if method == "No-XAI":
-        return 'htmls_NO_XAI'
-    elif method == "Dater":
-        return 'htmls_DATER'
-    elif method == "Chain-of-Table":
-        return 'htmls_COT'
-    else:  # Plan-of-SQLs
-        return 'htmls_POS'
-
 
 @app.route('/feedback', methods=['POST'])
 def feedback():
     try:
-        username = request.form['username']
+        session_id = request.form['session_id']
         feedback = request.form['feedback']
 
-        session_data = load_session_data(username)
+        session_data = load_session_data(session_id)
         if not session_data:
-            logger.error(f"No session data found for user: {username}")
+            logger.error(f"No session data found for session ID: {session_id}")
             return redirect(url_for('index'))
 
-        # Store the feedback
         session_data['responses'].append({
             'sample_id': session_data['current_index'],
             'preferred_method': feedback,
             'timestamp': datetime.now().isoformat()
         })
 
-        # Move to the next sample
         session_data['current_index'] += 1
-
-        # Save updated session data
-        save_session_data(username, session_data)
-        logger.info(f"Feedback saved for user {username}, sample {session_data['current_index'] - 1}")
+        save_session_data(session_id, session_data)
+        logger.info(f"Feedback saved for session {session_id}, sample {session_data['current_index'] - 1}")
 
         if session_data['current_index'] >= len(session_data['selected_samples']):
-            return redirect(url_for('completed', username=username))
+            return redirect(url_for('completed', session_id=session_id))
 
-        return redirect(url_for('experiment', username=username))
+        return redirect(url_for('experiment', session_id=session_id))
     except Exception as e:
         logger.exception(f"Error in feedback route: {e}")
         return "An error occurred", 500
 
 
-@app.route('/completed/<username>')
-def completed(username):
+@app.route('/completed/<session_id>')
+def completed(session_id):
     try:
-        session_data = load_session_data(username)
+        session_data = load_session_data(session_id)
         if not session_data:
-            logger.error(f"No session data found for user: {username}")
+            logger.error(f"No session data found for session ID: {session_id}")
             return redirect(url_for('index'))
 
         session_data['end_time'] = datetime.now().isoformat()
-
         methods = session_data['methods']
         responses = session_data['responses']
 
@@ -377,9 +258,7 @@ def completed(username):
             preferences[method] = round((preferences[method] / total_responses) * 100, 2)
 
         session_data['preferences'] = preferences
-
-        # Save the final updated session data
-        save_session_data(username, session_data)
+        save_session_data(session_id, session_data)
 
         return render_template('completed.html', preferences=preferences)
     except Exception as e:
@@ -390,7 +269,6 @@ def completed(username):
 @app.route('/visualizations/<path:filename>')
 def send_visualization(filename):
     logger.info(f"Attempting to serve file: {filename}")
-    # Ensure the path is safe and doesn't allow access to files outside the intended directory
     base_dir = os.getcwd()
     file_path = os.path.normpath(os.path.join(base_dir, filename))
     if not file_path.startswith(base_dir):
@@ -406,5 +284,5 @@ def send_visualization(filename):
 
 
 if __name__ == "__main__":
-    os.makedirs('session_data', exist_ok=True)  # Ensure the directory for session files exists
+    os.makedirs('session_data', exist_ok=True)
     app.run(host="0.0.0.0", port=7860, debug=True)

templates/experiment.html

@@ -95,6 +95,34 @@
             height: 100%;
             border: none;
         }
+        .loader {
+            border: 5px solid #f3f3f3;
+            border-top: 5px solid #3498db;
+            border-radius: 50%;
+            width: 50px;
+            height: 50px;
+            animation: spin 1s linear infinite;
+            position: fixed;
+            top: 50%;
+            left: 50%;
+            transform: translate(-50%, -50%);
+            display: none;
+            z-index: 1000;
+        }
+        @keyframes spin {
+            0% { transform: translate(-50%, -50%) rotate(0deg); }
+            100% { transform: translate(-50%, -50%) rotate(360deg); }
+        }
+        .overlay {
+            position: fixed;
+            top: 0;
+            left: 0;
+            width: 100%;
+            height: 100%;
+            background-color: rgba(0, 0, 0, 0.5);
+            display: none;
+            z-index: 999;
+        }
     </style>
     <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" rel="stylesheet">
 </head>
@@ -116,15 +144,25 @@
             <p class="question-text">Which explanation provides a clearer and more accurate reasoning process?</p>
         </div>
         <div class="buttons">
-            <form action="{{ url_for('feedback') }}" method="post" style="width: 48%;">
-                <input type="hidden" name="username" value="{{ username }}">
+            <form action="{{ url_for('feedback') }}" method="post" style="width: 48%;" onsubmit="showLoader()">
+                <input type="hidden" name="session_id" value="{{ session_id }}">
                 <button type="submit" name="feedback" value="{{ method_a }}">{{ method_a }}</button>
             </form>
-            <form action="{{ url_for('feedback') }}" method="post" style="width: 48%;">
-                <input type="hidden" name="username" value="{{ username }}">
+            <form action="{{ url_for('feedback') }}" method="post" style="width: 48%;" onsubmit="showLoader()">
+                <input type="hidden" name="session_id" value="{{ session_id }}">
                 <button type="submit" name="feedback" value="{{ method_b }}">{{ method_b }}</button>
             </form>
         </div>
     </div>
+
+    <div class="overlay" id="overlay"></div>
+    <div class="loader" id="loader"></div>
+
+    <script>
+        function showLoader() {
+            document.getElementById('overlay').style.display = 'block';
+            document.getElementById('loader').style.display = 'block';
+        }
+    </script>
 </body>
 </html>

templates/index.html

@@ -26,6 +26,14 @@
             font-size: 48px;
             margin-bottom: 30px;
         }
+        .instruction {
+            font-size: 20px;
+            color: #333;
+            margin-bottom: 30px;
+            padding: 15px;
+            background-color: #f0f0f0;
+            border-radius: 5px;
+        }
         label {
             display: block;
             margin: 20px 0 10px;
@@ -106,6 +114,7 @@
     </style>
     <script>
         let selectedMethods = [];
+
         function selectMethod(method) {
             const index = selectedMethods.indexOf(method);
             if (index > -1) {
@@ -115,7 +124,9 @@
             } else {
                 return;
             }
+
             document.getElementById('method').value = selectedMethods.join(',');
+
             const buttons = document.getElementsByClassName('method-button');
             for (let button of buttons) {
                 if (selectedMethods.includes(button.getAttribute('data-method'))) {
@@ -125,6 +136,7 @@
                 }
             }
         }
+
         function validateForm() {
             const username = document.getElementById('username').value;
             const seed = document.getElementById('seed').value;
@@ -140,6 +152,9 @@
 <body>
     <div class="container">
         <h1>Trustworthy LLMs for Table QA</h1>
+        <div class="instruction">
+            Let's get started! Please input your name, enter a random number as your seed, and select two methods for your experiment.
+        </div>
         <form id="method-form" action="/" method="post" onsubmit="return validateForm();">
             <label for="username">Hi there 👋👋👋 ! What is your name?</label>
             <input type="text" id="username" name="username" required>