nq.retromae.flex / README.md
macavaney's picture
Update README.md
901dcf9 verified
---
# pretty_name: "" # Example: "MS MARCO Terrier Index"
tags:
- pyterrier
- pyterrier-artifact
- pyterrier-artifact.dense_index
- pyterrier-artifact.dense_index.flex
task_categories:
- text-retrieval
viewer: false
---
# nq.retromae.flex
## Description
RetroMAE index for NQ
## Usage
```python
# Load the artifact
import pyterrier_alpha as pta
artifact = pta.Artifact.from_hf('pyterrier/nq.retromae.flex')
artifact.np_retriever()
```
## Benchmarks
`nq`
| name | nDCG@10 | R@1000 |
|:----------|----------:|---------:|
| np (flat) | 0.5257 | 0.9718 |
## Reproduction
```python
import pyterrier as pt
from tqdm import tqdm
import ir_datasets
from pyterrier_dr import FlexIndex, RetroMAE
pipeline = RetroMAE.msmarco_distill() >> FlexIndex("nq.retromae.flex")
dataset = ir_datasets.load('beir/nq')
docs = ({'docno': d.doc_id, 'text': d.default_text()} for d in tqdm(dataset.docs))
pipeline.index(docs)
```
## Metadata
```
{
"type": "dense_index",
"format": "flex",
"vec_size": 768,
"doc_count": 2681468
}
```