Upload folder using huggingface_hub

README.md

@@ -3,6 +3,8 @@
 tags:
 - pyterrier
 - pyterrier-artifact
+- pyterrier-artifact.sparse_index
+- pyterrier-artifact.sparse_index.terrier
 task_categories:
 - text-retrieval
 viewer: false
@@ -12,43 +14,33 @@ viewer: false
 
 ## Description
 
-Terrier index for Climate-Fever
+*TODO: What is the artifact?*
 
 ## Usage
 
 ```python
 # Load the artifact
 import pyterrier as pt
-index = pt.Artifact.from_hf('pyterrier/climate-fever.terrier')
-index.bm25()
+artifact = pt.Artifact.from_hf('pyterrier/climate-fever.terrier')
+# TODO: Show how you use the artifact
 ```
 
 ## Benchmarks
 
-| name   |   nDCG@10 |   R@1000 |
-|:-------|----------:|---------:|
-| bm25   |    0.1354 |   0.5844 |
-| dph    |    0.1693 |   0.6394 |
+*TODO: Provide benchmarks for the artifact.*
 
 ## Reproduction
 
 ```python
-import pyterrier as pt
-from tqdm import tqdm
-import pandas as pd
-import ir_datasets
-from pyterrier_pisa import PisaIndex
-dataset = ir_datasets.load('beir/climate-fever')
-meta_docno_len = dataset.metadata()['docs']['fields']['doc_id']['max_len']
-indexer = pt.IterDictIndexer("./climate-fever.terrier", meta={'docno': meta_docno_len, 'text': 4096})
-docs = ({'docno': d.doc_id, 'text': d.default_text()} for d in tqdm(dataset.docs))
-indexer.index(docs)
+# TODO: Show how you constructed the artifact.
 ```
 
 ## Metadata
 
 ```
 {
-  "package_hint": "pyterrier"
+  "type": "sparse_index",
+  "format": "terrier",
+  "package_hint": "python-terrier"
 }
 ```

artifact.tar.lz4

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:385efc69baa70fb3a5dac9812a5dc5f705de673212af5281a23a04bbd7ea5254
-size 3019757722
+oid sha256:cf8a8f9cea2c4204b43b99624082c4e878ae73226f07e287e12b3ec04792cc1d
+size 3019757765

artifact.tar.lz4.json

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ad623be13cedae20fb1c835c11c42a70fc630203e596d61a6b73eaa1dccb3626
+oid sha256:736c5d5fe6b2a222ec763e923e05a5ba729a254e1ff6907fa04c6b242ae9db8c
 size 904