macavaney commited on
Commit
05beb0f
1 Parent(s): 0379436

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -5
README.md CHANGED
@@ -14,25 +14,36 @@ viewer: false
14
 
15
  ## Description
16
 
17
- *TODO: What is the artifact?*
18
 
19
  ## Usage
20
 
21
  ```python
22
  # Load the artifact
23
  import pyterrier_alpha as pta
24
- artifact = pta.Artifact.from_hf('pyterrier/arguana.retromae.flex')
25
- # TODO: Show how you use the artifact
26
  ```
27
 
28
  ## Benchmarks
29
 
30
- *TODO: Provide benchmarks for the artifact.*
 
 
 
 
31
 
32
  ## Reproduction
33
 
34
  ```python
35
- # TODO: Show how you constructed the artifact.
 
 
 
 
 
 
 
36
  ```
37
 
38
  ## Metadata
 
14
 
15
  ## Description
16
 
17
+ RetroMAE index for Arguana
18
 
19
  ## Usage
20
 
21
  ```python
22
  # Load the artifact
23
  import pyterrier_alpha as pta
24
+ index = pta.Artifact.from_hf('pyterrier/arguana.retromae.flex')
25
+ index.np_retriever()
26
  ```
27
 
28
  ## Benchmarks
29
 
30
+ `arguana`
31
+
32
+ | name | nDCG@10 | R@1000 |
33
+ |:----------|----------:|---------:|
34
+ | np (flat) | 0.3657 | 0.9836 |
35
 
36
  ## Reproduction
37
 
38
  ```python
39
+ import pyterrier as pt
40
+ from tqdm import tqdm
41
+ import ir_datasets
42
+ from pyterrier_dr import FlexIndex, RetroMAE
43
+ pipeline = RetroMAE.msmarco_distill() >> FlexIndex("arguana.retromae.flex")
44
+ dataset = ir_datasets.load('beir/arguana')
45
+ docs = ({'docno': d.doc_id, 'text': d.default_text()} for d in tqdm(dataset.docs))
46
+ pipeline.index(docs)
47
  ```
48
 
49
  ## Metadata