rename model

docs/regressions/regressions-beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.md → docs/regressions/regressions-beir-v1.0.0-arguana-splade-pp-ed.md

@@ -5,14 +5,14 @@
 This page describes regression experiments, integrated into Anserini's regression testing framework, using [SPLADE++ (CoCondenser-EnsembleDistil)](https://arxiv.org/abs/2205.04733) on [BEIR (v1.0.0) — ArguAna](http://beir.ai/).
 See the [official SPLADE repo](https://github.com/naver/splade) for more details; the model itself can be download [here](https://huggingface.co/naver/splade-cocondenser-ensembledistil).
 
-The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.yaml).
-Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
+The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-arguana-splade-pp-ed.yaml).
+Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-arguana-splade-pp-ed.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
 
 From one of our Waterloo servers (e.g., `orca`), the following command will perform the complete regression, end to end:
 
 ```
 python src/main/python/run_regression.py --index --verify --search \
-  --regression beir-v1.0.0-arguana-splade-cocondenser-ensembledistil
+  --regression beir-v1.0.0-arguana-splade-pp-ed
 ```
 
 ## Indexing
@@ -22,11 +22,11 @@ Sample indexing command:
 ```
 target/appassembler/bin/IndexCollection \
   -collection JsonVectorCollection \
-  -input /path/to/beir-v1.0.0-arguana-splade-cocondenser-ensembledistil \
+  -input /path/to/beir-v1.0.0-arguana-splade-pp-ed \
   -generator DefaultLuceneDocumentGenerator \
-  -index indexes/lucene-index.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil/ \
+  -index indexes/lucene-index.beir-v1.0.0-arguana-splade-pp-ed/ \
   -threads 16 -impact -pretokenized -optimize \
-  >& logs/log.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil &
+  >& logs/log.beir-v1.0.0-arguana-splade-pp-ed &
 ```
 
 The important indexing options to note here are `-impact -pretokenized`: the first tells Anserini not to encode BM25 doclengths into Lucene's norms (which is the default) and the second option says not to apply any additional tokenization on the pre-encoded tokens.
@@ -40,19 +40,19 @@ After indexing has completed, you should be able to perform retrieval as follows
 
 ```
 target/appassembler/bin/SearchCollection \
-  -index indexes/lucene-index.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil/ \
-  -topics tools/topics-and-qrels/topics.beir-v1.0.0-arguana.test.splade-cocondenser-ensembledistil.tsv.gz \
+  -index indexes/lucene-index.beir-v1.0.0-arguana-splade-pp-ed/ \
+  -topics tools/topics-and-qrels/topics.beir-v1.0.0-arguana.test.splade-pp-ed.tsv.gz \
   -topicReader TsvString \
-  -output runs/run.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-arguana.test.splade-cocondenser-ensembledistil.txt \
+  -output runs/run.beir-v1.0.0-arguana-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-arguana.test.splade-pp-ed.txt \
   -impact -pretokenized -removeQuery -hits 1000 &
 ```
 
 Evaluation can be performed using `trec_eval`:
 
 ```
-tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-arguana.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-arguana.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-arguana.test.splade-cocondenser-ensembledistil.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-arguana.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-arguana.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-arguana.test.txt runs/run.beir-v1.0.0-arguana-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-arguana.test.splade-pp-ed.txt
 ```
 
 ## Effectiveness
@@ -70,4 +70,4 @@ With the above commands, you should be able to reproduce the following results:
 
 ## Reproduction Log[*](../../docs/reproducibility.md)
 
-To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-arguana-splade-cocondenser-ensembledistil.template) and run `bin/build.sh` to rebuild the documentation.
+To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-arguana-splade-pp-ed.template) and run `bin/build.sh` to rebuild the documentation.

docs/regressions/regressions-beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.md → docs/regressions/regressions-beir-v1.0.0-bioasq-splade-pp-ed.md

@@ -5,14 +5,14 @@
 This page describes regression experiments, integrated into Anserini's regression testing framework, using [SPLADE++ (CoCondenser-EnsembleDistil)](https://arxiv.org/abs/2205.04733) on [BEIR (v1.0.0) — BioASQ](http://beir.ai/).
 See the [official SPLADE repo](https://github.com/naver/splade) for more details; the model itself can be download [here](https://huggingface.co/naver/splade-cocondenser-ensembledistil).
 
-The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.yaml).
-Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
+The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-bioasq-splade-pp-ed.yaml).
+Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-bioasq-splade-pp-ed.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
 
 From one of our Waterloo servers (e.g., `orca`), the following command will perform the complete regression, end to end:
 
 ```
 python src/main/python/run_regression.py --index --verify --search \
-  --regression beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil
+  --regression beir-v1.0.0-bioasq-splade-pp-ed
 ```
 
 ## Indexing
@@ -22,11 +22,11 @@ Sample indexing command:
 ```
 target/appassembler/bin/IndexCollection \
   -collection JsonVectorCollection \
-  -input /path/to/beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil \
+  -input /path/to/beir-v1.0.0-bioasq-splade-pp-ed \
   -generator DefaultLuceneDocumentGenerator \
-  -index indexes/lucene-index.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil/ \
+  -index indexes/lucene-index.beir-v1.0.0-bioasq-splade-pp-ed/ \
   -threads 16 -impact -pretokenized -optimize \
-  >& logs/log.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil &
+  >& logs/log.beir-v1.0.0-bioasq-splade-pp-ed &
 ```
 
 The important indexing options to note here are `-impact -pretokenized`: the first tells Anserini not to encode BM25 doclengths into Lucene's norms (which is the default) and the second option says not to apply any additional tokenization on the pre-encoded tokens.
@@ -40,19 +40,19 @@ After indexing has completed, you should be able to perform retrieval as follows
 
 ```
 target/appassembler/bin/SearchCollection \
-  -index indexes/lucene-index.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil/ \
-  -topics tools/topics-and-qrels/topics.beir-v1.0.0-bioasq.test.splade-cocondenser-ensembledistil.tsv.gz \
+  -index indexes/lucene-index.beir-v1.0.0-bioasq-splade-pp-ed/ \
+  -topics tools/topics-and-qrels/topics.beir-v1.0.0-bioasq.test.splade-pp-ed.tsv.gz \
   -topicReader TsvString \
-  -output runs/run.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-bioasq.test.splade-cocondenser-ensembledistil.txt \
+  -output runs/run.beir-v1.0.0-bioasq-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-bioasq.test.splade-pp-ed.txt \
   -impact -pretokenized -removeQuery -hits 1000 &
 ```
 
 Evaluation can be performed using `trec_eval`:
 
 ```
-tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-bioasq.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-bioasq.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-bioasq.test.splade-cocondenser-ensembledistil.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-bioasq.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-bioasq.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-bioasq.test.txt runs/run.beir-v1.0.0-bioasq-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-bioasq.test.splade-pp-ed.txt
 ```
 
 ## Effectiveness
@@ -70,4 +70,4 @@ With the above commands, you should be able to reproduce the following results:
 
 ## Reproduction Log[*](../../docs/reproducibility.md)
 
-To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-bioasq-splade-cocondenser-ensembledistil.template) and run `bin/build.sh` to rebuild the documentation.
+To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-bioasq-splade-pp-ed.template) and run `bin/build.sh` to rebuild the documentation.

docs/regressions/regressions-beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.md → docs/regressions/regressions-beir-v1.0.0-climate-fever-splade-pp-ed.md

@@ -5,14 +5,14 @@
 This page describes regression experiments, integrated into Anserini's regression testing framework, using [SPLADE++ (CoCondenser-EnsembleDistil)](https://arxiv.org/abs/2205.04733) on [BEIR (v1.0.0) — Climate-FEVER](http://beir.ai/).
 See the [official SPLADE repo](https://github.com/naver/splade) for more details; the model itself can be download [here](https://huggingface.co/naver/splade-cocondenser-ensembledistil).
 
-The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.yaml).
-Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
+The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/beir-v1.0.0-climate-fever-splade-pp-ed.yaml).
+Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-climate-fever-splade-pp-ed.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead and then run `bin/build.sh` to rebuild the documentation.
 
 From one of our Waterloo servers (e.g., `orca`), the following command will perform the complete regression, end to end:
 
 ```
 python src/main/python/run_regression.py --index --verify --search \
-  --regression beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil
+  --regression beir-v1.0.0-climate-fever-splade-pp-ed
 ```
 
 ## Indexing
@@ -22,11 +22,11 @@ Sample indexing command:
 ```
 target/appassembler/bin/IndexCollection \
   -collection JsonVectorCollection \
-  -input /path/to/beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil \
+  -input /path/to/beir-v1.0.0-climate-fever-splade-pp-ed \
   -generator DefaultLuceneDocumentGenerator \
-  -index indexes/lucene-index.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil/ \
+  -index indexes/lucene-index.beir-v1.0.0-climate-fever-splade-pp-ed/ \
   -threads 16 -impact -pretokenized -optimize \
-  >& logs/log.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil &
+  >& logs/log.beir-v1.0.0-climate-fever-splade-pp-ed &
 ```
 
 The important indexing options to note here are `-impact -pretokenized`: the first tells Anserini not to encode BM25 doclengths into Lucene's norms (which is the default) and the second option says not to apply any additional tokenization on the pre-encoded tokens.
@@ -40,19 +40,19 @@ After indexing has completed, you should be able to perform retrieval as follows
 
 ```
 target/appassembler/bin/SearchCollection \
-  -index indexes/lucene-index.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil/ \
-  -topics tools/topics-and-qrels/topics.beir-v1.0.0-climate-fever.test.splade-cocondenser-ensembledistil.tsv.gz \
+  -index indexes/lucene-index.beir-v1.0.0-climate-fever-splade-pp-ed/ \
+  -topics tools/topics-and-qrels/topics.beir-v1.0.0-climate-fever.test.splade-pp-ed.tsv.gz \
   -topicReader TsvString \
-  -output runs/run.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-climate-fever.test.splade-cocondenser-ensembledistil.txt \
+  -output runs/run.beir-v1.0.0-climate-fever-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-climate-fever.test.splade-pp-ed.txt \
   -impact -pretokenized -removeQuery -hits 1000 &
 ```
 
 Evaluation can be performed using `trec_eval`:
 
 ```
-tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-climate-fever.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-climate-fever.test.splade-cocondenser-ensembledistil.txt
-tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.splade-cocondenser-ensembledistil.topics.beir-v1.0.0-climate-fever.test.splade-cocondenser-ensembledistil.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m ndcg_cut.10 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-climate-fever.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-climate-fever.test.splade-pp-ed.txt
+tools/eval/trec_eval.9.0.4/trec_eval -c -m recall.1000 tools/topics-and-qrels/qrels.beir-v1.0.0-climate-fever.test.txt runs/run.beir-v1.0.0-climate-fever-splade-pp-ed.splade-pp-ed.topics.beir-v1.0.0-climate-fever.test.splade-pp-ed.txt
 ```
 
 ## Effectiveness
@@ -70,4 +70,4 @@ With the above commands, you should be able to reproduce the following results:
 
 ## Reproduction Log[*](../../docs/reproducibility.md)
 
-To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-climate-fever-splade-cocondenser-ensembledistil.template) and run `bin/build.sh` to rebuild the documentation.
+To add to this reproduction log, modify [this template](../../src/main/resources/docgen/templates/beir-v1.0.0-climate-fever-splade-pp-ed.template) and run `bin/build.sh` to rebuild the documentation.