Update README.md

README.md

@@ -14,15 +14,28 @@ viewer: false
 
 ## Description
 
-*TODO: What is the artifact?*
+An index of the sustainable-living subset of the BRIGHT dataset.
 
 ## Usage
 
+You'll need http://github.com/cmacdonald/pyterrier_colbert2
+
+
 ```python
 # Load the artifact
 import pyterrier as pt
-artifact = pt.Artifact.from_hf('pyterrier-tutorial/bright.sustainable.colbert2')
-# TODO: Show how you use the artifact
+index = pt.Artifact.from_hf('pyterrier-tutorial/bright.sustainable.colbert2')
+from pyterrier.measures import *
+topics = pt.get_dataset('irds:bright/sustainable-living').get_topics(variant='text')
+qrels = pt.get_dataset('irds:bright/sustainable-living').get_qrels()
+
+pt.Experiment(
+    [index.end_to_end()],
+    topics,
+    qrels,
+    eval_metrics=[AP, RR, nDCG@10, P@5, "mrt"],
+    names=["ColBERT v2"],
+)
 ```
 
 ## Benchmarks
@@ -32,7 +45,12 @@ artifact = pt.Artifact.from_hf('pyterrier-tutorial/bright.sustainable.colbert2')
 ## Reproduction
 
 ```python
-# TODO: Show how you constructed the artifact.
+import pyterrier as pt
+import pyterrier_colbert
+dataset = pt.get_dataset('irds:bright/sustainable-living')
+indexer = pyterrier_colbert.indexing.ColbertV2Indexer("./sustainable-living", "colbert-ir/colbertv2.0", "2bits")
+index = indexer.index(dataset.get_corpus_iter())
+index.to_hf("pyterrier-tutorial/bright.sustainable.colbert2")
 ```
 
 ## Metadata