fiqa.pisa / README.md
macavaney's picture
Update README.md
e7648ea verified
---
# pretty_name: "" # Example: "MS MARCO Terrier Index"
tags:
- pyterrier
- pyterrier-artifact
- pyterrier-artifact.sparse_index
- pyterrier-artifact.sparse_index.pisa
task_categories:
- text-retrieval
viewer: false
---
# fiqa.pisa
## Description
A PISA index for the FIQA dataset
## Usage
```python
# Load the artifact
import pyterrier as pt
index = pt.Artifact.from_hf('pyterrier/fiqa.pisa')
index.bm25() # returns a BM25 retriever
```
## Benchmarks
`fiqa/dev`
| name | nDCG@10 | R@1000 |
|:-------|----------:|---------:|
| bm25 | 0.263 | 0.7423 |
| dph | 0.2587 | 0.7497 |
`fiqa/test`
| name | nDCG@10 | R@1000 |
|:-------|----------:|---------:|
| bm25 | 0.2411 | 0.7504 |
| dph | 0.2401 | 0.7615 |
## Reproduction
```python
import pyterrier as pt
from tqdm import tqdm
import ir_datasets
from pyterrier_pisa import PisaIndex
index = PisaIndex("fiqa.pisa", threads=16)
dataset = ir_datasets.load('beir/fiqa')
docs = ({'docno': d.doc_id, 'text': d.default_text()} for d in tqdm(dataset.docs))
index.index(docs)
```
## Metadata
```
{
"type": "sparse_index",
"format": "pisa",
"package_hint": "pyterrier-pisa",
"stemmer": "porter2"
}
```