add time logging feature

app.py

@@ -1,5 +1,5 @@
 import gradio as gr
-from gradio.flagging import FlaggingCallback
+from gradio.flagging import FlaggingCallback, SimpleCSVLogger
 from gradio.components import IOComponent
 from gradio_client import utils as client_utils
 from transformers import CLIPProcessor, CLIPModel, CLIPTokenizer
@@ -10,6 +10,7 @@ import os
 import logging
 import csv
 import datetime
+import time
 from pathlib import Path
 from typing import List, Any
 
@@ -55,7 +56,7 @@ class SaveRelevanceCallback(FlaggingCallback):
         """
         logging.info("[SaveRelevance]: Flagging data...")
         flagging_dir = self.flagging_dir
-        log_filepath = Path(flagging_dir) / "log.csv"
+        log_filepath = Path(flagging_dir) / "relevance_log.csv"
         is_new = not Path(log_filepath).exists()
         headers = ["query", "selected image", "relevance", "username", "timestamp"]
 
@@ -122,6 +123,7 @@ def search_text(query, top_k=1):
         [list]: list of images with captions that are related to the query.
         [list]: list of images that are related to the query.
         [list]: list of captions with the images that are related to the query.
+        [time]: start time of marking relevance of the images.
     """
     logging.info(f"[SearchText]: Searching for {query} with top_k={top_k}...")
     
@@ -145,25 +147,29 @@ def search_text(query, top_k=1):
         image_caption.append((object, caption))
         images.append(object)
         captions.append(caption)
-        # selected_image_embs.append(img_emb[hit['corpus_id']])
-        #print(f'array length is: {len(image)}')
-    logging.info(f"[SearchText]: Found {len(image_caption)} images.")
-    return image_caption, images, captions
 
-# def select_image(evt: gr.SelectData):
-#     """ Returns the index of the selected image
+    curr_time = time.time()
+    logging.info(f"[SearchText]: Found {len(image_caption)} images at "
+                 f"{time.ctime(curr_time)}.")
+    return image_caption, images, captions, curr_time
 
-#     Argrs:
-#         evt (SelectData): the event we are listening to
+def display(images, texts, event_data: gr.SelectData):
+    """ Display the selected image and its caption.
     
-#     Returns:
-#         int: index of the selected image
-#     """
-#     logging.info(f"[SelectImage]: Selected image {evt.index}.")
-#     return evt.index
+    Args:
+        images ([list]): list of images
+        texts ([list]): list of captions
+        event_data (gr.SelectData): data from the select event
+
+    Returns:
+        [object]: image
+        [string]: caption
+    """
+    return images[event_data.index], texts[event_data.index]
 
 
 callback = SaveRelevanceCallback()
+time_record = SimpleCSVLogger()
 with gr.Blocks() as demo:
     # create display
     gr.Markdown(
@@ -177,12 +183,15 @@ with gr.Blocks() as demo:
         - To use it, simply write which image you are looking for. See the examples section below for more details.
         - After you submit your query, you will see a gallery of images that are related to your query.
         - You can select the relevance of each image by using the dropdown menu.
+        - Click save buttom to save the image and its relevance to [a csv file](./image_relevance/relevance_log.csv).
+        - After you are done with all the images, click the `I'm Done!` buttom. We will save the time you spent to mark all images.
 
         ---
 
         To-do:
-        - [ ]  Add a way to save multiple image-relevance pairs at once.
-        - [ ]  Improve image identification in the csv file.
+        - Add a way to save multiple image-relevance pairs at once.
+        - Improve image identification in the csv file.  ✅
+        - Record time spent to mark all images.     ✅
         """
     )
     with gr.Row():
@@ -207,8 +216,10 @@ with gr.Blocks() as demo:
                  ], multiselect=False,
                 label="How relevent is this image?"
             )
-            save_btn = gr.Button(
-                "Save after you select the relevance of each image")
+            with gr.Column():
+                save_btn = gr.Button(
+                    "Save after you select the relevance of each image")
+                save_all_btn = gr.Button("I'm finished!")
             
             i = gr.Image(interactive=False, label="Selected Image", visible=False)
     
@@ -218,21 +229,28 @@ with gr.Blocks() as demo:
     # states for passing images and texts to other blocks
     images = gr.State()
     texts = gr.State()
+    start_time = gr.Number(visible=False)
+    time_spent = gr.Number(visible=False)
     # when user input query and top_k
-    submit_btn.click(search_text, [query, top_k], [gallery, images, texts])
+    submit_btn.click(search_text, [query, top_k], [gallery, images, texts, start_time])
 
-    # Selected event
-    def display(images, texts, event_data: gr.SelectData):
-        return images[event_data.index], texts[event_data.index]
-
-    selected = gr.State()
+    # selected = gr.State()
     gallery.select(display, [images, texts], [i, t])
 
     # when user click save button
     # we will flag the current query, selected image, relevance, and username
-    callback.setup([query, i, relevance, username], "flagged")
+    callback.setup([query, i, relevance, username], "image_relevance")
+    time_record.setup([query, username, start_time, time_spent], "time")
     save_btn.click(lambda *args: callback.flag(args),
                    [query, i, relevance, username], preprocess=False)
+    
+    def log_time(query, username, start_time):
+        logging.info(f"[SaveAll]: Saving time for {query} by {username} from {time.ctime(start_time)}.")
+        time_record.flag([query, username,
+                          str(datetime.datetime.fromtimestamp(time.time())),
+                          round(time.time() - start_time, 3)])
+    
+    save_all_btn.click(log_time, [query, username, start_time], preprocess=False)
 
     gr.Markdown(
         """

flagged/log.csv

@@ -1,6 +0,0 @@
-query,selected image,relevance,username,timestamp
-A cute kangaroo,tmpzsbu_wpf.png,3: Highly relevant,ghost,2023-04-11 09:34:45.422185
-A cute kangaroo,tmpor4tmvfk.png,1: Related but not relevant,ghost,2023-04-11 09:34:51.574117
-A cute kangaroo,tmpt52dvzm3.png,1: Related but not relevant,ghost,2023-04-11 09:34:55.734014
-A cute kangaroo,tmpbs578cha.png,2: Somehow relevant,ghost,2023-04-11 09:35:02.914171
-A cute kangaroo,tmpsyidqwtr.png,2: Somehow relevant,ghost,2023-04-11 09:35:05.194639

image_relevance/relevance_log.csv

@@ -0,0 +1,24 @@
+query,selected image,relevance,username,timestamp
+Dog in the beach,tmpje79qsl1.png,3: Highly relevant,ghost,2023-04-13 21:32:37.271831
+Dog in the beach,tmp1csn8eba.png,3: Highly relevant,ghost,2023-04-13 21:32:41.795481
+Dog in the beach,,3: Highly relevant,ghost,2023-04-13 21:34:03.706180
+Dog in the beach,tmp9tyfvman.png,3: Highly relevant,ghost,2023-04-13 21:34:10.290067
+Dog in the beach,tmpb1wtsdv6.png,3: Highly relevant,ghost,2023-04-13 21:34:11.977960
+Dog in the beach,tmp34eovxb2.png,3: Highly relevant,ghost,2023-04-13 21:40:36.600789
+Dog in the beach,tmpur68by9h.png,3: Highly relevant,ghost,2023-04-13 21:40:42.447356
+Dog in the beach,tmp8x2qj6kj.png,3: Highly relevant,ghost,2023-04-13 21:42:18.007103
+Dog in the beach,tmpl2y1u925.png,3: Highly relevant,ghost,2023-04-13 21:42:20.047097
+Dog in the beach,tmpysc13_0s.png,3: Highly relevant,ghost,2023-04-13 21:49:40.801899
+Dog in the beach,tmpocg26u3b.png,3: Highly relevant,ghost,2023-04-13 21:49:48.951778
+Dog in the beach,tmpahlshicv.png,3: Highly relevant,ghost,2023-04-13 21:49:50.739336
+Dog in the beach,tmpe6z9gfa8.png,3: Highly relevant,ghost,2023-04-13 21:51:47.713334
+Dog in the beach,tmpjjbcya65.png,3: Highly relevant,ghost,2023-04-13 21:51:49.356331
+A cute kangaroo,tmps1en1_rb.png,3: Highly relevant,ghost,2023-04-13 21:57:34.666483
+A cute kangaroo,tmp4sr36s7y.png,1: Related but not relevant,ghost,2023-04-13 21:57:38.472087
+A cute kangaroo,tmpia246dpe.png,1: Related but not relevant,ghost,2023-04-13 21:57:40.077043
+A cute kangaroo,tmpq0r079qb.png,1: Related but not relevant,ghost,2023-04-13 21:57:42.090842
+A cute kangaroo,tmpzbq06fsk.png,2: Somehow relevant,ghost,2023-04-13 21:57:44.586175
+Dog in the beach,tmpaz8war0u.png,3: Highly relevant,ghost,2023-04-13 22:02:05.191249
+Dog in the beach,tmpjzce8bre.png,3: Highly relevant,ghost,2023-04-13 22:02:07.483166
+Dois cachorros,tmpym9gznv3.png,3: Highly relevant,ghost,2023-04-13 22:02:18.203364
+Dois cachorros,tmpfyjhtayn.png,2: Somehow relevant,ghost,2023-04-13 22:02:21.240419

time/log.csv

@@ -0,0 +1,2 @@
+Dog in the beach,ghost,2023-04-13 22:02:08.108766,6.154
+Dois cachorros,ghost,2023-04-13 22:02:22.012144,9.622