Minor doc tweaks (castorini#2576)

lgrz · Aug 22, 2024 · ec7ac68 · ec7ac68
1 parent 9b1ba34
commit ec7ac68
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -331,7 +331,7 @@ Once you've unpacked the data, the following commands will loop over all BEIR co
 MODEL="splade-pp-ed"; CORPORA=(trec-covid bioasq nfcorpus nq hotpotqa fiqa signal1m trec-news robust04 arguana webis-touche2020 cqadupstack-android cqadupstack-english cqadupstack-gaming cqadupstack-gis cqadupstack-mathematica cqadupstack-physics cqadupstack-programmers cqadupstack-stats cqadupstack-tex cqadupstack-unix cqadupstack-webmasters cqadupstack-wordpress quora dbpedia-entity scidocs fever climate-fever scifact); for c in "${CORPORA[@]}"
 do
     echo "Running $c..."
-    python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-${c}-${MODEL} > logs/log.beir-v1.0.0-${c}-${MODEL} 2>&1
+    python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-${c}.${MODEL}.onnx > logs/log.beir-v1.0.0-${c}-${MODEL}.onnx 2>&1
 done
 ```
 
@@ -349,6 +349,7 @@ For the other models, modify the above commands as follows:
 | BGE | `bge-base-en-v1.5` | `e4e8324ba3da3b46e715297407a24f00` | `bge-base-en-v1.5-hnsw` |
 
 The "Corpus" above should be substituted into the full file name `beir-v1.0.0-${corpus}.tar`, e.g., `beir-v1.0.0-bge-base-en-v1.5.tar`.
+The above commands should work with some minor modifications: you'll need to tweak the `--regression` parameter to match the schema of the YAML config files in `src/main/resources/regression/`.
 
 </details>
 <details>

diff --git a/docs/fatjar-regressions/fatjar-regressions-v0.36.2-SNAPSHOT.md b/docs/fatjar-regressions/fatjar-regressions-v0.36.2-SNAPSHOT.md
@@ -20,7 +20,6 @@ export ANSERINI_JAR=`ls target/*-fatjar.jar`
 export OUTPUT_DIR="runs"
 ```
 
-
 ## Webapp and REST API
 
 Anserini has a built-in webapp for interactive querying along with a REST API that can be used by other applications.
@@ -397,7 +396,7 @@ java -cp $ANSERINI_JAR trec_eval -m ndcg_cut.10 -c dl20-passage $OUTPUT_DIR/run.
 
 ## BEIR
 
-❗ Beware, the (automatically downloaded) indexes for running these experiments take up 246 GB in total.
+❗ Beware, the (automatically downloaded) indexes for running these experiments take up 374 GB in total.
 
 Currently, Anserini provides support for the following models: