Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
lintool committed Nov 7, 2023
1 parent 2c03486 commit 595a425
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/experiments-msmarco-passage-openai-ada2.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Anserini: OpenAI-ada2 Embeddings for MS MARCO Passage

⁉️ As of commit [`d76bb4`](https://github.com/castorini/anserini/commit/d76bb4caa7059f0a613836d812e494f383bf128a) (2023/11/04), this page is defunct.
With an upgrade to Lucene 9.8, the jank described here is no longer necessary.
See, for example, [this page](regressions/regressions-msmarco-passage-openai-ada2.md), which has experiments with OpenAI-ada2 embeddings on the MS MARCO passage ranking task integrated, into Anserini's regression framework.

---

This guide explains how to reproduce experiments with OpenAI-ada2 emebddings on the [MS MARCO passage ranking task](https://github.com/microsoft/MSMARCO-Passage-Ranking).
In these experiments, we are using pre-encoded queries (i.e., cached results of query embeddings).

Expand Down
8 changes: 7 additions & 1 deletion docs/regressions-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,17 @@
The following change log details commits to regression tests that alter effectiveness and the addition of new regression tests.
This documentation is useful for figuring why results may have changed over time.

### November 7, 2023

+ commit [`cf459b`](https://github.com/castorini/anserini/commit/cf459b39ecc2c92a400210a9ba84736bdb5d4422) (11/4/2023)
+ commit [`d76bb4`](https://github.com/castorini/anserini/commit/d76bb4caa7059f0a613836d812e494f383bf128a) (11/4/2023)

Added OpenAI-ada2 and CIRAL regressions.

### June 27, 2023

Summarizing new regressions since last entry, see [PR #2140](https://github.com/castorini/anserini/pull/2140):


+ `msmarco-passage-cos-dpr-distil`
+ `msmarco-v2-passage-splade-pp-ed`
+ `msmarco-v2-passage-splade-pp-sd`
Expand Down
5 changes: 5 additions & 0 deletions docs/regressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,11 @@ nohup python src/main/python/run_regression.py --index --verify --search --regre

nohup python src/main/python/run_regression.py --index --verify --search --regression neuclir22-zh-qt-splade >& logs/log.neuclir22-zh-qt-splade &
nohup python src/main/python/run_regression.py --index --verify --search --regression neuclir22-zh-dt-splade >& logs/log.neuclir22-zh-dt-splade &

nohup python src/main/python/run_regression.py --index --verify --search --regression ciral-v1.0-ha >& logs/log.ciral-v1.0-ha
nohup python src/main/python/run_regression.py --index --verify --search --regression ciral-v1.0-so >& logs/log.ciral-v1.0-so
nohup python src/main/python/run_regression.py --index --verify --search --regression ciral-v1.0-sw >& logs/log.ciral-v1.0-sw
nohup python src/main/python/run_regression.py --index --verify --search --regression ciral-v1.0-yo >& logs/log.ciral-v1.0-yo
```
</details>

Expand Down

0 comments on commit 595a425

Please sign in to comment.