Create README.md

README.md

@@ -0,0 +1,22 @@
+## CIRAL Baselines and Indexes
+
+### Reproduction
+
+This repo provides the CIRAL's built indexes (Pre-built indexes) to reproduce baselines. 
+
+To search using the indexes:
+
+1. Afriberta-DPR
+```bash
+lang=yo # or ha, so, sw
+set=train # or test
+
+run_file=runs/run.ciral.afriberta-dpr.${lang}.${set}.txt
+
+python -m pyserini.search.faiss \
+  --encoder-class auto \
+  --encoder castorini/afriberta-dpr-ptf-msmarco-ft-latin-mrtydi  \
+  --topics /path/to/topics \
+  --index /path/to/faiss.ciral-v1.0-${lang}-afriberta-dpr \
+  --output ${run_file} --batch 128 --threads 16 --hits 1000
+```