Update README.md

README.md

@@ -1,4 +1,14 @@
 ---
+language:
+- en
+multilinguality:
+- monolingual
+task_categories:
+- feature-extraction
+- sentence-similarity
+pretty_name: Trivia QA with Triplets
+tags:
+- sentence-transformers
 dataset_info:
 - config_name: triplet
   features:
@@ -38,3 +48,39 @@ configs:
   - split: train
     path: triplet-all/train-*
 ---
+
+# Dataset Card for Trivia QA with Triplets
+
+This is a reformatting of the Trivia QA dataset used to train the [BGE-M3 model](https://huggingface.co/BAAI/bge-m3). See the full BGE-M3 dataset in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data).
+
+## Dataset Subsets
+
+### `triplet` subset
+
+* Columns: "anchor", "positive", "negative"
+* Column types: `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      'anchor': 'Which American-born Sinclair won the Nobel Prize for Literature in 1930?',
+      'positive': 'Sinclair Lewis Sinclair Lewis Harry Sinclair Lewis (February 7, 1885 – January 10, 1951) was an American novelist, short-story writer, and playwright. In 1930, he became the first writer from the United States to receive the Nobel Prize in Literature, which was awarded "for his vigorous and graphic art of description and his ability to create, with wit and humor, new types of characters." His works are known for their insightful and critical views of American capitalism and materialism between the wars. He is also respected for his strong characterizations of modern working women. H. L. Mencken wrote of him, "[If] there',
+      'negative': 'Nobel Prize in Literature analyze its importance on potential future Nobel Prize in Literature laureates. Only Alice Munro (2009) has been awarded with both. The Neustadt International Prize for Literature is regarded as one of the most prestigious international literary prizes, often referred to as the American equivalent to the Nobel Prize. Like the Nobel or the Man Booker International Prize, it is awarded not for any one work, but for an entire body of work. It is frequently seen as an indicator of who may be awarded the Nobel Prize in Literature. Gabriel García Márquez (1972 Neustadt, 1982 Nobel), Czesław Miłosz (1978 Neustadt,'
+    }
+    ```
+* Collection strategy: Reading the Trivia QA jsonl file in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) and taking only the first positive and first negative.
+* Deduplified: No
+
+### `triplet-all` subset
+
+* Columns: "anchor", "positive", "negative"
+* Column types: `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      'anchor': 'Which American-born Sinclair won the Nobel Prize for Literature in 1930?',
+      'positive': 'Sinclair Lewis Sinclair Lewis Harry Sinclair Lewis (February 7, 1885 – January 10, 1951) was an American novelist, short-story writer, and playwright. In 1930, he became the first writer from the United States to receive the Nobel Prize in Literature, which was awarded "for his vigorous and graphic art of description and his ability to create, with wit and humor, new types of characters." His works are known for their insightful and critical views of American capitalism and materialism between the wars. He is also respected for his strong characterizations of modern working women. H. L. Mencken wrote of him, "[If] there',
+      'negative': 'Nobel Prize in Literature analyze its importance on potential future Nobel Prize in Literature laureates. Only Alice Munro (2009) has been awarded with both. The Neustadt International Prize for Literature is regarded as one of the most prestigious international literary prizes, often referred to as the American equivalent to the Nobel Prize. Like the Nobel or the Man Booker International Prize, it is awarded not for any one work, but for an entire body of work. It is frequently seen as an indicator of who may be awarded the Nobel Prize in Literature. Gabriel García Márquez (1972 Neustadt, 1982 Nobel), Czesław Miłosz (1978 Neustadt,'
+    }
+    ```
+* Collection strategy: Reading the Trivia QA jsonl file in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) and taking each negative, but making a separate sample with each of the negatives.
+* Deduplified: No