forked from castorini/anserini
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Regressions and bindings for CIRAL (castorini#2377)
- Loading branch information
1 parent
baa57eb
commit 61433f6
Showing
29 changed files
with
1,015 additions
and
110 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Anserini Regressions: CIRAL (v1.0) — Hausa (English Translation) | ||
|
|
||
| This page documents BM25 regression experiments for [CIRAL (v1.0) — Hausa](https://github.com/ciralproject/ciral) with document translations. To be clear, the queries are in English and the corpus is in English (translated with [NLLB 1.3B](https://huggingface.co/facebook/nllb-200-1.3B)). | ||
|
|
||
| The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/ciral-v1.0-ha-en.yaml). | ||
| Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/ciral-v1.0-ha-en.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead. | ||
|
|
||
| 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 ciral-v1.0-ha-en | ||
| ``` | ||
|
|
||
| ## Indexing | ||
|
|
||
| Typical indexing command: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/IndexCollection \ | ||
| -collection MrTyDiCollection \ | ||
| -input /path/to/ciral-hausa-english \ | ||
| -generator DefaultLuceneDocumentGenerator \ | ||
| -index indexes/lucene-index.ciral-v1.0-ha-en/ \ | ||
| -threads 16 -storePositions -storeDocvectors -storeRaw \ | ||
| >& logs/log.ciral-hausa-english & | ||
| ``` | ||
|
|
||
| See [this page](https://github.com/ciralproject/ciral) for more details about the CIRAL corpus. | ||
| For additional details, see explanation of [common indexing options](../../docs/common-indexing-options.md). | ||
|
|
||
| ## Retrieval | ||
|
|
||
| After indexing has completed, you should be able to perform retrieval as follows: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-ha-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-ha-test-a.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt \ | ||
| -bm25 -hits 1000 & | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-ha-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-ha-test-a.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt \ | ||
| -bm25 -hits 1000 & | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-ha-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-ha-test-b.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-b.txt \ | ||
| -bm25 -hits 1000 & | ||
| ``` | ||
|
|
||
| Evaluation can be performed using `trec_eval`: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-a.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-a.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-a-pools.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-a-pools.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-b.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-b.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-ha-test-b.tsv runs/run.ciral-hausa-english.bm25-default.topics.ciral-v1.0-ha-test-b.txt | ||
| ``` | ||
|
|
||
| ## Effectiveness | ||
|
|
||
| With the above commands, you should be able to reproduce the following results: | ||
|
|
||
| | **nDCG@20** | **BM25 (default)**| | ||
| |:-------------------------------------------------------------------------------------------------------------|-----------| | ||
| | [CIRAL Hausa: Test Set A (Shallow Judgements)](https://huggingface.co/datasets/CIRAL/ciral) | 0.1619 | | ||
| | [CIRAL Hausa: Test Set A (Pools)](https://huggingface.co/datasets/CIRAL/ciral) | 0.2142 | | ||
| | [CIRAL Hausa: Test Set B](https://huggingface.co/datasets/CIRAL/ciral) | 0.2124 | | ||
| | **R@100** | **BM25 (default)**| | ||
| | [CIRAL Hausa: Test Set A (Shallow Judgements)](https://huggingface.co/datasets/CIRAL/ciral) | 0.4099 | | ||
| | [CIRAL Hausa: Test Set A (Pools)](https://huggingface.co/datasets/CIRAL/ciral) | 0.4039 | | ||
| | [CIRAL Hausa: Test Set B](https://huggingface.co/datasets/CIRAL/ciral) | 0.4394 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| # Anserini Regressions: CIRAL (v1.0) — Somali (English Translation) | ||
|
|
||
| This page documents BM25 regression experiments for [CIRAL (v1.0) — Somali](https://github.com/ciralproject/ciral) with document translations. To be clear, the queries are in English and the corpus is in English (translated with [NLLB 1.3B](https://huggingface.co/facebook/nllb-200-1.3B)). | ||
|
|
||
| The exact configurations for these regressions are stored in [this YAML file](../../src/main/resources/regression/ciral-v1.0-so-en.yaml). | ||
| Note that this page is automatically generated from [this template](../../src/main/resources/docgen/templates/ciral-v1.0-so-en.template) as part of Anserini's regression pipeline, so do not modify this page directly; modify the template instead. | ||
|
|
||
| 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 ciral-v1.0-so-en | ||
| ``` | ||
|
|
||
| ## Indexing | ||
|
|
||
| Typical indexing command: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/IndexCollection \ | ||
| -collection MrTyDiCollection \ | ||
| -input /path/to/ciral-somali-english \ | ||
| -generator DefaultLuceneDocumentGenerator \ | ||
| -index indexes/lucene-index.ciral-v1.0-so-en/ \ | ||
| -threads 16 -storePositions -storeDocvectors -storeRaw \ | ||
| >& logs/log.ciral-somali-english & | ||
| ``` | ||
|
|
||
| See [this page](https://github.com/ciralproject/ciral) for more details about the CIRAL corpus. | ||
| For additional details, see explanation of [common indexing options](../../docs/common-indexing-options.md). | ||
|
|
||
| ## Retrieval | ||
|
|
||
| After indexing has completed, you should be able to perform retrieval as follows: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-so-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-so-test-a.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt \ | ||
| -bm25 -hits 1000 & | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-so-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-so-test-a.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt \ | ||
| -bm25 -hits 1000 & | ||
| target/appassembler/bin/SearchCollection \ | ||
| -index indexes/lucene-index.ciral-v1.0-so-en/ \ | ||
| -topics tools/topics-and-qrels/topics.ciral-v1.0-so-test-b.tsv \ | ||
| -topicReader TsvInt \ | ||
| -output runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-b.txt \ | ||
| -bm25 -hits 1000 & | ||
| ``` | ||
|
|
||
| Evaluation can be performed using `trec_eval`: | ||
|
|
||
| ``` | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-a.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-a.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-a-pools.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-a-pools.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-a.txt | ||
| target/appassembler/bin/trec_eval -c -m ndcg_cut.20 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-b.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-b.txt | ||
| target/appassembler/bin/trec_eval -c -m recall.100 tools/topics-and-qrels/qrels.ciral-v1.0-so-test-b.tsv runs/run.ciral-somali-english.bm25-default.topics.ciral-v1.0-so-test-b.txt | ||
| ``` | ||
|
|
||
| ## Effectiveness | ||
|
|
||
| With the above commands, you should be able to reproduce the following results: | ||
|
|
||
| | **nDCG@20** | **BM25 (default)**| | ||
| |:-------------------------------------------------------------------------------------------------------------|-----------| | ||
| | [CIRAL Somali: Test Set A (Shallow Judgements)](https://huggingface.co/datasets/CIRAL/ciral) | 0.1590 | | ||
| | [CIRAL Somali: Test Set A (Pools)](https://huggingface.co/datasets/CIRAL/ciral) | 0.2461 | | ||
| | [CIRAL Somali: Test Set B](https://huggingface.co/datasets/CIRAL/ciral) | 0.2186 | | ||
| | **R@100** | **BM25 (default)**| | ||
| | [CIRAL Somali: Test Set A (Shallow Judgements)](https://huggingface.co/datasets/CIRAL/ciral) | 0.3904 | | ||
| | [CIRAL Somali: Test Set A (Pools)](https://huggingface.co/datasets/CIRAL/ciral) | 0.4379 | | ||
| | [CIRAL Somali: Test Set B](https://huggingface.co/datasets/CIRAL/ciral) | 0.4637 | |
Oops, something went wrong.