Upload README.md with huggingface_hub

README.md

@@ -1,146 +1,38 @@
 ---
-dataset_info:
-- config_name: corpus_clean
-  features:
-  - name: corpusid
-    dtype: int64
-  - name: title
-    dtype: string
-  - name: abstract
-    dtype: string
-  - name: citations
-    sequence: int64
-  - name: full_paper
-    dtype: string
-  splits:
-  - name: full
-    num_bytes: 2571543214
-    num_examples: 64183
-  download_size: 1257084104
-  dataset_size: 2571543214
-- config_name: corpus_s2orc
-  features:
-  - name: corpusid
-    dtype: int64
-  - name: externalids
-    struct:
-    - name: acl
-      dtype: string
-    - name: arxiv
-      dtype: string
-    - name: dblp
-      dtype: string
-    - name: doi
-      dtype: string
-    - name: mag
-      dtype: string
-    - name: pubmed
-      dtype: string
-    - name: pubmedcentral
-      dtype: string
-  - name: content
-    struct:
-    - name: annotations
-      struct:
-      - name: abstract
-        dtype: string
-      - name: author
-        dtype: string
-      - name: authoraffiliation
-        dtype: string
-      - name: authorfirstname
-        dtype: string
-      - name: authorlastname
-        dtype: string
-      - name: bibauthor
-        dtype: string
-      - name: bibauthorfirstname
-        dtype: string
-      - name: bibauthorlastname
-        dtype: string
-      - name: bibentry
-        dtype: string
-      - name: bibref
-        dtype: string
-      - name: bibtitle
-        dtype: string
-      - name: bibvenue
-        dtype: string
-      - name: figure
-        dtype: string
-      - name: figurecaption
-        dtype: string
-      - name: figureref
-        dtype: string
-      - name: formula
-        dtype: string
-      - name: paragraph
-        dtype: string
-      - name: publisher
-        dtype: string
-      - name: sectionheader
-        dtype: string
-      - name: table
-        dtype: string
-      - name: tableref
-        dtype: string
-      - name: title
-        dtype: string
-      - name: venue
-        dtype: string
-    - name: source
-      struct:
-      - name: oainfo
-        struct:
-        - name: license
-          dtype: string
-        - name: openaccessurl
-          dtype: string
-        - name: status
-          dtype: string
-      - name: pdfsha
-        dtype: string
-      - name: pdfurls
-        sequence: string
-    - name: text
-      dtype: string
-  - name: year
-    dtype: float64
-  splits:
-  - name: full
-    num_bytes: 3596187474
-    num_examples: 64183
-  download_size: 1597565235
-  dataset_size: 3596187474
-- config_name: query
-  features:
-  - name: query_set
-    dtype: string
-  - name: query
-    dtype: string
-  - name: specificity
-    dtype: int64
-  - name: quality
-    dtype: int64
-  - name: corpusids
-    sequence: int64
-  splits:
-  - name: full
-    num_bytes: 112958
-    num_examples: 597
-  download_size: 50621
-  dataset_size: 112958
 configs:
-- config_name: corpus_clean
+- config_name: query
   data_files:
   - split: full
-    path: corpus_clean/full-*
-- config_name: corpus_s2orc
+    path: "query/*"
+- config_name: corpus_clean
   data_files:
   - split: full
-    path: corpus_s2orc/full-*
-- config_name: query
+    path: "corpus_clean/*"
+- config_name: corpus_s2orc
   data_files:
   - split: full
-    path: query/full-*
+    path: "corpus_s2orc/*"
 ---
+# LitSearch: A Retrieval Benchmark for Scientific Literature Search
+
+This dataset contains the query set and retrieval corpus for our paper **LitSearch: A Retrieval Benchmark for Scientific Literature Search**. We introduce LitSearch, a retrieval benchmark comprising 597 realistic literature search queries about recent ML and NLP papers. LitSearch is constructed using a combination of (1) questions generated by GPT-4 based on paragraphs containing inline citations from research papers and (2) questions about recently published papers, manually written by their authors. All LitSearch questions were manually examined or edited by experts to ensure high quality.
+
+This dataset contains three configurations:
+
+1. `query` containing 597 queries accomanied by gold paper IDs, specificity and quality annotations, and metadata about the source of the query.
+2. `corpus_clean` containing 64183 documents. We provide the extracted titles, abstracts and outgoing citation paper IDs.
+3. `corpus_s2orc` contains the same set of 64183 documents expressed in the Semantic Scholar Open Research Corpus (S2ORC) schema along with all available metadata.
+
+Each configuration has a single 'full' split.
+
+## Usage
+
+You can load the configurations as follows:
+
+```python
+from datasets import load_dataset
+
+query_data = load_dataset("princeton-nlp/LitSearch", "query", split="full")
+corpus_clean_data = load_dataset("princeton-nlp/LitSearch", "corpus_clean", split="full")
+corpus_s2orc_data = load_dataset("princeton-nlp/LitSearch", "corpus_s2orc", split="full")
+```