Upload 18 files

.gitattributes

@@ -57,3 +57,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 # Video files - compressed
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
+corpus/wiki_webq_corpus.tsv filter=lfs diff=lfs merge=lfs -text
+data/webq-dev.json filter=lfs diff=lfs merge=lfs -text
+data/webq-train.json filter=lfs diff=lfs merge=lfs -text

Retriever/bash_gen.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+export CUDA_VISIBLE_DEVICES=0
+
+TSV_FILE="../corpus/wiki_webq_corpus.tsv" # wiki语料库
+OUTPUT_FILE="../corpus/ctx_embeddings.pkl" # 语料库embedding
+BATCH_SIZE=128
+MODEL_NAME="facebook/dpr-ctx_encoder-multiset-base" # 模型
+DEVICE="cuda"
+
+python gen_embedding.py \
+    --tsv_file $TSV_FILE \
+    --output_file $OUTPUT_FILE \
+    --batch_size $BATCH_SIZE \
+    --model_name $MODEL_NAME \
+    --insert_title \
+    --device $DEVICE

Retriever/bash_retr.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+export CUDA_VISIBLE_DEVICES=0
+
+
+QUESTION_FILE="../data/webq-test.txt" # 问题测试集
+EMBEDDING_FILE="../corpus/ctx_embeddings.pkl" # 语料库的embedding
+INDEX_PATH="../index/webq_index" # 语料库的faiss索引
+OUTPUT_FILE="../output/result.pkl" # 检索结果输出
+BATCH_SIZE=32
+MODEL_NAME="facebook/dpr-question_encoder-multiset-base" # 将问题编码为embedding的模型
+DEVICE="cuda"
+
+python retriever.py \
+    --questions_file $QUESTION_FILE \
+    --context_embeddings_file $EMBEDDING_FILE \
+    --model_name $MODEL_NAME \
+    --index_path $INDEX_PATH\
+    --output_file $OUTPUT_FILE \
+    --batch_size $BATCH_SIZE \
+    --top_docs 100 \
+    --device $DEVICE

Retriever/gen_embedding.py

@@ -0,0 +1,142 @@
+import os
+import pickle
+import torch
+from torch.utils.data import DataLoader, Dataset
+from transformers import DPRContextEncoder, DPRContextEncoderTokenizer
+from typing import List, Tuple, Dict
+import pandas as pd
+import argparse
+from tqdm import tqdm  # 导入 tqdm 用于显示进度条
+
+class ContextDataset(Dataset):
+    """
+    自定义数据集类，用于批量加载上下文文本。
+    """
+    def __init__(self, contexts: List[Tuple[str, str, str]]):
+        """
+        Args:
+            contexts (List[Tuple[str, str, str]]): 每个条目为 (id, title, text)。
+        """
+        self.contexts = contexts
+
+    def __len__(self):
+        return len(self.contexts)
+
+    def __getitem__(self, idx):
+        # 返回 (id, title, text)
+        return self.contexts[idx]
+
+class DPRContextEncoderBatchProcessor:
+    def __init__(self, model_name: str = "facebook/dpr-ctx_encoder-multiset-base", batch_size: int = 16, device: str = None):
+        self.device = device if device else ("cuda" if torch.cuda.is_available() else "cpu")
+        self.tokenizer = DPRContextEncoderTokenizer.from_pretrained(model_name)
+        self.model = DPRContextEncoder.from_pretrained(model_name).to(self.device)
+        self.batch_size = batch_size
+
+    def process_contexts(self, contexts: List[Tuple[str, str, str]], insert_title: bool = True) -> List[Tuple[str, List[float]]]:
+        """
+        批量处理上下文文本并生成嵌入向量。
+        
+        Args:
+            contexts (List[Tuple[str, str, str]]): 每个条目为 (id, title, text)。
+            insert_title (bool): 是否在文本前插入标题。
+
+        Returns:
+            List[Tuple[str, List[float]]]: 每个上下文文本的 ID 和嵌入向量列表。
+        """
+        dataset = ContextDataset(contexts)
+        dataloader = DataLoader(dataset, batch_size=self.batch_size, shuffle=False)
+        
+        embeddings = []
+        for batch_contexts in tqdm(dataloader, desc="Processing contexts", unit="batch"):
+            ids, titles, texts = batch_contexts
+            print(f"ids:{ids}")
+            # 如果 insert_title 为 True，则将 title 和 text 组合在一起，否则只使用 text
+            if insert_title:
+                combined_texts = [f"{title} [SEP] {text}" for title, text in zip(titles, texts)]
+            else:
+                combined_texts = [text for text in texts]
+
+            inputs = self.tokenizer(
+                combined_texts,
+                return_tensors="pt",
+                padding=True,
+                truncation=True,
+                max_length=512
+            ).to(self.device)
+
+            with torch.no_grad():
+                outputs = self.model(**inputs).pooler_output  
+            batch_embeddings = outputs.cpu().numpy()  
+            
+            for idx, embedding in enumerate(batch_embeddings):
+                embeddings.append((ids[idx].item(), embedding))
+
+        return embeddings
+
+    def save_embeddings(self, contexts: List[Tuple[str, str, str]], output_file: str, insert_title: bool = True):
+        """
+        生成嵌入并保存到指定文件。
+
+        Args:
+            contexts (List[Tuple[str, str, str]]): 每个条目为 (id, title, text)。
+            output_file (str): 输出文件路径。
+            insert_title (bool): 是否在文本前插入标题。
+        """
+        print("Generating embeddings...")
+        embeddings = self.process_contexts(contexts, insert_title=insert_title)
+        
+        result = {embedding[0]: embedding[1] for embedding in embeddings}
+        os.makedirs(os.path.dirname(output_file), exist_ok=True)  # 确保输出目录存在
+        
+        print("Saving embeddings to file...")
+        with tqdm(total=len(embeddings), desc="Saving embeddings", unit="embedding") as pbar:
+            with open(output_file, "wb") as f:
+                pickle.dump(result, f)
+                pbar.update(len(embeddings))
+        
+        print(f"Total passages processed: {len(embeddings)}. Embeddings saved to {output_file}")
+
+    def load_and_process_tsv(self, tsv_file: str, output_file: str, insert_title: bool = True):
+        """
+        从 TSV 文件中加载数据并生成嵌入。
+
+        Args:
+            tsv_file (str): TSV 文件路径。
+            output_file (str): 输出文件路径。
+            insert_title (bool): 是否在文本前插入标题。
+        """
+        print(f"Loading data from {tsv_file}...")
+        df = pd.read_csv(tsv_file, sep='\t')
+        # 提取 id, title 和 text 列
+        ids = df['id'].tolist()
+        titles = df['title'].fillna("").tolist()
+        texts = df['text'].fillna("").tolist()
+        
+        contexts = list(zip(ids, titles, texts))
+        
+        self.save_embeddings(contexts, output_file, insert_title=insert_title)
+
+
+def main():
+    parser = argparse.ArgumentParser(description="DPR Context Encoder Batch Processor")
+    parser.add_argument("--tsv_file", type=str, required=True, help="Path to the input TSV file with 'id', 'title', and 'text' columns.")
+    parser.add_argument("--output_file", type=str, required=True, help="Path to save the generated embeddings.")
+    parser.add_argument("--batch_size", type=int, default=8, help="Batch size for processing contexts.")
+    parser.add_argument("--model_name", type=str, default="facebook/dpr-ctx_encoder-multiset-base", help="Name of the DPR context encoder model.")
+    parser.add_argument("--insert_title", action="store_true", help="Whether to insert the title before the text for embedding generation.")
+    parser.add_argument("--device", type=str, default=None, help="Device to run the model on (e.g., 'cuda' or 'cpu').")
+
+    args = parser.parse_args()
+
+    processor = DPRContextEncoderBatchProcessor(
+        model_name=args.model_name,
+        batch_size=args.batch_size,
+        device=args.device
+    )
+
+    processor.load_and_process_tsv(args.tsv_file, args.output_file, insert_title=args.insert_title)
+
+
+if __name__ == "__main__":
+    main()

Retriever/retriever.py

@@ -0,0 +1,155 @@
+import os
+import logging
+import pickle
+import time
+from typing import List, Tuple, Dict
+
+import numpy as np
+import torch
+from torch import nn, Tensor as T
+from transformers import DPRQuestionEncoder, DPRQuestionEncoderTokenizer
+from dpr.indexer.faiss_indexers import DenseFlatIndexer
+from tqdm import tqdm  # 导入 tqdm 用于显示进度条
+
+logger = logging.getLogger()
+logging.basicConfig(level=logging.INFO)
+
+
+def load_context_embeddings(embedding_file: str) -> Dict[str, np.ndarray]:
+    """
+    从给定文件中加载上下文嵌入
+    :param embedding_file: 上下文嵌入文件路径 (.pkl 格式)
+    :return: 上下文ID到嵌入向量的字典
+    """
+    with open(embedding_file, "rb") as f:
+        embeddings = pickle.load(f)
+    return embeddings
+
+
+def generate_question_vectors(questions: List[str], model_name: str, batch_size: int, device: str) -> T:
+    """
+    使用 Hugging Face 模型生成问题嵌入向量
+    :param questions: 要生成嵌入的问题列表
+    :param model_name: Hugging Face 模型名称
+    :param batch_size: 批量大小
+    :param device: 设备（'cpu' 或 'cuda'）
+    :return: 问题嵌入向量张量
+    """
+    tokenizer = DPRQuestionEncoderTokenizer.from_pretrained(model_name)
+    model = DPRQuestionEncoder.from_pretrained(model_name).to(device)
+
+    n = len(questions)
+    query_vectors = []
+
+    with torch.no_grad():
+        for batch_start in tqdm(range(0, n, batch_size), desc="Generating question embeddings", unit="batch"):
+            batch_questions = questions[batch_start:batch_start + batch_size]
+            inputs = tokenizer(batch_questions, return_tensors="pt", padding=True, truncation=True).to(device)
+            outputs = model(**inputs)
+            query_vectors.extend(outputs.pooler_output.cpu().split(1, dim=0))
+
+            if len(query_vectors) % 100 == 0:
+                logger.info("Encoded queries %d", len(query_vectors))
+
+    query_tensor = torch.cat(query_vectors, dim=0)
+    logger.info("Total encoded queries tensor size: %s", query_tensor.size())
+    assert query_tensor.size(0) == len(questions)
+    return query_tensor
+
+
+class LocalFaissRetriever:
+    def __init__(self, question_encoder_name: str, batch_size: int, device: str, index: DenseFlatIndexer):
+        self.question_encoder_name = question_encoder_name
+        self.batch_size = batch_size
+        self.device = device
+        self.index = index
+
+    def generate_question_vectors(self, questions: List[str]) -> T:
+        return generate_question_vectors(questions, self.question_encoder_name, self.batch_size, self.device)
+
+    def index_encoded_data(self, embeddings: Dict[str, np.ndarray], buffer_size: int):
+        """
+        从给定的上下文嵌入字典中索引已编码的上下文嵌入
+        :param embeddings: 上下文ID到嵌入向量的字典
+        :param buffer_size: 每次索引的缓冲区大小
+        """
+        buffer = []
+        for doc_id, vector in embeddings.items():
+            print(f"doc_id:{doc_id}")
+            buffer.append((doc_id, vector))
+            if len(buffer) >= buffer_size:
+                self.index.index_data(buffer)
+                buffer = []
+        if buffer:
+            self.index.index_data(buffer)
+        logger.info("Data indexing completed.")
+
+    def get_top_docs(self, query_vectors: np.array, top_docs: int = 100) -> List[Tuple[List[object], List[float]]]:
+        """
+        使用 Faiss 索引检索最佳匹配的上下文
+        :param query_vectors: 查询嵌入向量
+        :param top_docs: 要返回的文档数量
+        :return: 检索到的上下文 ID 和得分的列表
+        """
+        start_time = time.time()
+        results = []
+        for start_idx in tqdm(range(0, query_vectors.shape[0], 512), desc="Retrieving top docs", unit="batch"):
+            batch_query_vectors = query_vectors[start_idx: start_idx + 512]
+            batch_results = self.index.search_knn(batch_query_vectors, top_docs)
+            print(f"batch_results:{batch_results[0]}")
+            results.extend(batch_results)
+        logger.info("Index search time: %f sec.", time.time() - start_time)
+        return results
+
+
+def main():
+    import argparse
+    parser = argparse.ArgumentParser(description="Dense Retriever for Question Answering")
+    parser.add_argument("--questions_file", type=str, required=True, help="Path to the input questions file (one question per line)")
+    parser.add_argument("--context_embeddings_file", type=str, required=True, help="Path to the context embeddings file (.pkl)")
+    parser.add_argument("--batch_size", type=int, default=8, help="Batch size for question encoding")
+    parser.add_argument("--model_name", type=str, default="facebook/dpr-question_encoder-multiset-base", help="Name of the question encoder model")
+    parser.add_argument("--index_path", type=str, required=True, help="Path to store or load the Faiss index")
+    parser.add_argument("--top_docs", type=int, default=10, help="Number of top documents to retrieve")
+    parser.add_argument("--device", type=str, default="cuda", help="Device to run the model on (e.g., 'cuda' or 'cpu')")
+    parser.add_argument("--output_file", type=str, required=True, help="Path to save the retrieval results (.pkl)")
+    args = parser.parse_args()
+
+    with open(args.questions_file, "r") as f:
+        questions = [line.strip() for line in f.readlines()]
+
+    context_embeddings = load_context_embeddings(args.context_embeddings_file)
+    
+    vector_size = next(iter(context_embeddings.values())).shape[0]
+    index = DenseFlatIndexer(vector_size)
+
+    if os.path.exists(args.index_path):
+        logger.info(f"Loading existing index from {args.index_path}")
+        index.deserialize(args.index_path)
+        retriever = LocalFaissRetriever(args.model_name, args.batch_size, args.device, index)
+    else:
+        os.makedirs(args.index_path, exist_ok=True)
+        logger.info(f"Creating new index and saving to {args.index_path}")
+        index.init_index(vector_size)
+        retriever = LocalFaissRetriever(args.model_name, args.batch_size, args.device, index)
+        retriever.index_encoded_data(context_embeddings, buffer_size=1000)
+        index.serialize(args.index_path)
+
+    question_vectors = retriever.generate_question_vectors(questions)
+
+    top_results_and_scores = retriever.get_top_docs(question_vectors.numpy(), args.top_docs)
+
+    queries_results = []
+    for i, _ in tqdm(enumerate(questions), desc="Processing queries", total=len(questions), unit="query"):
+        docs_id = [str(item) for item in top_results_and_scores[i][0]]
+        docs_score = [score for score in top_results_and_scores[i][1]]
+        queries_results.append((docs_id, docs_score))
+    
+    with open(args.output_file, "wb") as f:
+        pickle.dump(queries_results, f)
+
+    print(f"Results saved to {args.output_file}")
+
+
+if __name__ == "__main__":
+    main()

cal_hit_multi.py

@@ -0,0 +1,80 @@
+#%%
+from utils.retriever_utils import load_passages, validate, save_results
+import pickle
+import os
+import csv 
+
+#%%
+def load_data_with_pickle(file_path):
+    with open(file_path, 'rb') as f:
+        return pickle.load(f)
+
+
+def process_and_save_retrieval_results(top_docs, dataset_name, questions, question_answers, all_passages, num_threads, match_type, output_dir, output_no_text=False):
+    recall_outfile = os.path.join(output_dir, 'recall_at_k.csv')
+    result_outfile = os.path.join(output_dir, 'results.json')
+    
+    questions_doc_hits = validate(
+        dataset_name,
+        all_passages,
+        question_answers,
+        top_docs,
+        num_threads,
+        match_type,
+        recall_outfile,
+        use_wandb=False
+    )
+    
+    save_results(
+        all_passages,
+        questions,
+        question_answers,
+        top_docs,
+        questions_doc_hits,
+        result_outfile,
+        output_no_text=output_no_text
+    )
+    
+    return questions_doc_hits
+
+
+#%%
+if __name__=='__main__':
+    
+    dataset_name = 'webq'
+    num_threads = 10
+    output_no_text = False
+    ctx_file = './corpus/wiki_webq_corpus.tsv'
+
+
+    match_type = 'string'
+    input_file_path = './data/webq-test.csv'
+    with open(input_file_path,'r') as file:
+        query_data = csv.reader(file, delimiter='\t')
+        questions, question_answers = zip(*[(item[0], eval(item[1])) for item in query_data])
+        questions = questions
+        question_answers = question_answers
+    
+    all_passages = load_passages(ctx_file)
+
+    output_dir = './output/webq-test-result'
+
+    
+    top_docs_pkl_path = './output/result_str.pkl'
+
+    top_docs = load_data_with_pickle(top_docs_pkl_path)
+    
+    os.makedirs(output_dir, exist_ok=True)
+    questions_doc_hits = process_and_save_retrieval_results(
+        top_docs,
+        dataset_name,
+        questions,
+        question_answers,
+        all_passages,
+        num_threads,
+        match_type,
+        output_dir,
+        output_no_text=output_no_text
+    )
+
+    print('Validation End!')

corpus/wiki_webq_corpus.tsv

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:86aa0e5ce96de15cdcfd6612e72904d689a9a0faadea2a34c2079c504d14969a
+size 486677193

data/webq-dev.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:67cbb68d95f6a3652f0d5d07add0ba09f14f55b0a313ef7e18e14abf12e5a6da
+size 23175353

data/webq-test.csv

@@ -0,0 +1,200 @@
+what influenced john steinbeck to start writing?	['William Faulkner', 'Robert Burns', 'Sherwood Anderson', 'Thomas Malory']
+what school did sir ernest rutherford go to?	['Trinity College, Cambridge', 'Nelson College', 'University of Canterbury', 'University of Cambridge', 'University of New Zealand']
+what instruments does justin bieber use?	['guitar', 'Piano', 'trumpet', 'Drums']
+when did president theodore roosevelt take office?	['9/14/1901']
+what was dr seuss real name?	['Theodor Robert Geisel']
+what movies is omar epps in?	"['Daybreak', 'Major League II', 'Scream 2', 'First Time Felon', 'Breakfast of Champions', 'Juice', 'The Program', 'Deadly Voyage', 'Higher Learning', ""Don't Be a Menace to South Central While Drinking Your Juice in the Hood""]"
+what is the state name of new york city?	['New York']
+where did eleanor roosevelt die?	['New York City']
+where was farrah fawcett buried?	['Westwood Village Memorial Park Cemetery']
+where did benjamin franklin work?	['James Franklin Printing Shop', 'United States Postal Service', 'Josiah Franklin']
+who did paul revere marry?	['Sarah Revere']
+what was robert burns?	['Poet', 'Writer', 'Bard', 'Author']
+what type of government does russia have 2010?	['Semi-presidential system', 'Constitutional republic', 'Republic', 'Federation']
+what other movies is josh hutcherson in?	['The Hunger Games', 'Bridge to Terabithia', 'The Kids Are All Right']
+who did johnny depp play in corpse bride?	['Victor Van Dort']
+who is the governor of virginia 2011?	['Bob McDonnell']
+who are the senators of new jersey now?	['Bob Menendez']
+what to visit in london city?	"[""Regent's Park"", 'Tower of London', 'Buckingham Palace', 'Palace of Westminster', 'London Eye', 'Tower Bridge', 'Hyde Park', 'Westminster Abbey', ""St Paul's Cathedral"", 'Trafalgar Square']"
+where does robin williams live 2011?	['San Francisco']
+who is washington redskins backup qb?	['Rex Grossman']
+who plays stacey in the stacy's mom video?	['Lacey Turner']
+what is the current time in kauai hawaii?	['Hawaii–Aleutian Time Zone', 'UTC−10:00']
+what club does cristiano ronaldo play for in 2010?	['Real Madrid C.F.']
+when does jewish new year start?	['Yiddish Language']
+when was president john adams elected?	['John Adams Presidential Campaign, 1796', 'John Adams Presidential Campaign, 1800']
+who was king henry viii son?	['Prince Henry, Duke of Cornwall', 'Edward VI of England', 'Mary I of England', 'Edward Tudor', 'Henry, Duke of Cornwall', 'Elizabeth I of England', 'Henry FitzRoy, 1st Duke of Richmond and Somerset', 'Henry Tudor']
+where was toussaint l'ouverture born?	['Haiti']
+what type of cancer did gilda radner die of?	['Ovarian cancer']
+where did harry s truman go to school?	['University of Missouri–Kansas City School of Law', 'University of Missouri–Kansas City', 'William Chrisman High School']
+who was the father of king george vi?	['George V']
+what language does egyptian people speak?	['Modern Standard Arabic']
+what language do australia people speak?	['Lojban', 'Esperanto Language', 'English Language']
+what type of music did mozart composed?	['Opera', 'Classical music', 'Ballet', 'Art song', 'Chamber music']
+what channel is the usa pageant on?	['us']
+when did michael jordan return to the nba?	['2001–02 NBA season']
+what time in china hong kong?	['UTC+8']
+what year was first world series?	['1903 World Series']
+when did the philadelphia flyers win the cup?	['1974 Stanley Cup Finals', '1975 Stanley Cup Finals']
+where is jason mraz from?	['Mechanicsville']
+what are the names of michael jackson's 3 children?	['Paris-Michael Katherine Jackson', 'Prince Michael Jackson I', 'Prince Michael Jackson II']
+what county is texarkana arkansas in?	['Miller County']
+what team does messi play for 2011?	['FC Barcelona']
+what airport do you fly into to get to destin fl?	['Northwest Florida Regional Airport', 'Destin–Fort Walton Beach Airport']
+when was the last time the boston bruins went to the stanley cup?	['2011 Stanley Cup Finals']
+what team is kris humphries play for?	['Brooklyn Nets']
+where should a family stay in paris?	['Hôtel Ritz Paris', 'Hôtel de Crillon']
+what are staffordshire terriers?	['Dog']
+what does sarabi?	['Physician']
+what kind of government does the united states have currently?	['Federal republic']
+who will be the red sox next coach?	['Nomar Garciaparra']
+what was the name of jfk's brothers?	['Robert F. Kennedy', 'Ted Kennedy', 'Rosemary Kennedy', 'Kathleen Cavendish', 'Patricia Kennedy Lawford', 'Jean Kennedy Smith', 'Eunice Kennedy Shriver', 'Joseph P. Kennedy, Jr.']
+when did roth ira originate?	['William V. Roth, Jr.']
+what political party does barack obama represent?	['Democratic Party']
+what year did the milwaukee brewers go to the world series?	['1974 Major League Baseball Season']
+where does egypt export to?	['Sudan']
+where is roswell area 51?	['Roswell']
+what to do today in atlanta with kids?	['Atlanta History Center', 'Atlanta Cyclorama & Civil War Museum', 'Atlanta Ballet', 'Fernbank Museum of Natural History', 'Woodruff Arts Center', 'Zoo Atlanta', 'Atlanta Symphony Orchestra', 'Centennial Olympic Park', 'Martin Luther King, Jr., National Historic Site', 'Fernbank Science Center']
+what language did the ancient babylonians speak?	['Akkadian language']
+what did george washington do as a teenager?	['Surveyor']
+what century did slavery end in america?	['Western Hemisphere']
+who owns chrysler corporation 2011?	['Chrysler Group LLC']
+what did miles davis died of?	['Pneumonia', 'Stroke', 'Respiratory failure']
+what type of political system is brazil?	['Constitutional republic', 'Presidential system', 'Federal republic']
+where is the university of the rockies located?	['United States of America', 'Colorado', 'Colorado Springs']
+what county is st paul va in?	['United States of America', 'Wise County', 'Russell County', 'Virginia']
+when did charles goodyear invented rubber?	"[""During the early 1830's he began inventing, filing six patents between 1830 and 1834, and during this period became interested in rubber, which he tried - unsuccessfully - to use in some of his mechanical inventions.""]"
+where is the thames river source?	['Thames Head']
+what countries are part of the uk?	['Scotland', 'England', 'Wales', 'Northern Ireland']
+what do we call the currency of france?	['French franc']
+what are the official languages of argentina?	['Yiddish Language', 'Italian Language', 'Spanish Language']
+where did the gallipoli war take place?	['Gallipoli']
+what type of government does brazil have 2011?	['Brazilian Labour Renewal Party']
+where did william morris go to college?	['Marlborough College', 'Exeter College, Oxford', 'University of Oxford']
+what the time zone in japan?	['Japan Standard Time', 'UTC+09:00']
+what language do people from greece speak?	['Albanian language', 'Greek Language']
+what radio station is npr on in nyc?	['WNYC']
+what degrees did barack obama get?	['Juris Doctor', 'Bachelor of Arts']
+who played elaine the pain?	['Julia Louis-Dreyfus']
+who is amy grant's first husband?	['Vince Gill']
+what books did agatha christie wrote?	['And Then There Were None', 'Le Grand alibi', 'Ten Little Indians', 'Appointment with Death', 'Desyat Negrityat', 'The Man in the Brown Suit', 'Witness for the Prosecution']
+who is moira in x men?	['Olivia Williams', 'Rose Byrne']
+what did drita find out?	['Football Superleague of Kosovo']
+who played barbara gordon batgirl?	['Alicia Silverstone']
+what type of music did john lennon sing?	['Experimental rock', 'Pop rock', 'Pop music', 'Blues-rock', 'Art rock', 'Soft rock', 'Psychedelic rock', 'Rock music', 'Experimental music']
+what position did lebron james play?	['Point forward', 'Small forward']
+where is the university of maryland medical school?	['Maryland', 'United States of America', 'Baltimore']
+what form of government does north korea have?	"['Single-party state', 'Socialist state', ""People's Republic"", 'Juche', 'Unitary state']"
+who was the secretary of state when andrew jackson was president?	['Martin Van Buren']
+which dawkins book to read first?	['The Selfish Gene']
+what money does spain use?	['Euro']
+who played amy squirrel in bad teacher?	['Lucy Punch']
+what was gregor mendel contribution?	['Mendelian inheritance']
+where does the expression excuse my french come from?	['English Literature']
+who is vancouver canucks coach?	['Alain Vigneault']
+where is holy roman empire located?	['Europe', 'North Africa', 'Middle East']
+where do the appalachian mountains run?	['Eastern United States']
+what type of government does the us follow?	['Presidential system', 'Federal republic', 'Representative democracy', 'Two-party system', 'Constitutional republic', 'Republic']
+what states share a border with tennessee?	['Virginia']
+where is harley davidson made?	['United States of America']
+what did shakespeare learn in grammar school?	['william shakespeare performed play by thomas dekker']
+who does the voice for chucky in child's play?	['Brad Dourif']
+where were the seneca indians located?	['New York']
+what would ap xin zhao do?	['Male']
+who was the artist of mickey mouse?	['Ub Iwerks', 'Walt Disney']
+what language is spoken in switzerland?	['Romansh language', 'French Language', 'German Language', 'Italian Language']
+what was dr seuss's real name?	['Theodor Robert Geisel']
+who plays elena gilbert on vampire diaries?	['Nina Dobrev']
+what are all the movies taylor swift has been in?	"['Hannah Montana: The Movie', 'Campfire Stories;Comes Around Gos Around', 'The Lorax', ""Valentine's Day""]"
+who plays charlie in the santa clause movies?	['Kansas City Athletics']
+what produce does florida export?	['Orange juice']
+where did kobe earthquake happen?	['Great Hanshin earthquake']
+what record label is kelly clarkson signed with?	['RCA Records', 'Sony BMG Music Entertainment', 'Sony Music Entertainment']
+who has coached the carolina panthers?	['George Seifert', 'Dom Capers', 'John Fox']
+what country is dyson made?	['United Kingdom']
+where does the columbia river start?	['Columbia Lake']
+who are the u s senators of pennsylvania?	['James Buchanan', 'Albert Gallatin', 'Bob Casey, Jr.', 'George Clymer', 'Arlen Specter', 'Robert Morris', 'William Maclay', 'Michael J. Holston', 'Pat Toomey', 'James Ross']
+where did the russian japanese war happen?	['Yellow Sea', 'Korean Peninsula', 'Manchuria']
+what language is most commonly spoken in belgium?	['French Language', 'German Language', 'Dutch Language']
+where did joe flacco attend college?	['University of Delaware']
+what to do san jose ca?	['San Jose Municipal Rose Garden', 'The Tech Museum of Innovation', 'Winchester Mystery House', 'Japantown', 'Downtown San Jose', 'Rosicrucian Egyptian Museum', 'San Jose Museum of Quilts & Textiles', 'San Jose Museum of Art', 'Alum Rock Park', 'Santana Row']
+where is the empire of ghana?	['West Africa']
+what did dmitri mendeleev discover in 1869?	['Periodic Table']
+where to get a marriage license in long island?	['United States District Court for the Eastern District of New York']
+when does the world end according to the mayans time?	['2012']
+what do the symbols on the nevada flag mean?	['All For Our Country']
+where is perpignan located?	['France']
+where is olympic national park wa?	['Jefferson County', 'Washington']
+when was the most recent earthquake in haiti?	['2010 Haiti Earthquake']
+what books are written by suzanne collins?	['Gregor and the Prophecy of Bane', 'Gregor and the Marks of Secret', 'FIRE PROOF', 'Gregor and the Code of Claw', 'The Underland Chronicles Book Three', 'When Charlie McButton lost power', 'Gregor and the Curse of the Warmbloods', 'Catching Fire', '12', 'Gregor the Overlander']
+who is the president of peru now?	['Ollanta Humala']
+where did the israel palestine conflict start?	['1936–39 Arab revolt in Palestine']
+what are some ancient egypt names?	['Abdel Hakim Amer', 'Abdul Munim Riad', 'Ahmad Ismail Ali', 'Abdul Munim Wassel', 'Saad El Shazly', 'Hosni Mubarak', 'Mohammed Aly Fahmy', 'Anwar Sadat', 'Abd-Al-Minaam Khaleel', 'Abdel Ghani el-Gamasy']
+where is the fukushima daiichi nuclear plant located?	['Japan', 'Okuma']
+who is mary mcleod bethune for kids?	['Educator']
+what character did billy d williams play in star wars?	['Lando Calrissian']
+what city is mt lassen in?	['Shasta County']
+where do john lennon die?	['New York City']
+when does daylight saving end in new zealand 2012?	['nz']
+where did spencer pratt go to school?	['University of Southern California']
+where was the temple of karnak built?	['Egypt', 'Luxor Governorate']
+what did shakespeare become famous for?	['Poet', 'Playwright', 'Dramatist', 'Lyricist', 'Author']
+what language do they speak in malta?	['Maltese Language', 'English Language']
+who did ricky martin started his career with?	['Menudo']
+what language did they speak in ghana?	['Akan Language']
+who was dan white?	['Firefighter', 'Politician', 'Police officer']
+who does peter griffin voice?	['Seth MacFarlane']
+where was benjamin franklin educated?	['Boston Latin School']
+what does gm make?	['Automobile']
+who played lauren reed on alias?	['Melissa George']
+who does donnie wahlberg play in the sixth sense?	['Vincent Grey']
+where does marta play soccer?	['Umeå IK']
+where are the gobi desert located on a map?	['Mongolia']
+where are the texas rangers playing?	['Rangers Ballpark in Arlington']
+what percent of americans have college degree?	"[""Why Race Mattered in Barack Obama's Re-election""]"
+where was country singer george jones born?	['Saratoga']
+where is denmark situated?	['Euroregion Baltic']
+where was osama bin laden killed?	['Abbottabad']
+what did shannon hoon die from?	['Drug overdose']
+what kind of government is sweden?	['Representative democracy', 'Unitary state', 'Parliamentary system', 'Constitutional monarchy', 'Hereditary monarchy', 'Multi-party system']
+who or what influenced albert einstein?	['Hendrik Lorentz', 'Isaac Newton', 'Baruch Spinoza', 'George Bernard Shaw', 'Hermann Minkowski', 'James Clerk Maxwell', 'Paul Valéry', 'Karl Pearson', 'Ernst Mach', 'Bernhard Riemann']
+what is arkansas state capitol?	['Little Rock']
+where does kurdish people live?	['Asia']
+who is the state governor of tennessee?	['Bill Haslam']
+what sri lanka capital?	['Sri Jayawardenapura Kotte']
+what political party did andrew johnson belong to?	['Democratic Party', 'National Union Party', 'Republican Party']
+where did mubarak get his wealth?	['Politician']
+what team did aguero play for?	['Argentina national football team', 'Manchester City F.C.', 'Club Atlético Independiente', 'Atlético Madrid']
+where did george michael go to school?	['Bushey Meads School']
+who plays london tipton in suite life on deck?	['Brenda Song']
+who is sir james dyson?	['Designer', 'Industrial designer', 'Engineer', 'Inventor']
+what city in florida has the lowest crime rate?	['Melquíades Rafael Martinez']
+what team did ronaldo play for in 2003?	['Real Madrid C.F.']
+what year did houston rockets win their first championship?	['1994 NBA Finals']
+what does monsanto own?	['Agricultural Chemicals', 'Seed', 'Agriculture', 'Chemical industry']
+who was jesse james killed by?	['The Assassination of Jesse James by the Coward Robert Ford']
+what is the predominant religion in israel?	['Judaism']
+with which ancient ruler did julius caesar fall in love?	['Cornelia Cinna minor', 'Pompeia', 'Calpurnia Pisonis']
+what kind of money should i take to costa rica?	['Costa Rican colón']
+where did paula deen go to school?	['Albany High School']
+what highschool did r. kelly attend?	['Kenwood Academy']
+who is number 22 for the dallas cowboys?	['Felix Jones']
+when was the last time the orioles won the world series?	['1983 World Series']
+who did woody harrelson play on cheers?	['Woody Boyd']
+what country did buddha come from?	['India']
+what type of religion does argentina have?	['Protestantism', 'Catholicism', 'Judaism']
+what language do they in ghana?	['English Language']
+what the largest city in spain?	['Madrid']
+who is khloe kardashian's husband?	['Lamar Odom']
+what college did john nash teach at?	['Princeton University']
+what stones albums did mick taylor play on?	"[""A Stone's Throw"", 'Too Hot For Snakes', 'Stranger in This Town', 'Little Red Rooster', ""Arthur's Club-Geneve 1995"", 'Keepin It Real', 'Mick Taylor']"
+what political party was hitler in?	"[""German Workers' Party"", 'Nazi Party']"
+what college did se hinton go?	['University of Tulsa']
+what language is spoken in haiti today?	['French Language', 'Haitian Creole French Language']
+who plays king julian madagascar?	['Sacha Baron Cohen']
+what state is saint louis university in?	['Missouri']
+where did george herbert walker bush go to college?	['Yale University', 'Phillips Academy', 'Davenport College']
+where is mount st helens volcano?	['Skamania County']
+what did joan crawford died of?	['Myocardial infarction', 'Pancreatic cancer']
+what awards gary paulsen won?	"['Spur Award for Best Juvenile Fiction', ""Dorothy Canfield Fisher Children's Book Award"", 'Regina Medal', ""Anne V. Zarrow Award for Young Readers' Literature"", 'Spur Award for Best Juvenile Nonfiction', 'Newbery Honor']"
+who is eli whitney and what did he invent?	['Cotton gin']

data/webq-test.txt

@@ -0,0 +1,200 @@
+what influenced john steinbeck to start writing?
+what school did sir ernest rutherford go to?
+what instruments does justin bieber use?
+when did president theodore roosevelt take office?
+what was dr seuss real name?
+what movies is omar epps in?
+what is the state name of new york city?
+where did eleanor roosevelt die?
+where was farrah fawcett buried?
+where did benjamin franklin work?
+who did paul revere marry?
+what was robert burns?
+what type of government does russia have 2010?
+what other movies is josh hutcherson in?
+who did johnny depp play in corpse bride?
+who is the governor of virginia 2011?
+who are the senators of new jersey now?
+what to visit in london city?
+where does robin williams live 2011?
+who is washington redskins backup qb?
+who plays stacey in the stacy's mom video?
+what is the current time in kauai hawaii?
+what club does cristiano ronaldo play for in 2010?
+when does jewish new year start?
+when was president john adams elected?
+who was king henry viii son?
+where was toussaint l'ouverture born?
+what type of cancer did gilda radner die of?
+where did harry s truman go to school?
+who was the father of king george vi?
+what language does egyptian people speak?
+what language do australia people speak?
+what type of music did mozart composed?
+what channel is the usa pageant on?
+when did michael jordan return to the nba?
+what time in china hong kong?
+what year was first world series?
+when did the philadelphia flyers win the cup?
+where is jason mraz from?
+what are the names of michael jackson's 3 children?
+what county is texarkana arkansas in?
+what team does messi play for 2011?
+what airport do you fly into to get to destin fl?
+when was the last time the boston bruins went to the stanley cup?
+what team is kris humphries play for?
+where should a family stay in paris?
+what are staffordshire terriers?
+what does sarabi?
+what kind of government does the united states have currently?
+who will be the red sox next coach?
+what was the name of jfk's brothers?
+when did roth ira originate?
+what political party does barack obama represent?
+what year did the milwaukee brewers go to the world series?
+where does egypt export to?
+where is roswell area 51?
+what to do today in atlanta with kids?
+what language did the ancient babylonians speak?
+what did george washington do as a teenager?
+what century did slavery end in america?
+who owns chrysler corporation 2011?
+what did miles davis died of?
+what type of political system is brazil?
+where is the university of the rockies located?
+what county is st paul va in?
+when did charles goodyear invented rubber?
+where is the thames river source?
+what countries are part of the uk?
+what do we call the currency of france?
+what are the official languages of argentina?
+where did the gallipoli war take place?
+what type of government does brazil have 2011?
+where did william morris go to college?
+what the time zone in japan?
+what language do people from greece speak?
+what radio station is npr on in nyc?
+what degrees did barack obama get?
+who played elaine the pain?
+who is amy grant's first husband?
+what books did agatha christie wrote?
+who is moira in x men?
+what did drita find out?
+who played barbara gordon batgirl?
+what type of music did john lennon sing?
+what position did lebron james play?
+where is the university of maryland medical school?
+what form of government does north korea have?
+who was the secretary of state when andrew jackson was president?
+which dawkins book to read first?
+what money does spain use?
+who played amy squirrel in bad teacher?
+what was gregor mendel contribution?
+where does the expression excuse my french come from?
+who is vancouver canucks coach?
+where is holy roman empire located?
+where do the appalachian mountains run?
+what type of government does the us follow?
+what states share a border with tennessee?
+where is harley davidson made?
+what did shakespeare learn in grammar school?
+who does the voice for chucky in child's play?
+where were the seneca indians located?
+what would ap xin zhao do?
+who was the artist of mickey mouse?
+what language is spoken in switzerland?
+what was dr seuss's real name?
+who plays elena gilbert on vampire diaries?
+what are all the movies taylor swift has been in?
+who plays charlie in the santa clause movies?
+what produce does florida export?
+where did kobe earthquake happen?
+what record label is kelly clarkson signed with?
+who has coached the carolina panthers?
+what country is dyson made?
+where does the columbia river start?
+who are the u s senators of pennsylvania?
+where did the russian japanese war happen?
+what language is most commonly spoken in belgium?
+where did joe flacco attend college?
+what to do san jose ca?
+where is the empire of ghana?
+what did dmitri mendeleev discover in 1869?
+where to get a marriage license in long island?
+when does the world end according to the mayans time?
+what do the symbols on the nevada flag mean?
+where is perpignan located?
+where is olympic national park wa?
+when was the most recent earthquake in haiti?
+what books are written by suzanne collins?
+who is the president of peru now?
+where did the israel palestine conflict start?
+what are some ancient egypt names?
+where is the fukushima daiichi nuclear plant located?
+who is mary mcleod bethune for kids?
+what character did billy d williams play in star wars?
+what city is mt lassen in?
+where do john lennon die?
+when does daylight saving end in new zealand 2012?
+where did spencer pratt go to school?
+where was the temple of karnak built?
+what did shakespeare become famous for?
+what language do they speak in malta?
+who did ricky martin started his career with?
+what language did they speak in ghana?
+who was dan white?
+who does peter griffin voice?
+where was benjamin franklin educated?
+what does gm make?
+who played lauren reed on alias?
+who does donnie wahlberg play in the sixth sense?
+where does marta play soccer?
+where are the gobi desert located on a map?
+where are the texas rangers playing?
+what percent of americans have college degree?
+where was country singer george jones born?
+where is denmark situated?
+where was osama bin laden killed?
+what did shannon hoon die from?
+what kind of government is sweden?
+who or what influenced albert einstein?
+what is arkansas state capitol?
+where does kurdish people live?
+who is the state governor of tennessee?
+what sri lanka capital?
+what political party did andrew johnson belong to?
+where did mubarak get his wealth?
+what team did aguero play for?
+where did george michael go to school?
+who plays london tipton in suite life on deck?
+who is sir james dyson?
+what city in florida has the lowest crime rate?
+what team did ronaldo play for in 2003?
+what year did houston rockets win their first championship?
+what does monsanto own?
+who was jesse james killed by?
+what is the predominant religion in israel?
+with which ancient ruler did julius caesar fall in love?
+what kind of money should i take to costa rica?
+where did paula deen go to school?
+what highschool did r. kelly attend?
+who is number 22 for the dallas cowboys?
+when was the last time the orioles won the world series?
+who did woody harrelson play on cheers?
+what country did buddha come from?
+what type of religion does argentina have?
+what language do they in ghana?
+what the largest city in spain?
+who is khloe kardashian's husband?
+what college did john nash teach at?
+what stones albums did mick taylor play on?
+what political party was hitler in?
+what college did se hinton go?
+what language is spoken in haiti today?
+who plays king julian madagascar?
+what state is saint louis university in?
+where did george herbert walker bush go to college?
+where is mount st helens volcano?
+what did joan crawford died of?
+what awards gary paulsen won?
+who is eli whitney and what did he invent?

data/webq-train.json

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4ae11a9dda6a3520cff42077063e7222e69650ea8087ae2686e34a957269fba3
+size 205872205

utils/retriever_utils.py

@@ -0,0 +1,163 @@
+import csv
+import glob
+import json
+import gzip
+import logging
+import functools
+from pathlib import Path
+
+import wandb
+from typing import List, Tuple, Dict, Iterator, Union
+
+from dpr.data.qa_validation import calculate_matches
+
+logger = logging.getLogger()
+logger.setLevel(logging.INFO)
+if logger.hasHandlers():
+    logger.handlers.clear()
+console = logging.StreamHandler()
+logger.addHandler(console)
+
+RECALL_FILE_NAME = "recall_at_k.csv"
+RESULTS_FILE_NAME = "results.json"
+
+
+def parse_qa_csv_file(location) -> Iterator[Tuple[str, List[str]]]:
+    with open(location) as ifile:
+        reader = csv.reader(ifile, delimiter="\t")
+        for row in reader:
+            question = row[0]
+            answers = eval(row[1])
+            yield question, answers
+
+
+def parse_qa_json_file(path):
+    with open(path, "r") as f:
+        data = json.load(f)
+    for d in data:
+        question = d["question"]
+        answers = d["answers"]
+        if "entity" in d:
+            yield question, answers, d["entity"]
+        else:
+            yield question, answers
+
+def validate(
+    dataset_name: str,
+    passages: Dict[object, Tuple[str, str]],
+    answers: List[List[str]],
+    result_ctx_ids: List[Tuple[List[object], List[float]]],
+    workers_num: int,
+    match_type: str,
+    out_file: str,
+    use_wandb: bool = True,
+    output_recall_at_k: bool = False,
+    log: bool = True
+) -> Union[List[List[bool]], Tuple[object, List[float]]]:
+    match_stats = calculate_matches(
+        passages, answers, result_ctx_ids, workers_num, match_type
+    )
+
+    top_k_hits = match_stats.top_k_hits
+    # if log: logger.info("Validation results: match_stats %s", match_stats)
+    # if log: logger.info("Validation results: top k documents hits %s", top_k_hits)
+    top_k_hits = [v / len(result_ctx_ids) for v in top_k_hits]
+    if log: logger.info("Validation results: top k documents hits accuracy %s", top_k_hits)
+    with open(out_file, "w") as f:
+        for k, recall in enumerate(top_k_hits):
+            f.write(f"{k+1},{recall}\n")
+            if use_wandb:
+                wandb.log({f"eval-{dataset_name}/k": k+1, f"eval-{dataset_name}/recall": recall})
+    if log: logger.info(f"Saved recall@k info to {out_file}")
+    return match_stats.questions_doc_hits if not output_recall_at_k else (match_stats.questions_doc_hits, top_k_hits)
+
+
+def load_passages(ctx_file: str) -> Dict[object, Tuple[str, str]]:
+    docs = {}
+    logger.info("Reading data from: %s", ctx_file)
+    if ctx_file.endswith(".gz"):
+        with gzip.open(ctx_file, "rt") as tsvfile:
+            reader = csv.reader(
+                tsvfile,
+                delimiter="\t",
+            )
+            # file format: doc_id, doc_text, title
+            for row in reader:
+                if row[0] != "id":
+                    docs[row[0]] = (row[1], row[2])
+    else:
+        with open(ctx_file) as tsvfile:
+            reader = csv.reader(
+                tsvfile,
+                delimiter="\t",
+            )
+            # file format: doc_id, doc_text, title
+            for row in reader:
+                if row[0] != "id":
+                    docs[row[0]] = (row[1], row[2])
+    return docs
+
+
+def save_results(
+    passages: Dict[object, Tuple[str, str]],
+    questions: List[str],
+    answers: List[List[str]],
+    top_passages_and_scores: List[Tuple[List[object], List[float]]],
+    per_question_hits: List[List[bool]],
+    out_file: str,
+    output_no_text: bool = False,
+):
+    # join passages text with the result ids, their questions and assigning has|no answer labels
+    merged_data = []
+    assert len(per_question_hits) == len(questions) == len(answers)
+    for i, q in enumerate(questions):
+        q_answers = answers[i]
+        results_and_scores = top_passages_and_scores[i]
+        hits = per_question_hits[i]
+        docs = [passages[doc_id] for doc_id in results_and_scores[0]]
+        scores = [str(score) for score in results_and_scores[1]]
+        hit_indices = [j+1 for j, is_hit in enumerate(hits) if is_hit]
+        hit_min_rank = hit_indices[0] if len(hit_indices) > 0 else None
+        ctxs_num = len(hits)
+
+        d = {
+                "question": q,
+                "answers": q_answers,
+                "hit_min_rank": hit_min_rank,
+                "all_hits": hit_indices,
+                "ctxs": [
+                    {
+                        "id": results_and_scores[0][c],
+                        "rank": (c + 1),
+                        "title": docs[c][1],
+                        "text": docs[c][0] if not output_no_text else "",
+                        "score": scores[c],
+                        "has_answer": hits[c],
+                    }
+                    for c in range(ctxs_num)
+                ],
+            }
+        merged_data.append(d)
+
+    with open(out_file, "w") as writer:
+        writer.write(json.dumps(merged_data, indent=4) + "\n")
+    logger.info("Saved results * scores  to %s", out_file)
+
+
+def get_datasets(qa_file_pattern):
+    logger.info(f"Reading datasets usign the pattern {qa_file_pattern}")
+    all_patterns = qa_file_pattern.split(",")
+    all_qa_files = functools.reduce(lambda a, b: a + b, [glob.glob(pattern) for pattern in all_patterns])
+    qa_file_dict = {}
+    for qa_file in all_qa_files:
+        dataset_name = Path(qa_file).stem.replace(".", "-")
+        dataset = list(parse_qa_csv_file(qa_file)) if qa_file.endswith(".csv") else list(parse_qa_json_file(qa_file))
+        questions, question_answers = [], []
+        for ds_item in dataset:
+            question, answers = ds_item
+            questions.append(question)
+            question_answers.append(answers)
+        qa_file_dict[dataset_name] = (questions, question_answers)
+        logger.info(f"{dataset_name}:{' ' * (20 - len(dataset_name))}{len(questions)} items")
+
+    return qa_file_dict