Update config

README.md

@@ -39,12 +39,16 @@ This dataset repo contains only the queries and relevance judgements. The corpus
    ```
    ciral_dataset = load_dataset("ciral/ciral", "hausa") #or swahili, somali, yoruba
 
-   for data in ciral_data['train']:  # or 'test'
+   for data in ciral_data['dev']:  # or 'testA' or 'testB'
       query_id = data['query_id']
       query = data['query']
       pos_qrels = data['positive_passages']
       neg_qrels = data['negative_passages']
 
+      # To load test set A's pool judgments
+      pools_pos_qrels = data['pools_positive_passages']
+      pools_neg_qrels = data['pools_negative_passages']
+
       for qrel in pos_qrels:
          docid = qrel['docid']
          text = qrel['text']

ciral.py

@@ -40,12 +40,18 @@ _LICENSE = ""
 
 _URLS = {
     lang: {
-        'train': [
-            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-train.tsv',
-            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/qrels/qrels.ciral-v1.0-{lang_code}-train.tsv'
+        'dev': [
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-dev.tsv',
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/qrels/qrels.ciral-v1.0-{lang_code}-dev.tsv'
         ],
-        'test':[
-            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test.tsv'
+        'testA':[
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test-a.tsv',
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test-a.tsv',
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test-a-pools.tsv',
+        ],
+        'testB':[
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test-b.tsv',
+            f'https://huggingface.co/datasets/CIRAL/ciral/resolve/main/ciral-{lang}/topics/topics.ciral-v1.0-{lang_code}-test-b.tsv',
         ]
     } for lang, lang_code in languages.items()
 }
@@ -124,15 +130,21 @@ class CIRAL(datasets.GeneratorBasedBuilder):
         downloaded_files = dl_manager.download_and_extract(_URLS[lang])
         return [
             datasets.SplitGenerator(
-                name='train',
+                name='dev',
+                gen_kwargs={
+                    'filepaths': downloaded_files['dev'],
+                },
+            ),
+            datasets.SplitGenerator(
+                name='test-a',
                 gen_kwargs={
-                    'filepaths': downloaded_files['train'],
+                    'filepaths': downloaded_files['test-a'],
                 },
             ),
             datasets.SplitGenerator(
-                name='test',
+                name='test-b',
                 gen_kwargs={
-                    'filepaths': downloaded_files['test'],
+                    'filepaths': downloaded_files['test-b'],
                 },
             ),
         ]
@@ -140,16 +152,20 @@ class CIRAL(datasets.GeneratorBasedBuilder):
     # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
     def _generate_examples(self, filepaths):
         lang = self.config.name
-        corpus = datasets.load_dataset('ciral/ciral-corpus', lang)['train']
+        corpus = datasets.load_dataset('ciral/ciral-corpus', lang)['dev']
         docid2doc = {doc['docid']: doc['text'] for doc in corpus}
 
-        query_file, qrel_file = (filepaths) if len(filepaths) == 2 else (filepaths[0], None)
+        query_file, qrel_file, pools_file = (filepaths) if len(filepaths) == 3 else (filepaths[0], filepaths[1], None)
         queries = load_queries(query_file)
-        qrels = load_qrels(qrel_file)
+        shallow_qrels = load_qrels(qrel_file)
+        pools_qrels = load_qrels(pools_file)
+        
         for query_id in queries:
+            positive_docids = [docid for docid, judgement in shallow_qrels[query_id].items() if judgement==1]
+            negative_docids = [docid for docid, judgement in shallow_qrels[query_id].items() if judgement==0]
 
-            positive_docids = [docid for docid, judgement in qrels[query_id].items() if judgement==1] if qrels is not None else []
-            negative_docids = [docid for docid, judgement in qrels[query_id].items() if judgement==0] if qrels is not None else []
+            pools_positive_docids = [docid for docid, judgement in pools_qrels[query_id].items() if judgement==1] if pools_qrels is not None else []
+            pools_negative_docids = [docid for docid, judgement in pools_qrels[query_id].items() if judgement==0] if pools_qrels is not None else []
 
             data = {}
             data['query_id'] = query_id
@@ -163,4 +179,13 @@ class CIRAL(datasets.GeneratorBasedBuilder):
                 'text': docid2doc[docid]
             } for docid in negative_docids if docid in docid2doc]
 
+            data['pools_positive_passages'] = [{
+                'docid': docid,
+                'text': docid2doc[docid]
+            } for docid in pools_positive_docids if docid in docid2doc]
+            data['pools_negative_passages'] = [{
+                'docid': docid,
+                'text': docid2doc[docid]
+            } for docid in pools_negative_docids if docid in docid2doc]
+
             yield query_id, data