Updated documentation on pre-built indexes (#285)

castorini · Jan 1, 2021 · d9bf263 · d9bf263
1 parent ad1a537
commit d9bf263
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -145,18 +145,7 @@ The following method will list available pre-built indexes:
 SimpleSearcher.list_prebuilt_indexes()
 ```
 
-A summary of what's currently available:
-
-+ `robust04`: TREC Disks 4 & 5 (minus Congressional Records), used in the TREC 2004 Robust Track
-+ `msmarco-passage`: MS MARCO passage corpus (the index associated with [this guide](docs/experiments-msmarco-passage.md))
-+ `msmarco-passage-slim`: A "slim" version of the above index that does not include the corpus text.
-+ `msmarco-passage-expanded`: MS MARCO passage corpus with docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
-+ `msmarco-doc`: MS MARCO document corpus (the index associated with [this guide](docs/experiments-msmarco-doc.md))
-+ `msmarco-doc-slim`: A "slim" version of the above index that does not include the corpus text.
-+ `msmarco-doc-expanded-per-doc`: MS MARCO document corpus with per-document docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
-+ `msmarco-doc-expanded-per-passage`: MS MARCO document corpus with per-passage docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
-+ `enwiki-paragraphs`: English Wikipedia (for use with [BERTserini](https://github.com/rsvp-ai/bertserini))
-+ `zhwiki-paragraphs`: Chinese Wikipedia (for use with [BERTserini](https://github.com/rsvp-ai/bertserini))
+A description of what's available can be found [here](docs/prebuilt-indexes.md).
 
 ## How do I fetch a document?
 

diff --git a/docs/prebuilt-indexes.md b/docs/prebuilt-indexes.md
@@ -0,0 +1,45 @@
+# Pyserini: Prebuilt Indexes
+
+Pre-built Anserini indexes are hosted at the University of Waterloo's [GitLab](https://git.uwaterloo.ca/jimmylin/anserini-indexes) and mirrored on Dropbox.
+The following method will list available pre-built indexes:
+
+```
+SimpleSearcher.list_prebuilt_indexes()
+```
+
+Below is a summary of what's currently available:
+
+## MS MARCO Indexes
+
++ `msmarco-passage`: MS MARCO passage corpus (the index associated with [this guide](docs/experiments-msmarco-passage.md))
++ `msmarco-passage-slim`: A "slim" version of the above index that does not include the corpus text.
++ `msmarco-passage-expanded`: MS MARCO passage corpus with docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
++ `msmarco-doc`: MS MARCO document corpus (the index associated with [this guide](docs/experiments-msmarco-doc.md))
++ `msmarco-doc-slim`: A "slim" version of the above index that does not include the corpus text.
++ `msmarco-doc-expanded-per-doc`: MS MARCO document corpus with per-document docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
++ `msmarco-doc-expanded-per-passage`: MS MARCO document corpus with per-passage docTTTTTquery expansion (see [this guide](http://doc2query.ai/))
+
+## TREC Indexes
+
++ `robust04`: TREC Disks 4 & 5 (minus Congressional Records), used in the TREC 2004 Robust Track
++ `cast19`: TREC 2019 CaST (also used for TREC 2020 CaST)
++ `trec-covid-r5-abstract`: TREC-COVID Round 5: abstract index
++ `trec-covid-r5-full-text`: TREC-COVID Round 5: full-text index
++ `trec-covid-r5-paragraph`: TREC-COVID Round 5: paragraph index
++ `trec-covid-r4-abstract`: TREC-COVID Round 4: abstract index
++ `trec-covid-r4-full-text`: TREC-COVID Round 4: full-text index
++ `trec-covid-r4-paragraph`: TREC-COVID Round 4: paragraph index
++ `trec-covid-r3-abstract`: TREC-COVID Round 3: abstract index
++ `trec-covid-r3-full-text`: TREC-COVID Round 3: full-text index
++ `trec-covid-r3-paragraph`: TREC-COVID Round 3: paragraph index
++ `trec-covid-r2-abstract`: TREC-COVID Round 2: abstract index
++ `trec-covid-r2-full-text`: TREC-COVID Round 2: full-text index
++ `trec-covid-r2-paragraph`: TREC-COVID Round 2: paragraph index
++ `trec-covid-r1-abstract`: TREC-COVID Round 1: abstract index
++ `trec-covid-r1-full-text`: TREC-COVID Round 1: full-text index
++ `trec-covid-r1-paragraph`: TREC-COVID Round 1: paragraph index
+
+## Other Indexes
+
++ `enwiki-paragraphs`: English Wikipedia (for use with [BERTserini](https://github.com/rsvp-ai/bertserini))
++ `zhwiki-paragraphs`: Chinese Wikipedia (for use with [BERTserini](https://github.com/rsvp-ai/bertserini))