8000 Add links to SPLADEv3 docs by lintool · Pull Request #2844 · castorini/anserini · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add links to SPLADEv3 docs #2844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 24, 2025
Merged

Add links to SPLADEv3 docs #2844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d787e5a
SPLADEv3 added md.
lintool Jun 14, 2025
da810c8
changed links.
lintool Jun 14, 2025
dbbfeb1
Add commands.
lintool Jun 15, 2025
fd18dc3
fixed typo.
lintool Jun 22, 2025
dc91ff1
Merge branch 'master' into docs
lintool Jun 23, 2025
c128d3e
Merge branch 'master' into docs
lintool Jun 23, 2025
df2f405
Merge branch 'master' into docs
lintool Jun 23, 2025
f3ab165
Merge branch 'docs' of github.com:castorini/anserini into docs
lintool Jun 23, 2025
760cdef
regenerated docs.
lintool Jun 23, 2025
6216ded
Updated README.
lintool Jun 23, 2025
5edbcf3
Fixed typos in docs.
lintool Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 87 additions & 42 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

68 changes: 68 additions & 0 deletions docs/regressions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,74 @@ nohup python src/main/python/run_regression.py --index --verify --search --regre
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-scifact.bge-base-en-v1.5.parquet.hnsw-int8.onnx >& logs/log.beir-v1.0.0-scifact.bge-base-en-v1.5.parquet.hnsw-int8.onnx.txt &
```

</details>
<details>
<summary>BEIR (v1.0.0): SPLADE-v3</summary>

```bash
# Cached queries
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-trec-covid.splade-v3.cached >& logs/log.beir-v1.0.0-trec-covid.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-bioasq.splade-v3.cached >& logs/log.beir-v1.0.0-bioasq.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-nfcorpus.splade-v3.cached >& logs/log.beir-v1.0.0-nfcorpus.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-nq.splade-v3.cached >& logs/log.beir-v1.0.0-nq.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-hotpotqa.splade-v3.cached >& logs/log.beir-v1.0.0-hotpotqa.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-fiqa.splade-v3.cached >& logs/log.beir-v1.0.0-fiqa.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-signal1m.splade-v3.cached >& logs/log.beir-v1.0.0-signal1m.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-trec-news.splade-v3.cached >& logs/log.beir-v1.0.0-trec-news.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-robust04.splade-v3.cached >& logs/log.beir-v1.0.0-robust04.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-arguana.splade-v3.cached >& logs/log.beir-v1.0.0-arguana.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-webis-touche2020.splade-v3.cached >& logs/log.beir-v1.0.0-webis-touche2020.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-android.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-android.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-english.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-english.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-gaming.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-gaming.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-gis.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-gis.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-mathematica.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-mathematica.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-physics.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-physics.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-programmers.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-programmers.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-stats.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-stats.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-tex.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-tex.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-unix.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-unix.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-webmasters.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-webmasters.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-wordpress.splade-v3.cached >& logs/log.beir-v1.0.0-cqadupstack-wordpress.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-quora.splade-v3.cached >& logs/log.beir-v1.0.0-quora.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-dbpedia-entity.splade-v3.cached >& logs/log.beir-v1.0.0-dbpedia-entity.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-scidocs.splade-v3.cached >& logs/log.beir-v1.0.0-scidocs.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-fever.splade-v3.cached >& logs/log.beir-v1.0.0-fever.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-climate-fever.splade-v3.cached >& logs/log.beir-v1.0.0-climate-fever.splade-v3.cached.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-scifact.splade-v3.cached >& logs/log.beir-v1.0.0-scifact.splade-v3.cached.txt &

# ONNX
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-trec-covid.splade-v3.onnx >& logs/log.beir-v1.0.0-trec-covid.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-bioasq.splade-v3.onnx >& logs/log.beir-v1.0.0-bioasq.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-nfcorpus.splade-v3.onnx >& logs/log.beir-v1.0.0-nfcorpus.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-nq.splade-v3.onnx >& logs/log.beir-v1.0.0-nq.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-hotpotqa.splade-v3.onnx >& logs/log.beir-v1.0.0-hotpotqa.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-fiqa.splade-v3.onnx >& logs/log.beir-v1.0.0-fiqa.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-signal1m.splade-v3.onnx >& logs/log.beir-v1.0.0-signal1m.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-trec-news.splade-v3.onnx >& logs/log.beir-v1.0.0-trec-news.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-robust04.splade-v3.onnx >& logs/log.beir-v1.0.0-robust04.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-arguana.splade-v3.onnx >& logs/log.beir-v1.0.0-arguana.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-webis-touche2020.splade-v3.onnx >& logs/log.beir-v1.0.0-webis-touche2020.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-android.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-android.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-english.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-english.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-gaming.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-gaming.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-gis.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-gis.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-mathematica.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-mathematica.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-physics.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-physics.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-programmers.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-programmers.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-stats.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-stats.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-tex.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-tex.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-unix.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-unix.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-webmasters.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-webmasters.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-cqadupstack-wordpress.splade-v3.onnx >& logs/log.beir-v1.0.0-cqadupstack-wordpress.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-quora.splade-v3.onnx >& logs/log.beir-v1.0.0-quora.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-dbpedia-entity.splade-v3.onnx >& logs/log.beir-v1.0.0-dbpedia-entity.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-scidocs.splade-v3.onnx >& logs/log.beir-v1.0.0-scidocs.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-fever.splade-v3.onnx >& logs/log.beir-v1.0.0-fever.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-climate-fever.splade-v3.onnx >& logs/log.beir-v1.0.0-climate-fever.splade-v3.onnx.txt &
nohup python src/main/python/run_regression.py --index --verify --search --regression beir-v1.0.0-scifact.splade-v3.onnx >& logs/log.beir-v1.0.0-scifact.splade-v3.onnx.txt &
```

</details>
<details>
<summary>BEIR (v1.0.0): SPLADE++ CoCondenser-EnsembleDistil</summary>
Expand Down
4 changes: 2 additions & 2 deletions docs/regressions/regressions-beir-v1.0.0-hotpotqa.splade-v3.cached.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ bin/run.sh io.anserini.index.IndexCollection \
-collection JsonVectorCollection \
-input /path/to/beir-v1.0.0-hotpotqa.splade-v3 \
-generator DefaultLuceneDocumentGenerator \
-index indexes/lucene-inverted.beir-v1.0.0-hotpotqa.splade-pp-ed/ \
-index indexes/lucene-inverted.beir-v1.0.0-hotpotqa.splade-v3/ \
-impact -pretokenized \
>& logs/log.beir-v1.0.0-hotpotqa.splade-v3 &
```
Expand All @@ -55,7 +55,7 @@ After indexing has completed, you should be able to perform retrieval as follows

```
bin/run.sh io.anserini.search.SearchCollection \
-index indexes/lucene-inverted.beir-v1.0.0-hotpotqa.splade-pp-ed/ \
-index indexes/lucene-inverted.beir-v1.0.0-hotpotqa.splade-v3/ \
-topics tools/topics-and-qrels/topics.beir-v1.0.0-hotpotqa.test.splade-v3.tsv.gz \
-topicReader TsvString \
-output runs/run.beir-v1.0.0-hotpotqa.splade-v3.splade-v3-cached.topics.beir-v1.0.0-hotpotqa.test.splade-v3.txt \
Expand Down
2 changes: 1 addition & 1 deletion 2 docs/regressions/regressions-beir-v1.0.0-nfcorpus.splade-pp-ed.cached.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Anserini Regressions: BEIR (v1.0.0) &mdash; NCorpus
# Anserini Regressions: BEIR (v1.0.0) &mdash; NFCorpus

**Model**: [SPLADE++ (CoCondenser-EnsembleDistil](https://arxiv.org/abs/2205.04733) (using cached queries)

Expand Down
2 changes: 1 addition & 1 deletion docs/regressions/regressions-beir-v1.0.0-nfcorpus.splade-v3.cached.md
View file
Open in desktop
5D39
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Anserini Regressions: BEIR (v1.0.0) &mdash; NCorpus
# Anserini Regressions: BEIR (v1.0.0) &mdash; NFCorpus

**Model**: [SPLADE-v3](https://arxiv.org/abs/2403.06789) (using cached queries)

Expand Down
2 changes: 1 addition & 1 deletion docs/regressions/regressions-beir-v1.0.0-nfcorpus.splade-v3.onnx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Anserini Regressions: BEIR (v1.0.0) &mdash; NCorpus
# Anserini Regressions: BEIR (v1.0.0) &mdash; NFCorpus

**Model**: [SPLADE-v3](https://arxiv.org/abs/2403.06789) (using ONNX for on-the-fly query encoding)

Expand Down
1 change: 0 additions & 1 deletion docs/regressions/regressions-beir-v1.0.0-quora.splade-v3.onnx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
**Model**: [SPLADE-v3](https://arxiv.org/abs/2403.06789) (using ONNX for on-the-fly query encoding)

This page describes regression experiments, integrated into Anserini's regression testing framework, using [SPLADE-v3](https://arxiv.org/abs/2403.06789) on [BEIR (v1.0.0) &mdash; Quora](http://beir.ai/).

The model itself can be download [here](https://huggingface.co/naver/splade-v3).
See the [official SPLADE repo](https://github.com/naver/splade) and the following paper for more details:

Expand Down
Loading
0